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

#include <CoilCoolingCooledBeam.hpp>

+ Inheritance diagram for openstudio::model::CoilCoolingCooledBeam:

Public Member Functions

Constructors and Destructors
 CoilCoolingCooledBeam (const Model &model)
virtual ~CoilCoolingCooledBeam ()
double coilSurfaceAreaperCoilLength () const
bool isCoilSurfaceAreaperCoilLengthDefaulted () const
double modelParametera () const
bool isModelParameteraDefaulted () const
double modelParametern1 () const
bool isModelParametern1Defaulted () const
double modelParametern2 () const
bool isModelParametern2Defaulted () const
double modelParametern3 () const
bool isModelParametern3Defaulted () const
double modelParametera0 () const
bool isModelParametera0Defaulted () const
double modelParameterK1 () const
bool isModelParameterK1Defaulted () const
double modelParametern () const
bool isModelParameternDefaulted () const
double leavingPipeInsideDiameter () const
bool isLeavingPipeInsideDiameterDefaulted () const
bool setCoilSurfaceAreaperCoilLength (double coilSurfaceAreaperCoilLength)
void resetCoilSurfaceAreaperCoilLength ()
bool setModelParametera (double modelParametera)
void resetModelParametera ()
bool setModelParametern1 (double modelParametern1)
void resetModelParametern1 ()
bool setModelParametern2 (double modelParametern2)
void resetModelParametern2 ()
bool setModelParametern3 (double modelParametern3)
void resetModelParametern3 ()
bool setModelParametera0 (double modelParametera0)
void resetModelParametera0 ()
bool setModelParameterK1 (double modelParameterK1)
void resetModelParameterK1 ()
bool setModelParametern (double modelParametern)
void resetModelParametern ()
bool setLeavingPipeInsideDiameter (double leavingPipeInsideDiameter)
void resetLeavingPipeInsideDiameter ()
- 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 () const
 Returns the optional ModelObject connected to the inlet port. More...
unsigned inletPort () const
 Returns the inlet port. More...
boost::optional< ModelObjectoutletModelObject () const
 Returns the optional ModelObject connected to the outlet port. More...
unsigned outletPort () const
 Returns the outlet port. More...
< openstudio::IdfObject > 
remove ()
bool removeFromLoop ()
 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...
< AirLoopHVACOutdoorAirSystem
airLoopHVACOutdoorAirSystem () const
 Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to. More...
void applySizingValues ()
void autosize ()
 Returns the optional ModelObject connected to this object's port. More...
boost::optional< HVACComponentcontainingHVACComponent () const
 EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components. More...
< StraightComponent
containingStraightComponent () const
< 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< IdfObject > remove ()
 Removes the HVACComponent from the model only if isRemovable() return true. More...
virtual ~HVACComponent ()
- 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...
< 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 ()

Related Functions

(Note that these are not member functions.)

typedef std::vector
< CoilCoolingCooledBeam
typedef boost::optional
< CoilCoolingCooledBeam

Additional Inherited Members

- 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 Member Functions inherited from openstudio::model::HVACComponent
virtual std::vector< ModelObjectchildren () const
 HVACComponent (IddObjectType type, const Model &model)
 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)

Detailed Description

CoilCoolingCooledBeam is a StraightComponent that wraps the OpenStudio IDD object 'OS:Coil:Cooling:CooledBeam'.

Constructor & Destructor Documentation

openstudio::model::CoilCoolingCooledBeam::CoilCoolingCooledBeam ( const Model model)
virtual openstudio::model::CoilCoolingCooledBeam::~CoilCoolingCooledBeam ( )

Member Function Documentation

double openstudio::model::CoilCoolingCooledBeam::coilSurfaceAreaperCoilLength ( ) const
static IddObjectType openstudio::model::CoilCoolingCooledBeam::iddObjectType ( )
bool openstudio::model::CoilCoolingCooledBeam::isCoilSurfaceAreaperCoilLengthDefaulted ( ) const
bool openstudio::model::CoilCoolingCooledBeam::isLeavingPipeInsideDiameterDefaulted ( ) const
bool openstudio::model::CoilCoolingCooledBeam::isModelParametera0Defaulted ( ) const
bool openstudio::model::CoilCoolingCooledBeam::isModelParameteraDefaulted ( ) const
bool openstudio::model::CoilCoolingCooledBeam::isModelParameterK1Defaulted ( ) const
bool openstudio::model::CoilCoolingCooledBeam::isModelParametern1Defaulted ( ) const
bool openstudio::model::CoilCoolingCooledBeam::isModelParametern2Defaulted ( ) const
bool openstudio::model::CoilCoolingCooledBeam::isModelParametern3Defaulted ( ) const
bool openstudio::model::CoilCoolingCooledBeam::isModelParameternDefaulted ( ) const
double openstudio::model::CoilCoolingCooledBeam::leavingPipeInsideDiameter ( ) const
double openstudio::model::CoilCoolingCooledBeam::modelParametera ( ) const
double openstudio::model::CoilCoolingCooledBeam::modelParametera0 ( ) const
double openstudio::model::CoilCoolingCooledBeam::modelParameterK1 ( ) const
double openstudio::model::CoilCoolingCooledBeam::modelParametern ( ) const
double openstudio::model::CoilCoolingCooledBeam::modelParametern1 ( ) const
double openstudio::model::CoilCoolingCooledBeam::modelParametern2 ( ) const
double openstudio::model::CoilCoolingCooledBeam::modelParametern3 ( ) const
void openstudio::model::CoilCoolingCooledBeam::resetCoilSurfaceAreaperCoilLength ( )
void openstudio::model::CoilCoolingCooledBeam::resetLeavingPipeInsideDiameter ( )
void openstudio::model::CoilCoolingCooledBeam::resetModelParametera ( )
void openstudio::model::CoilCoolingCooledBeam::resetModelParametera0 ( )
void openstudio::model::CoilCoolingCooledBeam::resetModelParameterK1 ( )
void openstudio::model::CoilCoolingCooledBeam::resetModelParametern ( )
void openstudio::model::CoilCoolingCooledBeam::resetModelParametern1 ( )
void openstudio::model::CoilCoolingCooledBeam::resetModelParametern2 ( )
void openstudio::model::CoilCoolingCooledBeam::resetModelParametern3 ( )
bool openstudio::model::CoilCoolingCooledBeam::setCoilSurfaceAreaperCoilLength ( double  coilSurfaceAreaperCoilLength)
bool openstudio::model::CoilCoolingCooledBeam::setLeavingPipeInsideDiameter ( double  leavingPipeInsideDiameter)
bool openstudio::model::CoilCoolingCooledBeam::setModelParametera ( double  modelParametera)
bool openstudio::model::CoilCoolingCooledBeam::setModelParametera0 ( double  modelParametera0)
bool openstudio::model::CoilCoolingCooledBeam::setModelParameterK1 ( double  modelParameterK1)
bool openstudio::model::CoilCoolingCooledBeam::setModelParametern ( double  modelParametern)
bool openstudio::model::CoilCoolingCooledBeam::setModelParametern1 ( double  modelParametern1)
bool openstudio::model::CoilCoolingCooledBeam::setModelParametern2 ( double  modelParametern2)
bool openstudio::model::CoilCoolingCooledBeam::setModelParametern3 ( double  modelParametern3)

Friends And Related Function Documentation

typedef std::vector<CoilCoolingCooledBeam> CoilCoolingCooledBeamVector
typedef boost::optional<CoilCoolingCooledBeam> OptionalCoilCoolingCooledBeam