ModelObject Class Reference

#include "ModelObject.hpp"

Inheritance diagram for openstudio::model::ModelObject:

Public Member Functions
virtual	~ModelObject ()=default
	ModelObject (const ModelObject &other)=default
	ModelObject (ModelObject &&other)=default
ModelObject &	operator= (const ModelObject &)=default
ModelObject &	operator= (ModelObject &&)=default
ModelObject	clone () const
ModelObject	clone (Model model) const
Component	createComponent () const
Model	model () const
boost::optional< ParentObject >	parent () const
std::vector< ResourceObject >	resources () const
template<typename T >
std::vector< T >	getModelObjectSources () const
template<typename T >
std::vector< T >	getModelObjectSources (IddObjectType iddObjectType) const
template<typename T >
boost::optional< T >	getModelObjectTarget (unsigned index) const
template<typename T >
std::vector< T >	getModelObjectTargets () const
const std::vector< std::string > &	outputVariableNames () const
std::vector< OutputVariable >	outputVariables () const
boost::optional < openstudio::TimeSeries >	getData (const OutputVariable &variable, const std::string &envPeriod) const
std::vector< LifeCycleCost >	lifeCycleCosts () const
std::vector< IdfObject >	removeLifeCycleCosts ()
IddObjectType	iddObjectType () const
AdditionalProperties	additionalProperties () const
bool	hasAdditionalProperties () const
std::vector< IdfObject >	removeAdditionalProperties ()
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)
bool	operator< (const ModelObject &right) const
bool	operator== (const ModelObject &other) const
bool	operator!= (const ModelObject &other) const
std::vector< ScheduleTypeKey >	getScheduleTypeKeys (const Schedule &schedule) const
boost::optional< double >	getAutosizedValue (const std::string &valueName, const std::string &units) const
virtual std::vector < EMSActuatorNames >	emsActuatorNames () const
virtual std::vector< std::string >	emsInternalVariableNames () const
boost::optional< ModelObject >	connectedObject (unsigned port) const
boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Protected Types
using	ImplType = detail::ModelObject_Impl

Protected Member Functions
	ModelObject (IddObjectType type, const Model &model, bool fastName=false)
	ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl)

Related Functions
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)

Detailed Description

Base class for the OpenStudio Building Model hierarchy.

Derives from WorkspaceObject, just as Model derives from Workspace. Each concrete class in the hierarchy wraps a specific IddObject. (See the OpenStudio Utilities and Utilities Idd documentation for information on Workspace, WorkspaceObject, and IddObject.)

Member Typedef Documentation

using openstudio::model::ModelObject::ImplType = detail::ModelObject_Impl

protected

Constructor & Destructor Documentation

virtual openstudio::model::ModelObject::~ModelObject ( )

virtualdefault

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

default

openstudio::model::ModelObject::ModelObject ( ModelObject &&  other )

default

openstudio::model::ModelObject::ModelObject ( IddObjectType  type, const Model &  model, bool  fastName = false  )

explicitprotected

openstudio::model::ModelObject::ModelObject ( std::shared_ptr< detail::ModelObject_Impl >  impl )

explicitprotected

Member Function Documentation

AdditionalProperties openstudio::model::ModelObject::additionalProperties

(

)

const

Returns this object's additional properties, constructing a new object if necessary.

This method will throw if called on an AddditionalProperties object.

boost::optional<std::string> openstudio::model::ModelObject::cadObjectId

(

)

const

ModelObject openstudio::model::ModelObject::clone

(

)

const

Creates a deep copy of this object, placing it in this object's model().

Virtual implementation.

ModelObject openstudio::model::ModelObject::clone

(

Model

model

)

const

Creates a deep copy of this object, placing it in model.

Virtual implementation.

boost::optional<ModelObject> openstudio::model::ModelObject::connectedObject

(

unsigned

port

)

const

boost::optional<unsigned> openstudio::model::ModelObject::connectedObjectPort

(

unsigned

port

)

const

Component openstudio::model::ModelObject::createComponent

(

)

const

Method for creating sharable Model snippets.

Creates a Component with this ModelObject as the primary object. Uses the clone(Model&) method to select Component contents.

boost::optional<std::string> openstudio::model::ModelObject::displayName

(

)

const

virtual std::vector<EMSActuatorNames> openstudio::model::ModelObject::emsActuatorNames ( ) const

virtual

Return the names of the available ems actuators.

virtual std::vector<std::string> openstudio::model::ModelObject::emsInternalVariableNames ( ) const

virtual

Return the names of the available ems internal variables.

boost::optional<std::string> openstudio::model::ModelObject::gbXMLId

(

)

const

boost::optional<double> openstudio::model::ModelObject::getAutosizedValue	(	const std::string &	valueName,
		const std::string &	units
	)		const

Gets the autosized component value from the sql file.

boost::optional<openstudio::TimeSeries> openstudio::model::ModelObject::getData	(	const OutputVariable &	variable,
		const std::string &	envPeriod
	)		const

Get data associated with this output variable and this object.

template<typename T >

std::vector<T> openstudio::model::ModelObject::getModelObjectSources ( ) const

inline

Get all objects of type T that point to this object.

This method is preferred over the WorkspaceObject equivalent, as its use does not require knowledge of the IddObjectType.

template<typename T >

std::vector<T> openstudio::model::ModelObject::getModelObjectSources ( IddObjectType  iddObjectType ) const

inline

Get all objects of type T that point to this object.

Preferred usage (do not use with abstract classes):

PeopleVector myZonesPeople = zone.getModelObjectSources<People>(People::iddObjectType());

template<typename T >

boost::optional<T> openstudio::model::ModelObject::getModelObjectTarget ( unsigned  index ) const

inline

Get the object of type T pointed to by this object from field index.

template<typename T >

std::vector<T> openstudio::model::ModelObject::getModelObjectTargets ( ) const

inline

Get all objects of type T to which this object points.

This method is preferred over the WorkspaceObject equivalent, as its use does not require knowledge of the IddObjectType.

std::vector<ScheduleTypeKey> openstudio::model::ModelObject::getScheduleTypeKeys

(

const Schedule &

schedule

)

const

Return the ScheduleTypeKeys indicating how schedule is used in this object.

If schedule is not directly used by this object, return value will be .empty(). Used to maintain compatibility between schedule's ScheduleTypeLimits and how schedule is used by other objects.

bool openstudio::model::ModelObject::hasAdditionalProperties

(

)

const

Returns true if this object has additional properties.

IddObjectType openstudio::model::ModelObject::iddObjectType

(

)

const

This is a virtual function that will tell you the type of iddObject you are dealing with.

While not labeled virtual here, it IS virtual in the impl.

std::vector<LifeCycleCost> openstudio::model::ModelObject::lifeCycleCosts

(

)

const

Returns the list of all LifeCycleCosts that refer to this object.

Model openstudio::model::ModelObject::model

(

)

const

Returns the Model that contains this object.

bool openstudio::model::ModelObject::operator!=

(

const ModelObject &

other

)

const

inequality test

bool openstudio::model::ModelObject::operator<

(

const ModelObject &

right

)

const

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

default

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

default

bool openstudio::model::ModelObject::operator==

(

const ModelObject &

other

)

const

equality test

const std::vector<std::string>& openstudio::model::ModelObject::outputVariableNames

(

)

const

Get all output variables names that could be associated with this object.

These variables may or may not be available for each simulation, need to check report variable dictionary to see if the variable is available. Each concrete class should override this method.

std::vector<OutputVariable> openstudio::model::ModelObject::outputVariables

(

)

const

Get all output variables associated with this object, must run simulation to generate data.

boost::optional<ParentObject> openstudio::model::ModelObject::parent

(

)

const

Return this object's parent in the hierarchy, if it has one.

std::vector<IdfObject> openstudio::model::ModelObject::removeAdditionalProperties

(

)

Removes all additional properties that refer to this object.

Returns removed objects.

std::vector<IdfObject> openstudio::model::ModelObject::removeLifeCycleCosts

(

)

Removes all LifeCycleCosts that refer to this object.

Returns removed objects.

std::vector<ResourceObject> openstudio::model::ModelObject::resources

(

)

const

Get the resources directly used by this ModelObject.

bool openstudio::model::ModelObject::setCADObjectId

(

const std::string &

cadObjectId

)

bool openstudio::model::ModelObject::setDisplayName

(

const std::string &

displayName

)

bool openstudio::model::ModelObject::setGBXMLId

(

const std::string &

gbXMLId

)

bool openstudio::model::ModelObject::setParent

(

ParentObject &

newParent

)

set the parent, child may have to call non-const methods on the parent

Friends And Related Function Documentation

std::vector< ResourceObject > getRecursiveResources ( const ModelObject &  object )

related

Returns all ResourceObjects accessible by recursively calling .resources() starting from object.

Will not return object even if object is a ResourceObject.