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

#include <Node.hpp>

+ Inheritance diagram for openstudio::model::Node:

Public Member Functions

OS_DEPRECATED void addSetpointManager (SetpointManagerSingleZoneReheat &setPointManager)
 
OS_DEPRECATED void addSetpointManager (SetpointManagerMixedAir &setPointManager)
 
OS_DEPRECATED void addSetpointManager (SetpointManagerScheduled &setPointManager)
 
OS_DEPRECATED void addSetpointManager (SetpointManagerFollowOutdoorAirTemperature &setPointManager)
 
OS_DEPRECATED void addSetpointManager (SetpointManagerOutdoorAirReset &setPointManager)
 
OS_DEPRECATED void addSetpointManagerWarmest (SetpointManagerWarmest &setPointManager)
 
bool addToNode (Node &node)
 
ModelObject clone (Model model) const
 
OS_DEPRECATED boost::optional
< SetpointManagerMixedAir
getSetpointManagerMixedAir ()
 
OS_DEPRECATED boost::optional
< SetpointManagerSingleZoneReheat
getSetpointManagerSingleZoneReheat ()
 
bool isRemovable () const
 
 Node (const Model &model)
 Constructs a new Node object and places it inside the model. More...
 
std::vector< IdfObjectremove ()
 
OS_DEPRECATED void removeSetpointManagerFollowOutdoorAirTemperature ()
 
OS_DEPRECATED void removeSetpointManagerMixedAir ()
 
OS_DEPRECATED void removeSetpointManagerOutdoorAirReset ()
 
OS_DEPRECATED void removeSetpointManagerScheduled ()
 
OS_DEPRECATED void removeSetpointManagerSingleZoneReheat ()
 
OS_DEPRECATED void removeSetpointManagerWarmest ()
 
OS_DEPRECATED boost::optional
< SetpointManagerFollowOutdoorAirTemperature
setpointManagerFollowOutdoorAirTemperature () const
 
OS_DEPRECATED boost::optional
< SetpointManagerOutdoorAirReset
setpointManagerOutdoorAirReset () const
 
std::vector< SetpointManagersetpointManagers () const
 
OS_DEPRECATED boost::optional
< SetpointManagerScheduled
setpointManagerScheduled () const
 
OS_DEPRECATED boost::optional
< SetpointManagerWarmest
setpointManagerWarmest () const
 
virtual ~Node ()
 
- Public Member Functions inherited from openstudio::model::StraightComponent
bool addToNode (Node &node)
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More...
 
ModelObject clone (Model model) const
 
void disconnect ()
 
boost::optional< ModelObjectinletModelObject ()
 Returns the optional ModelObject connected to the inlet port. More...
 
unsigned inletPort ()
 Returns the inlet port. More...
 
boost::optional< ModelObjectoutletModelObject ()
 Returns the optional ModelObject connected to the outlet port. More...
 
unsigned outletPort ()
 Returns the outlet port. More...
 
std::vector
< openstudio::IdfObject
remove ()
 
 StraightComponent (IddObjectType type, const Model &model)
 
virtual ~StraightComponent ()
 
- Public Member Functions inherited from openstudio::model::HVACComponent
bool addToNode (Node &node)
 Adds this object to a new system node and returns a boolean indicating if the addition was successful. More...
 
bool addToSplitter (Splitter &splitter)
 Adds this object to a splitter by creating a new branch. More...
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that the HVAC component is attached to. More...
 
boost::optional
< AirLoopHVACOutdoorAirSystem
airLoopHVACOutdoorAirSystem () const
 Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to. More...
 
boost::optional< HVACComponentcontainingHVACComponent () const
 EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components. More...
 
boost::optional
< StraightComponent
containingStraightComponent () const
 
boost::optional
< ZoneHVACComponent
containingZoneHVACComponent () const
 Returns any ZoneHVACComponent that contains this HVACComponent. More...
 
void disconnect ()
 Removes all connections to other HVACComponent objects. More...
 
bool isRemovable () const
 Indicates if the HVACComponent can be removed from the model. More...
 
boost::optional< Looploop () const
 Returns the optional Loop object that the HVAC component is attached to. More...
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is attached to. More...
 
std::vector< IdfObjectremove ()
 Removes the HVACComponent from the model only if isRemovable() return true. More...
 
virtual ~HVACComponent ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectTypeallowableChildTypes () 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...
 
std::vector< std::string > relationshipNames () const
 Return all valid relationship names. More...
 
std::vector< Relationshiprelationships () const
 Return all relationships for this ModelObject. More...
 
boost::optional< RelationshipgetRelationship (const std::string &name) const
 Get the relationship named name, if it exists. More...
 
bool setRelationship (const std::string &name, boost::optional< ModelObject > relatedModelObject)
 Set this ModelObject's relationship name to point to relatedModelObject (or clear the relationship if relatedModelObject == boost::none). More...
 
bool setRelationship (const std::string &name, const Component &component)
 Inserts component into this model and sets this ModelObject's relationship name to point to component.primaryObject(). More...
 
std::vector< std::string > attributeNames () const
 Return all valid attribute names. More...
 
std::vector
< openstudio::Attribute
attributes () const
 Return all Attributes for this ModelObject. More...
 
boost::optional
< openstudio::Attribute
getAttribute (const std::string &name) const
 Get the attribute named name, if it exists. More...
 
bool isSettableAttribute (const std::string &name) const
 Is the named attribute settable. More...
 
bool isOptionalAttribute (const std::string &name) const
 Is the named attribute optional. More...
 
bool setAttribute (const std::string &name, bool value)
 Set the attribute named name, if it exists. More...
 
bool setAttribute (const std::string &name, int value)
 
bool setAttribute (const std::string &name, unsigned value)
 
bool setAttribute (const std::string &name, double value)
 
bool setAttribute (const std::string &name, const Quantity &value)
 
bool setAttribute (const std::string &name, const std::string &value)
 
bool setAttribute (const std::string &name, const char *value)
 
bool resetAttribute (const std::string &name)
 Reset the attribute named name. 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< IdfObjectremoveLifeCycleCosts ()
 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...
 
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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool isSource () const
 
bool isTarget () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
virtual ~WorkspaceObject ()
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector
< std::string > > 
clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< intgetInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
boost::optional< QUrl > getURL (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
std::ostream & print (std::ostream &os) const
 
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
 
std::ostream & printName (std::ostream &os, bool hasFields=true) const
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
IdfExtensibleGroup pushExtensibleGroup ()
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=true) const
 
virtual ~IdfObject ()
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector< NodeNodeVector
 
typedef boost::optional< NodeOptionalNode
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
OptionalWorkspaceObject
 
typedef std::vector
< WorkspaceObject
WorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
IdfObject
IdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- Protected Types inherited from openstudio::model::HVACComponent
typedef detail::HVACComponent_Impl ImplType
 
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- Protected Types inherited from openstudio::WorkspaceObject
typedef
detail::WorkspaceObject_Impl 
ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
 
- Protected Member Functions inherited from openstudio::model::HVACComponent
virtual std::vector< ModelObjectchildren () const
 
 HVACComponent (IddObjectType type, const Model &model)
 Returns the optional ModelObject connected to this object's port. More...
 
 HVACComponent (std::shared_ptr< ImplType > impl)
 
- 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)
 
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)
 

Detailed Description

Node is a ModelObject that defines a point in an EnergyPlus HVAC topology where fluid conditions are known and control devices can be applied.

EnergyPlus IDD does not define a Node object, however the concept of a node is central to modeling HVAC systems in EnergyPlus.

Constructor & Destructor Documentation

openstudio::model::Node::Node ( const Model model)
explicit

Constructs a new Node object and places it inside the model.

The object is fully initialized with all companion objects.

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

Member Function Documentation

OS_DEPRECATED void openstudio::model::Node::addSetpointManager ( SetpointManagerSingleZoneReheat setPointManager)
Deprecated:
Node::addSetpointManager has been deprecated and will be removed in a future release, please use SetpointManagerSingleZoneReheat::addToNode
Adds setPointManager of type SetpointManagerSingleZoneReheat to this Node.
OS_DEPRECATED void openstudio::model::Node::addSetpointManager ( SetpointManagerMixedAir setPointManager)
Deprecated:
Node::addSetpointManager has been deprecated and will be removed in a future release, please use SetpointManagerMixedAir::addToNode
Adds setPointManager of type SetpointManagerMixedAir to this Node.
OS_DEPRECATED void openstudio::model::Node::addSetpointManager ( SetpointManagerScheduled setPointManager)
Deprecated:
Node::addSetpointManager has been deprecated and will be removed in a future release, please use SetpointManagerScheduled::addToNode
Adds setPointManager of type SetpointManagerScheduled to this Node.
OS_DEPRECATED void openstudio::model::Node::addSetpointManager ( SetpointManagerFollowOutdoorAirTemperature setPointManager)
Deprecated:
Node::addSetpointManager has been deprecated and will be removed in a future release, please use SetpointManagerFollowOutdoorAirTemperature::addToNode
Adds setPointManager of type SetpointManagerFollowOutdoorAirTemperature to this Node.
OS_DEPRECATED void openstudio::model::Node::addSetpointManager ( SetpointManagerOutdoorAirReset setPointManager)
Deprecated:
Node::addSetpointManager has been deprecated and will be removed in a future release, please use SetpointManagerOutdoorAirReset::addToNode
Adds setPointManager of type SetpointManagerOutdoorAirReset to this Node.
OS_DEPRECATED void openstudio::model::Node::addSetpointManagerWarmest ( SetpointManagerWarmest setPointManager)
Deprecated:
Node::addSetpointManagerWarmest has been deprecated and will be removed in a future release, please use SetpointManagerWarmest::addToNode
Adds setPointManager of type SetpointManagerWarmest to this Node.
bool openstudio::model::Node::addToNode ( Node node)
ModelObject openstudio::model::Node::clone ( Model  model) const
OS_DEPRECATED boost::optional<SetpointManagerMixedAir> openstudio::model::Node::getSetpointManagerMixedAir ( )
Deprecated:
Node::getSetpointManagerMixedAir has been deprecated and will be removed in a future release, please use Node::setpointManagers
Returns the optional SetpointManagerMixedAir associated with this Node.
OS_DEPRECATED boost::optional<SetpointManagerSingleZoneReheat> openstudio::model::Node::getSetpointManagerSingleZoneReheat ( )
Deprecated:
Node::getSetpointManagerSingleZoneReheat has been deprecated and will be removed in a future release, please use Node::setpointManagers
Returns the optional SetpointManagerSingleZoneReheat associated with this Node.
static IddObjectType openstudio::model::Node::iddObjectType ( )
static
bool openstudio::model::Node::isRemovable ( ) const
std::vector<IdfObject> openstudio::model::Node::remove ( )
OS_DEPRECATED void openstudio::model::Node::removeSetpointManagerFollowOutdoorAirTemperature ( )
Deprecated:
Node::removeSetpointManagerFollowOutdoorAirTemperature has been deprecated and will be removed in a future release, please use SetpointManagerFollowOutdoorAirTemperature::remove
Removes any SetpointManagerFollowOutdoorAirTemperature objects from this Node.
OS_DEPRECATED void openstudio::model::Node::removeSetpointManagerMixedAir ( )
Deprecated:
Node::removeSetpointManagerMixedAir has been deprecated and will be removed in a future release, please use SetpointManagerMixedAir::remove
Removes any SetpointManagerMixedAir objects from this Node.
OS_DEPRECATED void openstudio::model::Node::removeSetpointManagerOutdoorAirReset ( )
Deprecated:
Node::removeSetpointManagerOutdoorAirReset has been deprecated and will be removed in a future release, please use SetpointManagerOutdoorAirReset::remove
Removes any SetpointManagerOutdoorAirReset objects from this Node.
OS_DEPRECATED void openstudio::model::Node::removeSetpointManagerScheduled ( )
Deprecated:
Node::removeSetpointManagerScheduled has been deprecated and will be removed in a future release, please use SetpointManagerScheduled::remove
Removes any SetpointManagerScheduled objects from this Node.
OS_DEPRECATED void openstudio::model::Node::removeSetpointManagerSingleZoneReheat ( )
Deprecated:
Node::removeSetpointManagerSingleZoneReheat has been deprecated and will be removed in a future release, please use SetpointManagerSingleZoneReheat::remove
Removes any SetpointManagerSingleZoneReheat objects from this Node.
OS_DEPRECATED void openstudio::model::Node::removeSetpointManagerWarmest ( )
Deprecated:
Node::removeSetpointManagerWarmest has been deprecated and will be removed in a future release, please use SetpointManagerWarmest::remove
Removes any SetpointManagerWarmest objects from this Node.
OS_DEPRECATED boost::optional<SetpointManagerFollowOutdoorAirTemperature> openstudio::model::Node::setpointManagerFollowOutdoorAirTemperature ( ) const
Deprecated:
Node::setpointManagerFollowOutdoorAirTemperature has been deprecated and will be removed in a future release, please use Node::setpointManagers
Returns the optional SetpointManagerFollowOutdoorAirTemperature associated with this Node.
OS_DEPRECATED boost::optional<SetpointManagerOutdoorAirReset> openstudio::model::Node::setpointManagerOutdoorAirReset ( ) const
Deprecated:
Node::setpointManagerOutdoorAirReset has been deprecated and will be removed in a future release, please use Node::setpointManagers
Returns the optional SetpointManagerOutdoorAirReset associated with this Node.
std::vector<SetpointManager> openstudio::model::Node::setpointManagers ( ) const
OS_DEPRECATED boost::optional<SetpointManagerScheduled> openstudio::model::Node::setpointManagerScheduled ( ) const
Deprecated:
Node::setpointManagerScheduled has been deprecated and will be removed in a future release, please use Node::setpointManagers
Returns the optional SetpointManagerScheduled associated with this Node.
OS_DEPRECATED boost::optional<SetpointManagerWarmest> openstudio::model::Node::setpointManagerWarmest ( ) const
Deprecated:
Node::setpointManagerWarmest has been deprecated and will be removed in a future release, please use Node::setpointManagers
Returns the optional SetpointManagerWarmest associated with this Node.

Friends And Related Function Documentation

typedef std::vector<Node> NodeVector
related
typedef boost::optional<Node> OptionalNode
related