#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

CoilHeatingGas &	operator= (const CoilHeatingGas &)=default

CoilHeatingGas &	operator= (CoilHeatingGas &&)=default

Public Member Functions inherited from openstudio::model::StraightComponent
bool	addToNode (Node &node)

boost::optional< AirLoopHVAC >	airLoopHVAC () const
	Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More...

ModelObject	clone (Model model) const

void	disconnect ()

boost::optional< ModelObject >	inletModelObject () const
	Returns the optional ModelObject connected to the inlet port. More...

unsigned	inletPort () const
	Returns the inlet port. More...

StraightComponent &	operator= (const StraightComponent &)=default

StraightComponent &	operator= (StraightComponent &&)=default

boost::optional< ModelObject >	outletModelObject () 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< AirLoopHVAC >	airLoopHVAC () 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< AppGFuelType >	appGHeatingFuelTypes () const

void	applySizingValues ()

void	autosize ()
	Returns the optional ModelObject connected to this object's port. More...

ComponentType	componentType () const

boost::optional< HVACComponent >	containingHVACComponent () 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< FuelType >	coolingFuelTypes () const

void	disconnect ()
	Removes all connections to other HVACComponent objects. More...

std::vector< FuelType >	heatingFuelTypes () 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< Loop >	loop () const
	Returns the optional Loop object that the HVAC component is attached to. More...

HVACComponent &	operator= (const HVACComponent &)=default

HVACComponent &	operator= (HVACComponent &&)=default

boost::optional< PlantLoop >	plantLoop () 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 ()=default

Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType >	allowableChildTypes () const
	Returns a vector of allowable children types. More...

std::vector< ModelObject >	children () const
	Return direct child objects in the Model. More...

ParentObject &	operator= (const ParentObject &)=default

ParentObject &	operator= (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

ModelObject &	operator= (const ModelObject &)=default

ModelObject &	operator= (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< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one. More...

std::vector< ResourceObject >	resources () 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< OutputVariable >	outputVariables () 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< LifeCycleCost >	lifeCycleCosts () 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< ScheduleTypeKey >	getScheduleTypeKeys (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< ModelObject >	connectedObject (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	CoilHeatingGasVector = std::vector< CoilHeatingGas >

using	OptionalCoilHeatingGas = boost::optional< CoilHeatingGas >

Related Functions inherited from openstudio::model::ParentObject
std::vector< ModelObject >	getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true)
	Returns object and all other objects accessible by calling children() on encountered ParentObjects . More...

std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More...

Related Functions inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More...

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

double	parasiticElectricLoad () const
	Returns the value of the ParasiticElectricLoad field. More...

bool	setParasiticElectricLoad (double value)
	Sets the value of the ParasiticElectricLoad field. More...

double	parasiticGasLoad () const
	Returns the value of the ParasiticGasLoad field. More...

bool	setParasiticGasLoad (double value)
	Sets the value of the ParasiticGasLoad field. More...

boost::optional< double >	nominalCapacity () const

bool	isNominalCapacityAutosized () const

bool	setNominalCapacity (double nominalCapacity)

void	resetNominalCapacity ()

void	autosizeNominalCapacity ()

boost::optional< Curve >	partLoadFractionCorrelationCurve () 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
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 Member Functions inherited from openstudio::model::HVACComponent
virtual std::vector< ModelObject >	children () 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

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

Deprecated:

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

CoilHeatingGas& openstudio::model::CoilHeatingGas::operator= ( const CoilHeatingGas & )

default

CoilHeatingGas& openstudio::model::CoilHeatingGas::operator= ( CoilHeatingGas && )

default

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

Returns the value of the ParasiticElectricLoad field.

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 )

Deprecated:

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::setParasiticElectricLoad ( double value )

Sets the value of the ParasiticElectricLoad field.

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>

Public Member Functions

Static Public Member Functions

Related Functions

Getters and Setters

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation