openstudio::EnvironmentIdentifier Class Reference

#include <SqlFileTimeSeriesQuery.hpp>

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

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

EnvironmentIdentifier() [1/2]

openstudio::EnvironmentIdentifier::EnvironmentIdentifier

(

const openstudio::EnvironmentType &

type = EnvironmentType()

)

Construct from EnvironmentType enumeration.

EnvironmentIdentifier() [2/2]

openstudio::EnvironmentIdentifier::EnvironmentIdentifier

(

const std::string &

name

)

Construct from name.

Member Function Documentation

name()

boost::optional< std::string > openstudio::EnvironmentIdentifier::name

(

)

const

Return the environment period name, if it is specified.

type()

boost::optional< openstudio::EnvironmentType > openstudio::EnvironmentIdentifier::type

(

)

const

Return the EnvironmentType, if it is specified.