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

#include <AirflowNetworkExternalNode.hpp>

+ Inheritance diagram for openstudio::model::AirflowNetworkExternalNode:

Public Member Functions

Constructors and Destructors
 AirflowNetworkExternalNode (const Model &model)
 Construct an external node with defaulted values. More...
 
 AirflowNetworkExternalNode (const Model &model, const Curve &curve)
 Construct an external node with a specified wind pressure curve. More...
 
virtual ~AirflowNetworkExternalNode ()
 
Getters
double externalNodeHeight () const
 Returns the external node height. More...
 
bool isExternalNodeHeightDefaulted () const
 Returns true if the external node height is defaulted. More...
 
Curve windPressureCoefficientCurve () const
 Returns the wind pressure coefficient curve for this external node. More...
 
bool symmetricWindPressureCoefficientCurve () const
 Returns true if the wind pressure curve is to be treated as symmetric. More...
 
bool isSymmetricWindPressureCoefficientCurveDefaulted () const
 Returns true if the wind pressure curve symmetry is defaulted. More...
 
std::string windAngleType () const
 Returns the wind angle type, "Absolute" or "Relative". More...
 
bool isWindAngleTypeDefaulted () const
 Returns true if the wind angle type is defaulted ("Absolute). More...
 
Setters
void setExternalNodeHeight (double externalNodeHeight)
 Sets the external node height. More...
 
void resetExternalNodeHeight ()
 Resets the external node height. More...
 
bool setWindPressureCoefficientCurve (const Curve &wPCValue)
 Sets the wind pressure coefficient curve. More...
 
void setSymmetricWindPressureCoefficientCurve (bool symmetricWindPressureCoefficientCurve)
 Sets the wind pressure curve symmetry. More...
 
void resetSymmetricWindPressureCoefficientCurve ()
 Resets the wind pressure curve symmetry. More...
 
bool setWindAngleType (const std::string &windAngleType)
 Sets the wind angle type. More...
 
void resetWindAngleType ()
 Resets the wind angle type. More...
 
- Public Member Functions inherited from openstudio::model::AirflowNetworkNode
 AirflowNetworkNode (IddObjectType type, const Model &model)
 
virtual ~AirflowNetworkNode ()
 
- 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...
 
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 ()
 
static std::vector< std::string > windAngleTypeValues ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< AirflowNetworkExternalNode
AirflowNetworkExternalNodeVector
 
typedef boost::optional
< AirflowNetworkExternalNode
OptionalAirflowNetworkExternalNode
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- 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

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

Constructor & Destructor Documentation

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

Construct an external node with defaulted values.

openstudio::model::AirflowNetworkExternalNode::AirflowNetworkExternalNode ( const Model model,
const Curve curve 
)
explicit

Construct an external node with a specified wind pressure curve.

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

Member Function Documentation

double openstudio::model::AirflowNetworkExternalNode::externalNodeHeight ( ) const

Returns the external node height.

static IddObjectType openstudio::model::AirflowNetworkExternalNode::iddObjectType ( )
static
bool openstudio::model::AirflowNetworkExternalNode::isExternalNodeHeightDefaulted ( ) const

Returns true if the external node height is defaulted.

bool openstudio::model::AirflowNetworkExternalNode::isSymmetricWindPressureCoefficientCurveDefaulted ( ) const

Returns true if the wind pressure curve symmetry is defaulted.

bool openstudio::model::AirflowNetworkExternalNode::isWindAngleTypeDefaulted ( ) const

Returns true if the wind angle type is defaulted ("Absolute).

void openstudio::model::AirflowNetworkExternalNode::resetExternalNodeHeight ( )

Resets the external node height.

void openstudio::model::AirflowNetworkExternalNode::resetSymmetricWindPressureCoefficientCurve ( )

Resets the wind pressure curve symmetry.

void openstudio::model::AirflowNetworkExternalNode::resetWindAngleType ( )

Resets the wind angle type.

void openstudio::model::AirflowNetworkExternalNode::setExternalNodeHeight ( double  externalNodeHeight)

Sets the external node height.

void openstudio::model::AirflowNetworkExternalNode::setSymmetricWindPressureCoefficientCurve ( bool  symmetricWindPressureCoefficientCurve)

Sets the wind pressure curve symmetry.

bool openstudio::model::AirflowNetworkExternalNode::setWindAngleType ( const std::string &  windAngleType)

Sets the wind angle type.

bool openstudio::model::AirflowNetworkExternalNode::setWindPressureCoefficientCurve ( const Curve wPCValue)

Sets the wind pressure coefficient curve.

bool openstudio::model::AirflowNetworkExternalNode::symmetricWindPressureCoefficientCurve ( ) const

Returns true if the wind pressure curve is to be treated as symmetric.

std::string openstudio::model::AirflowNetworkExternalNode::windAngleType ( ) const

Returns the wind angle type, "Absolute" or "Relative".

static std::vector<std::string> openstudio::model::AirflowNetworkExternalNode::windAngleTypeValues ( )
static
Curve openstudio::model::AirflowNetworkExternalNode::windPressureCoefficientCurve ( ) const

Returns the wind pressure coefficient curve for this external node.

Friends And Related Function Documentation