OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::model::ComponentData Class Reference

#include <ComponentData.hpp>

+ Inheritance diagram for openstudio::model::ComponentData:

Public Member Functions

Constructors and Destructors
virtual ~ComponentData ()
 
Getters
UUID uuid () const
 The unique identifier of the component. More...
 
UUID versionUUID () const
 Returns the unique identifier of the current version of the component. More...
 
boost::optional< int > creationTimestamp () const
 Timestamp at time of creation (when the uuid was initially generated). More...
 
boost::optional< int > versionTimestamp () const
 Timestamp of last versioning event (creation of versionUUID). More...
 
ModelObject primaryComponentObject () const
 Returns the primary object of this component, which defines the Component's overall type. More...
 
std::vector< ModelObjectcomponentObjects () const
 Returns all of the ModelObjects that are part of this Component. More...
 
ModelObject getComponentObject (unsigned objectIndex) const
 Returns the ModelObject at objectIndex in the contents. More...
 
Setters
UUID createVersionUUID ()
 Creates and returns a new value for versionUUID(). More...
 
Queries
unsigned numComponentObjects () const
 Returns the number of objects in the Component described by this object. More...
 
- Public Member Functions inherited from openstudio::model::ResourceObject
unsigned directUseCount (bool excludeChildren=false) const
 Returns the number of objects that use this resource directly. More...
 
unsigned nonResourceObjectUseCount (bool excludeChildren=false) const
 Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...
 
virtual ~ResourceObject ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
virtual ~ParentObject ()
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()
 
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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () 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< LifeCycleCostlifeCycleCosts () 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< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
 
boost::optional< double > getAutosizedValue (std::string valueName, std::string unitString) 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< ModelObjectconnectedObject (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.)

typedef std::vector
< ComponentData
ComponentDataVector
 
typedef boost::optional
< ComponentData
OptionalComponentData
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- Protected Member Functions inherited from openstudio::model::ResourceObject
 ResourceObject (IddObjectType type, const Model &model)
 Constructs a new PlanarSurface object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject object in the model. More...
 
- 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)
 

Detailed Description

ComponentData is a ModelObject that wraps the OpenStudio IDD object 'OS:ComponentData'.

It is used in Components to provide a contents list and data (unique identifiers and timestamps) that link the Component back to the Building Component Library (BCL). It is used in Models to indicate which objects are associated with which Components.

Constructor & Destructor Documentation

virtual openstudio::model::ComponentData::~ComponentData ( )
inlinevirtual

Member Function Documentation

std::vector<ModelObject> openstudio::model::ComponentData::componentObjects ( ) const

Returns all of the ModelObjects that are part of this Component.

The primaryComponentObject() will be listed first.

UUID openstudio::model::ComponentData::createVersionUUID ( )

Creates and returns a new value for versionUUID().

boost::optional<int> openstudio::model::ComponentData::creationTimestamp ( ) const

Timestamp at time of creation (when the uuid was initially generated).

Unix timestamp from January 1, 1970 00:00 GMT, in seconds.

ModelObject openstudio::model::ComponentData::getComponentObject ( unsigned  objectIndex) const

Returns the ModelObject at objectIndex in the contents.

Throws an openstudio::Exception if objectIndex >= numComponentObjects.

static IddObjectType openstudio::model::ComponentData::iddObjectType ( )
static
unsigned openstudio::model::ComponentData::numComponentObjects ( ) const

Returns the number of objects in the Component described by this object.

Must be >= 1.

ModelObject openstudio::model::ComponentData::primaryComponentObject ( ) const

Returns the primary object of this component, which defines the Component's overall type.

This method is equivalent to getComponentObject(0).

UUID openstudio::model::ComponentData::uuid ( ) const

The unique identifier of the component.

This identifier is generated on initial construction with ModelObject::createComponent, and then maintained as-is for the life of the Component. It is used to track the Component across multiple models, on disk (.osc and .osm), in the project::ProjectDatabase, and in local and online BCLs.

boost::optional<int> openstudio::model::ComponentData::versionTimestamp ( ) const

Timestamp of last versioning event (creation of versionUUID).

Unix timestamp from January 1, 1970 00:00 GMT, in seconds.

UUID openstudio::model::ComponentData::versionUUID ( ) const

Returns the unique identifier of the current version of the component.

This UUID is automatically regenerated when any Component data changes.

Friends And Related Function Documentation

typedef std::vector<ComponentData> ComponentDataVector
related
typedef boost::optional<ComponentData> OptionalComponentData
related