openstudio::model::BuildingUnit Class Reference

#include <BuildingUnit.hpp>

Inheritance diagram for openstudio::model::BuildingUnit:

Public Member Functions
Constructors and Destructors
	BuildingUnit (const Model &model)
virtual	~BuildingUnit ()=default
	BuildingUnit (const BuildingUnit &other)=default
	BuildingUnit (BuildingUnit &&other)=default
BuildingUnit &	operator= (const BuildingUnit &)=default
BuildingUnit &	operator= (BuildingUnit &&)=default
Getters
boost::optional< RenderingColor >	renderingColor () const
std::string	buildingUnitType () const
std::vector< Space >	spaces () const
std::vector< std::string >	featureNames () const
boost::optional< std::string >	getFeatureDataType (const std::string &name) const
boost::optional< std::string >	getFeatureAsString (const std::string &name) const
boost::optional< double >	getFeatureAsDouble (const std::string &name) const
boost::optional< int >	getFeatureAsInteger (const std::string &name) const
boost::optional< bool >	getFeatureAsBoolean (const std::string &name) const
std::vector< std::string >	suggestedFeatures () const
double	floorArea () const
Setters
bool	setRenderingColor (const RenderingColor &renderingColor)
void	resetRenderingColor ()
bool	setBuildingUnitType (const std::string &buildingUnitType)
void	resetBuildingUnitType ()
bool	setFeature (const std::string &name, const std::string &value)
bool	setFeature (const std::string &name, const char *value)
bool	setFeature (const std::string &name, double value)
bool	setFeature (const std::string &name, int value)
bool	setFeature (const std::string &name, bool value)
bool	resetFeature (const std::string &name)
Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject ()=default
	ModelObject (const ModelObject &other)=default
	ModelObject (ModelObject &&other)=default
ModelObject &	operator= (const ModelObject &)=default
ModelObject &	operator= (ModelObject &&)=default
ModelObject	clone () const
	Creates a deep copy of this object, placing it in this object's model(). More...
ModelObject	clone (Model model) const
	Creates a deep copy of this object, placing it in model. More...
Component	createComponent () const
	Method for creating sharable Model snippets. More...
Model	model () const
	Returns the Model that contains this object. More...
boost::optional< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one. More...
std::vector< ResourceObject >	resources () const
	Get the resources directly used by this ModelObject. More...
template<typename T >
std::vector< T >	getModelObjectSources () const
	Get all objects of type T that point to this object. More...
template<typename T >
std::vector< T >	getModelObjectSources (IddObjectType iddObjectType) const
	Get all objects of type T that point to this object. More...
template<typename T >
boost::optional< T >	getModelObjectTarget (unsigned index) const
	Get the object of type T pointed to by this object from field index. More...
template<typename T >
std::vector< T >	getModelObjectTargets () const
	Get all objects of type T to which this object points. More...
const std::vector< std::string > &	outputVariableNames () const
	Get all output variables names that could be associated with this object. More...
std::vector< OutputVariable >	outputVariables () const
	Get all output variables associated with this object, must run simulation to generate data. More...
boost::optional < openstudio::TimeSeries >	getData (const OutputVariable &variable, const std::string &envPeriod) const
	Get data associated with this output variable and this object. More...
std::vector< LifeCycleCost >	lifeCycleCosts () const
	Returns the list of all LifeCycleCosts that refer to this object. More...
std::vector< IdfObject >	removeLifeCycleCosts ()
	Removes all LifeCycleCosts that refer to this object. More...
IddObjectType	iddObjectType () const
	This is a virtual function that will tell you the type of iddObject you are dealing with. More...
AdditionalProperties	additionalProperties () const
	Returns this object's additional properties, constructing a new object if necessary. More...
bool	hasAdditionalProperties () const
	Returns true if this object has additional properties. More...
std::vector< IdfObject >	removeAdditionalProperties ()
	Removes all additional properties that refer to this object. More...
boost::optional< std::string >	cadObjectId () const
bool	setCADObjectId (const std::string &cadObjectId)
boost::optional< std::string >	gbXMLId () const
bool	setGBXMLId (const std::string &gbXMLId)
boost::optional< std::string >	displayName () const
bool	setDisplayName (const std::string &displayName)
bool	setParent (ParentObject &newParent)
	set the parent, child may have to call non-const methods on the parent More...
bool	operator< (const ModelObject &right) const
bool	operator== (const ModelObject &other) const
	equality test More...
bool	operator!= (const ModelObject &other) const
	inequality test More...
std::vector< ScheduleTypeKey >	getScheduleTypeKeys (const Schedule &schedule) const
	Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
boost::optional< double >	getAutosizedValue (const std::string &valueName, const std::string &units) const
	Gets the autosized component value from the sql file. More...
virtual std::vector < EMSActuatorNames >	emsActuatorNames () const
	Return the names of the available ems actuators. More...
virtual std::vector< std::string >	emsInternalVariableNames () const
	Return the names of the available ems internal variables. More...
boost::optional< ModelObject >	connectedObject (unsigned port) const
boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Static Public Member Functions
static IddObjectType	iddObjectType ()
Static Methods
static std::vector< std::string >	buildingUnitTypeValues ()

Additional Inherited Members
Protected Types inherited from openstudio::model::ModelObject
using	ImplType = detail::ModelObject_Impl
Protected Member Functions inherited from openstudio::model::ModelObject
	ModelObject (IddObjectType type, const Model &model, bool fastName=false)
	ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl)
Related Functions inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More...

Constructor & Destructor Documentation

openstudio::model::BuildingUnit::BuildingUnit ( const Model &  model )

explicit

virtual openstudio::model::BuildingUnit::~BuildingUnit ( )

virtualdefault

openstudio::model::BuildingUnit::BuildingUnit ( const BuildingUnit &  other )

default

openstudio::model::BuildingUnit::BuildingUnit ( BuildingUnit &&  other )

default

Member Function Documentation

std::string openstudio::model::BuildingUnit::buildingUnitType

(

)

const

static std::vector<std::string> openstudio::model::BuildingUnit::buildingUnitTypeValues ( )

static

std::vector<std::string> openstudio::model::BuildingUnit::featureNames

(

)

const

Deprecated:

{ This method is deprecated, use additionalProperties instead }

double openstudio::model::BuildingUnit::floorArea

(

)

const

boost::optional<bool> openstudio::model::BuildingUnit::getFeatureAsBoolean

(

const std::string &

name

)

const

Deprecated:

{ This method is deprecated, use additionalProperties instead }

boost::optional<double> openstudio::model::BuildingUnit::getFeatureAsDouble

(

const std::string &

name

)

const

Deprecated:

{ This method is deprecated, use additionalProperties instead }

boost::optional<int> openstudio::model::BuildingUnit::getFeatureAsInteger

(

const std::string &

name

)

const

Deprecated:

{ This method is deprecated, use additionalProperties instead }

boost::optional<std::string> openstudio::model::BuildingUnit::getFeatureAsString

(

const std::string &

name

)

const

Deprecated:

{ This method is deprecated, use additionalProperties instead }

boost::optional<std::string> openstudio::model::BuildingUnit::getFeatureDataType

(

const std::string &

name

)

const

Deprecated:

{ This method is deprecated, use additionalProperties instead }

static IddObjectType openstudio::model::BuildingUnit::iddObjectType ( )

static

BuildingUnit& openstudio::model::BuildingUnit::operator= ( const BuildingUnit &  )

default

BuildingUnit& openstudio::model::BuildingUnit::operator= ( BuildingUnit &&  )

default

boost::optional<RenderingColor> openstudio::model::BuildingUnit::renderingColor

(

)

const

void openstudio::model::BuildingUnit::resetBuildingUnitType

(

)

bool openstudio::model::BuildingUnit::resetFeature

(

const std::string &

name

)

Deprecated:

{ This method is deprecated, use additionalProperties instead }

void openstudio::model::BuildingUnit::resetRenderingColor

(

)

bool openstudio::model::BuildingUnit::setBuildingUnitType

(

const std::string &

buildingUnitType

)

bool openstudio::model::BuildingUnit::setFeature	(	const std::string &	name,
		const std::string &	value
	)

Deprecated:

{ This method is deprecated, use additionalProperties instead }

bool openstudio::model::BuildingUnit::setFeature	(	const std::string &	name,
		const char *	value
	)

Deprecated:

{ This method is deprecated, use additionalProperties instead }

bool openstudio::model::BuildingUnit::setFeature	(	const std::string &	name,
		double	value
	)

Deprecated:

{ This method is deprecated, use additionalProperties instead }

bool openstudio::model::BuildingUnit::setFeature	(	const std::string &	name,
		int	value
	)

Deprecated:

{ This method is deprecated, use additionalProperties instead }

bool openstudio::model::BuildingUnit::setFeature	(	const std::string &	name,
		bool	value
	)

Deprecated:

{ This method is deprecated, use additionalProperties instead }

bool openstudio::model::BuildingUnit::setRenderingColor

(

const RenderingColor &

renderingColor

)

std::vector<Space> openstudio::model::BuildingUnit::spaces

(

)

const

std::vector<std::string> openstudio::model::BuildingUnit::suggestedFeatures

(

)

const

Deprecated:

{ This method is deprecated, use additionalProperties instead }