#include <AdditionalProperties.hpp>

Inheritance diagram for openstudio::model::AdditionalProperties:

Public Member Functions
void	merge (const AdditionalProperties &other, bool overwrite=false)
	Merge another AdditionalProperties object with this one If overwrite is true, the keys from other object overwrite keys from this. More...

Constructors and Destructors
virtual	~AdditionalProperties ()=default

	AdditionalProperties (const AdditionalProperties &other)=default

	AdditionalProperties (AdditionalProperties &&other)=default

AdditionalProperties &	operator= (const AdditionalProperties &)=default

AdditionalProperties &	operator= (AdditionalProperties &&)=default

Getters
ModelObject	modelObject () const
	Returns the ModelObject this AdditionalProperties object refers to. More...

std::vector< std::string >	featureNames () const
	Returns the set of feature name strings. More...

bool	hasFeature (const std::string &name) const
	Returns true if a feature exists. More...

boost::optional< std::string >	getFeatureDataType (const std::string &name) const
	Returns optional feature data type as String, Double, Boolean, or Integer. More...

boost::optional< std::string >	getFeatureAsString (const std::string &name) const
	Returns optional feature value as String. More...

boost::optional< double >	getFeatureAsDouble (const std::string &name) const
	Returns optional feature value as Double. More...

boost::optional< int >	getFeatureAsInteger (const std::string &name) const
	Returns optional feature value as Integer. More...

boost::optional< bool >	getFeatureAsBoolean (const std::string &name) const
	Returns optional feature value as Boolean. More...

std::vector< std::string >	suggestedFeatureNames () const
	Returns set of AdditionalProperties feature names already in the model. More...

Setters
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 ()

Related Functions
(Note that these are not member functions.)
using	AdditionalPropertiesVector = std::vector< AdditionalProperties >

using	OptionalAdditionalProperties = boost::optional< AdditionalProperties >

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...

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)

Constructor & Destructor Documentation

virtual openstudio::model::AdditionalProperties::~AdditionalProperties ( )

virtualdefault

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

default

openstudio::model::AdditionalProperties::AdditionalProperties ( AdditionalProperties && other )

default

Member Function Documentation

std::vector<std::string> openstudio::model::AdditionalProperties::featureNames ( ) const

Returns the set of feature name strings.

boost::optional<bool> openstudio::model::AdditionalProperties::getFeatureAsBoolean ( const std::string & name ) const

Returns optional feature value as Boolean.

boost::optional<double> openstudio::model::AdditionalProperties::getFeatureAsDouble ( const std::string & name ) const

Returns optional feature value as Double.

boost::optional<int> openstudio::model::AdditionalProperties::getFeatureAsInteger ( const std::string & name ) const

Returns optional feature value as Integer.

boost::optional<std::string> openstudio::model::AdditionalProperties::getFeatureAsString ( const std::string & name ) const

Returns optional feature value as String.

boost::optional<std::string> openstudio::model::AdditionalProperties::getFeatureDataType ( const std::string & name ) const

Returns optional feature data type as String, Double, Boolean, or Integer.

bool openstudio::model::AdditionalProperties::hasFeature ( const std::string & name ) const

Returns true if a feature exists.

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

static

void openstudio::model::AdditionalProperties::merge	(	const AdditionalProperties &	other,
		bool	overwrite = `false`
	)

Merge another AdditionalProperties object with this one If overwrite is true, the keys from other object overwrite keys from this.

ModelObject openstudio::model::AdditionalProperties::modelObject ( ) const

Returns the ModelObject this AdditionalProperties object refers to.

This method will throw if the ModelObject cannot be found.

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

default

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

default

bool openstudio::model::AdditionalProperties::resetFeature ( const std::string & name )

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

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

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

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

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

std::vector<std::string> openstudio::model::AdditionalProperties::suggestedFeatureNames ( ) const

Returns set of AdditionalProperties feature names already in the model.

Friends And Related Function Documentation

using AdditionalPropertiesVector = std::vector<AdditionalProperties>

Public Member Functions

Static Public Member Functions

Related Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation