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

#include <CoilHeatingGas.hpp>

+ Inheritance diagram for openstudio::model::CoilHeatingGas:

Public Member Functions

Constructors and Destructors
 CoilHeatingGas (const Model &model, Schedule &schedule)
 Constructs a new CoilHeatingGas object and places it inside the model. More...
 
 CoilHeatingGas (const Model &model)
 
virtual ~CoilHeatingGas ()=default
 
 CoilHeatingGas (const CoilHeatingGas &other)=default
 
 CoilHeatingGas (CoilHeatingGas &&other)=default
 
CoilHeatingGasoperator= (const CoilHeatingGas &)=default
 
CoilHeatingGasoperator= (CoilHeatingGas &&)=default
 
- 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...
 
StraightComponentoperator= (const StraightComponent &)=default
 
StraightComponentoperator= (StraightComponent &&)=default
 
boost::optional< ModelObjectoutletModelObject () const
 Returns the optional ModelObject connected to the outlet port. More...
 
unsigned outletPort () const
 Returns the outlet port. More...
 
std::vector
< openstudio::IdfObject
remove ()
 
bool removeFromLoop ()
 
 StraightComponent (IddObjectType type, const Model &model)
 
 StraightComponent (const StraightComponent &other)=default
 
 StraightComponent (StraightComponent &&other)=default
 
virtual ~StraightComponent ()=default
 
- 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...
 
std::vector< AppGFuelTypeappGHeatingFuelTypes () const
 
void applySizingValues ()
 
void autosize ()
 Returns the optional ModelObject connected to this object's port. More...
 
ComponentType componentType () const
 
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...
 
std::vector< FuelTypecoolingFuelTypes () const
 
void disconnect ()
 Removes all connections to other HVACComponent objects. More...
 
std::vector< FuelTypeheatingFuelTypes () const
 
 HVACComponent (const HVACComponent &other)=default
 
 HVACComponent (HVACComponent &&other)=default
 
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...
 
HVACComponentoperator= (const HVACComponent &)=default
 
HVACComponentoperator= (HVACComponent &&)=default
 
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 ()=default
 
- 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...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=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< 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...
 
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< IdfObjectremoveAdditionalProperties ()
 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
 
- 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)
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
 WorkspaceObject (const WorkspaceObject &other)=default
 
 WorkspaceObject (WorkspaceObject &&other)=default
 
virtual ~WorkspaceObject ()=default
 
- 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
 
boost::optional< std::string > getField (unsigned index, bool returnDefault=false) 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
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (IdfObject &&other) noexcept
 
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, bool checkNames=false) 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
 
std::string nameString (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)
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
IdfObjectoperator= (const IdfObject &other)
 
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=false) const
 
virtual ~IdfObject ()=default
 

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.)

using CoilHeatingGasVector = std::vector< CoilHeatingGas >
 
using OptionalCoilHeatingGas = boost::optional< CoilHeatingGas >
 

Getters and Setters

Schedule availabilitySchedule () const
 Returns the Schedule referred to by the Availability Schedule field. More...
 
Schedule availableSchedule () const
 
bool setAvailabilitySchedule (Schedule &schedule)
 Sets the Schedule referred to by the Availability Schedule field. More...
 
bool setAvailableSchedule (Schedule &schedule)
 
std::string fuelType () const
 Gets the coil fuel type. More...
 
bool setFuelType (const std::string &fuelType)
 Sets the fuel type. More...
 
void resetFuelType ()
 Resets the fuel type to its default. More...
 
double gasBurnerEfficiency () const
 Returns the value of the GasBurnerEfficiency field. More...
 
bool setGasBurnerEfficiency (double value)
 Sets the value of the GasBurnerEfficiency field. More...
 
OS_DEPRECATED double parasiticElectricLoad () const
 Returns the value of the ParasiticElectricLoad field. More...
 
double onCycleParasiticElectricLoad () const
 Returns the value of the OnCycleParasiticElectricLoad field. More...
 
OS_DEPRECATED bool setParasiticElectricLoad (double value)
 Sets the value of the ParasiticElectricLoad field. More...
 
bool setOnCycleParasiticElectricLoad (double value)
 Sets the value of the OnCycleParasiticElectricLoad field. More...
 
OS_DEPRECATED double parasiticGasLoad () const
 Returns the value of the ParasiticGasLoad field. More...
 
double offCycleParasiticGasLoad () const
 Returns the value of the OffCycleParasiticGasLoad field. More...
 
OS_DEPRECATED bool setParasiticGasLoad (double value)
 Sets the value of the ParasiticGasLoad field. More...
 
bool setOffCycleParasiticGasLoad (double value)
 Sets the value of the OffCycleParasiticGasLoad field. More...
 
boost::optional< double > nominalCapacity () const
 
bool isNominalCapacityAutosized () const
 
bool setNominalCapacity (double nominalCapacity)
 
void resetNominalCapacity ()
 
void autosizeNominalCapacity ()
 
boost::optional< CurvepartLoadFractionCorrelationCurve () const
 
bool setPartLoadFractionCorrelationCurve (const Curve &curve)
 
void resetPartLoadFractionCorrelationCurve ()
 
AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct (double length, double diameter)
 Creates a new equivalent duct object if an object is not already attached. More...
 
boost::optional
< AirflowNetworkEquivalentDuct
airflowNetworkEquivalentDuct () const
 Returns the attached equivalent duct object, if any. More...
 
boost::optional< double > autosizedNominalCapacity () const
 
static std::vector< std::string > validFuelTypeValues ()
 Returns a list of valid fuel types. More...
 

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
using ImplType = detail::HVACComponent_Impl
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- 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)
 
 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

CoilHeatingGas is an interface to the IDD object named "OS:Coil:Heating:Gas".

The purpose of this class is to simplify the construction and manipulation OS:Coil:Heating:Gas objects in energyplus.

As of EnergyPlus Version 8.6 this object maps to Coil:Heating:Fuel.

Constructor & Destructor Documentation

openstudio::model::CoilHeatingGas::CoilHeatingGas ( const Model model,
Schedule schedule 
)
explicit

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

The object is fully initialized with all companion objects.

Sets GasBurnerEffeciency to .8 Sets GasFields to AutoSize Sets ParasiticElectricLoad to 0 Sets ParasiticGasLoad to 0

openstudio::model::CoilHeatingGas::CoilHeatingGas ( const Model model)
explicit
virtual openstudio::model::CoilHeatingGas::~CoilHeatingGas ( )
virtualdefault
openstudio::model::CoilHeatingGas::CoilHeatingGas ( const CoilHeatingGas other)
default
openstudio::model::CoilHeatingGas::CoilHeatingGas ( CoilHeatingGas &&  other)
default

Member Function Documentation

boost::optional<AirflowNetworkEquivalentDuct> openstudio::model::CoilHeatingGas::airflowNetworkEquivalentDuct ( ) const

Returns the attached equivalent duct object, if any.

boost::optional<double> openstudio::model::CoilHeatingGas::autosizedNominalCapacity ( ) const
void openstudio::model::CoilHeatingGas::autosizeNominalCapacity ( )
Schedule openstudio::model::CoilHeatingGas::availabilitySchedule ( ) const

Returns the Schedule referred to by the Availability Schedule field.

Schedule openstudio::model::CoilHeatingGas::availableSchedule ( ) const
std::string openstudio::model::CoilHeatingGas::fuelType ( ) const

Gets the coil fuel type.

double openstudio::model::CoilHeatingGas::gasBurnerEfficiency ( ) const

Returns the value of the GasBurnerEfficiency field.

AirflowNetworkEquivalentDuct openstudio::model::CoilHeatingGas::getAirflowNetworkEquivalentDuct ( double  length,
double  diameter 
)

Creates a new equivalent duct object if an object is not already attached.

static IddObjectType openstudio::model::CoilHeatingGas::iddObjectType ( )
static
bool openstudio::model::CoilHeatingGas::isNominalCapacityAutosized ( ) const
boost::optional<double> openstudio::model::CoilHeatingGas::nominalCapacity ( ) const
double openstudio::model::CoilHeatingGas::offCycleParasiticGasLoad ( ) const

Returns the value of the OffCycleParasiticGasLoad field.

double openstudio::model::CoilHeatingGas::onCycleParasiticElectricLoad ( ) const

Returns the value of the OnCycleParasiticElectricLoad field.

CoilHeatingGas& openstudio::model::CoilHeatingGas::operator= ( const CoilHeatingGas )
default
CoilHeatingGas& openstudio::model::CoilHeatingGas::operator= ( CoilHeatingGas &&  )
default
OS_DEPRECATED double openstudio::model::CoilHeatingGas::parasiticElectricLoad ( ) const

Returns the value of the ParasiticElectricLoad field.

OS_DEPRECATED double openstudio::model::CoilHeatingGas::parasiticGasLoad ( ) const

Returns the value of the ParasiticGasLoad field.

boost::optional<Curve> openstudio::model::CoilHeatingGas::partLoadFractionCorrelationCurve ( ) const
void openstudio::model::CoilHeatingGas::resetFuelType ( )

Resets the fuel type to its default.

void openstudio::model::CoilHeatingGas::resetNominalCapacity ( )
void openstudio::model::CoilHeatingGas::resetPartLoadFractionCorrelationCurve ( )
bool openstudio::model::CoilHeatingGas::setAvailabilitySchedule ( Schedule schedule)

Sets the Schedule referred to by the Availability Schedule field.

bool openstudio::model::CoilHeatingGas::setAvailableSchedule ( Schedule schedule)
bool openstudio::model::CoilHeatingGas::setFuelType ( const std::string &  fuelType)

Sets the fuel type.

bool openstudio::model::CoilHeatingGas::setGasBurnerEfficiency ( double  value)

Sets the value of the GasBurnerEfficiency field.

bool openstudio::model::CoilHeatingGas::setNominalCapacity ( double  nominalCapacity)
bool openstudio::model::CoilHeatingGas::setOffCycleParasiticGasLoad ( double  value)

Sets the value of the OffCycleParasiticGasLoad field.

bool openstudio::model::CoilHeatingGas::setOnCycleParasiticElectricLoad ( double  value)

Sets the value of the OnCycleParasiticElectricLoad field.

OS_DEPRECATED bool openstudio::model::CoilHeatingGas::setParasiticElectricLoad ( double  value)

Sets the value of the ParasiticElectricLoad field.

OS_DEPRECATED bool openstudio::model::CoilHeatingGas::setParasiticGasLoad ( double  value)

Sets the value of the ParasiticGasLoad field.

bool openstudio::model::CoilHeatingGas::setPartLoadFractionCorrelationCurve ( const Curve curve)
static std::vector<std::string> openstudio::model::CoilHeatingGas::validFuelTypeValues ( )
static

Returns a list of valid fuel types.

Friends And Related Function Documentation

using CoilHeatingGasVector = std::vector<CoilHeatingGas>
related
using OptionalCoilHeatingGas = boost::optional<CoilHeatingGas>
related