All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
openstudio::EnvironmentIdentifier Class Reference

#include <SqlFileTimeSeriesQuery.hpp>

Public Member Functions

 EnvironmentIdentifier (const openstudio::EnvironmentType &type=EnvironmentType())
 Construct from EnvironmentType enumeration. More...
 EnvironmentIdentifier (const std::string &name)
 Construct from name. More...
boost::optional< std::string > name () const
 Return the environment period name, if it is specified. More...
< openstudio::EnvironmentType
type () const
 Return the EnvironmentType, if it is specified. More...

Detailed Description

Small class to let users identify a SqlFile environment period either by type or by name.

If type is specified, there is a chance the environment name will not be unique.

Constructor & Destructor Documentation

openstudio::EnvironmentIdentifier::EnvironmentIdentifier ( const openstudio::EnvironmentType type = EnvironmentType())

Construct from EnvironmentType enumeration.

openstudio::EnvironmentIdentifier::EnvironmentIdentifier ( const std::string &  name)

Construct from name.

Member Function Documentation

boost::optional<std::string> openstudio::EnvironmentIdentifier::name ( ) const

Return the environment period name, if it is specified.

boost::optional<openstudio::EnvironmentType> openstudio::EnvironmentIdentifier::type ( ) const

Return the EnvironmentType, if it is specified.