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

#include <AirflowNetworkCrack.hpp>

+ Inheritance diagram for openstudio::model::AirflowNetworkCrack:

Public Member Functions

Constructors and Destructors
 AirflowNetworkCrack (const Model &model, double massFlowCoefficient)
 Construct a surface crack object with default values and a specified mass flow coefficient. More...
 
 AirflowNetworkCrack (const Model &model, double massFlowCoefficient, double massFlowExponent)
 Construct a surface crack object without a reference conditions object. More...
 
 AirflowNetworkCrack (const Model &model, double massFlowCoefficient, double massFlowExponent, const AirflowNetworkReferenceCrackConditions &referenceCrackConditions)
 Construct a surface crack object. More...
 
virtual ~AirflowNetworkCrack ()=default
 
 AirflowNetworkCrack (const AirflowNetworkCrack &other)=default
 
 AirflowNetworkCrack (AirflowNetworkCrack &&other)=default
 
AirflowNetworkCrackoperator= (const AirflowNetworkCrack &)=default
 
AirflowNetworkCrackoperator= (AirflowNetworkCrack &&)=default
 
Getters
double airMassFlowCoefficient () const
 Returns the mass flow coefficient in kg/s at 1 Pa. More...
 
double airMassFlowExponent () const
 Returns the mass flow exponent. More...
 
bool isAirMassFlowExponentDefaulted () const
 Returns true if the mass flow exponent is defaulted. More...
 
boost::optional
< AirflowNetworkReferenceCrackConditions
referenceCrackConditions () const
 Returns a reference crack conditions object if available. More...
 
Setters
bool setAirMassFlowCoefficient (double airMassFlowCoefficientatReferenceConditions)
 Sets the mass flow coefficient in kg/s at 1 Pa. More...
 
bool setAirMassFlowExponent (double airMassFlowExponent)
 Sets the mass flow exponent. More...
 
void resetAirMassFlowExponent ()
 Returns the mass flow exponent to the default value. More...
 
bool setReferenceCrackConditions (const AirflowNetworkReferenceCrackConditions &referenceCrackConditions)
 Sets the the reference crack conditions. More...
 
void resetReferenceCrackConditions ()
 Resets the the reference crack conditions. More...
 
- Public Member Functions inherited from openstudio::model::AirflowNetworkComponent
 AirflowNetworkComponent (IddObjectType type, const Model &model)
 
 AirflowNetworkComponent (const AirflowNetworkComponent &other)=default
 
 AirflowNetworkComponent (AirflowNetworkComponent &&other)=default
 
boost::optional< ModelObjectcomponentModelObject () const
 
AirflowNetworkComponentoperator= (const AirflowNetworkComponent &)=default
 
AirflowNetworkComponentoperator= (AirflowNetworkComponent &&)=default
 
virtual ~AirflowNetworkComponent ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (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< 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 (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< 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.)

using AirflowNetworkCrackVector = std::vector< AirflowNetworkCrack >
 
using OptionalAirflowNetworkCrack = boost::optional< AirflowNetworkCrack >
 

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)
 

Detailed Description

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

Constructor & Destructor Documentation

openstudio::model::AirflowNetworkCrack::AirflowNetworkCrack ( const Model model,
double  massFlowCoefficient 
)

Construct a surface crack object with default values and a specified mass flow coefficient.

openstudio::model::AirflowNetworkCrack::AirflowNetworkCrack ( const Model model,
double  massFlowCoefficient,
double  massFlowExponent 
)

Construct a surface crack object without a reference conditions object.

openstudio::model::AirflowNetworkCrack::AirflowNetworkCrack ( const Model model,
double  massFlowCoefficient,
double  massFlowExponent,
const AirflowNetworkReferenceCrackConditions referenceCrackConditions 
)

Construct a surface crack object.

virtual openstudio::model::AirflowNetworkCrack::~AirflowNetworkCrack ( )
virtualdefault
openstudio::model::AirflowNetworkCrack::AirflowNetworkCrack ( const AirflowNetworkCrack other)
default
openstudio::model::AirflowNetworkCrack::AirflowNetworkCrack ( AirflowNetworkCrack &&  other)
default

Member Function Documentation

double openstudio::model::AirflowNetworkCrack::airMassFlowCoefficient ( ) const

Returns the mass flow coefficient in kg/s at 1 Pa.

double openstudio::model::AirflowNetworkCrack::airMassFlowExponent ( ) const

Returns the mass flow exponent.

static IddObjectType openstudio::model::AirflowNetworkCrack::iddObjectType ( )
static
bool openstudio::model::AirflowNetworkCrack::isAirMassFlowExponentDefaulted ( ) const

Returns true if the mass flow exponent is defaulted.

AirflowNetworkCrack& openstudio::model::AirflowNetworkCrack::operator= ( const AirflowNetworkCrack )
default
AirflowNetworkCrack& openstudio::model::AirflowNetworkCrack::operator= ( AirflowNetworkCrack &&  )
default
boost::optional<AirflowNetworkReferenceCrackConditions> openstudio::model::AirflowNetworkCrack::referenceCrackConditions ( ) const

Returns a reference crack conditions object if available.

void openstudio::model::AirflowNetworkCrack::resetAirMassFlowExponent ( )

Returns the mass flow exponent to the default value.

void openstudio::model::AirflowNetworkCrack::resetReferenceCrackConditions ( )

Resets the the reference crack conditions.

bool openstudio::model::AirflowNetworkCrack::setAirMassFlowCoefficient ( double  airMassFlowCoefficientatReferenceConditions)

Sets the mass flow coefficient in kg/s at 1 Pa.

bool openstudio::model::AirflowNetworkCrack::setAirMassFlowExponent ( double  airMassFlowExponent)

Sets the mass flow exponent.

bool openstudio::model::AirflowNetworkCrack::setReferenceCrackConditions ( const AirflowNetworkReferenceCrackConditions referenceCrackConditions)

Sets the the reference crack conditions.

Friends And Related Function Documentation

using AirflowNetworkCrackVector = std::vector<AirflowNetworkCrack>
related
using OptionalAirflowNetworkCrack = boost::optional<AirflowNetworkCrack>
related