openstudio::model::GeneratorFuelCellAuxiliaryHeater Class Reference

#include <GeneratorFuelCellAuxiliaryHeater.hpp>

Inheritance diagram for openstudio::model::GeneratorFuelCellAuxiliaryHeater:

Public Member Functions
Constructors and Destructors
	GeneratorFuelCellAuxiliaryHeater (const Model &model)
virtual	~GeneratorFuelCellAuxiliaryHeater ()
Getters
double	excessAirRatio () const
double	ancillaryPowerConstantTerm () const
double	ancillaryPowerLinearTerm () const
double	skinLossUFactorTimesAreaValue () const
std::string	skinLossDestination () const
boost::optional< ThermalZone >	zonetoReceiveSkinLosses () const
std::string	heatingCapacityUnits () const
double	maximumHeatingCapacityinWatts () const
double	minimumHeatingCapacityinWatts () const
double	maximumHeatingCapacityinKmolperSecond () const
double	minimumHeatingCapacityinKmolperSecond () const
boost::optional < GeneratorFuelCell >	fuelCell () const
Setters
bool	setExcessAirRatio (double excessAirRatio)
void	resetExcessAirRatio ()
bool	setAncillaryPowerConstantTerm (double ancillaryPowerConstantTerm)
void	resetAncillaryPowerConstantTerm ()
bool	setAncillaryPowerLinearTerm (double ancillaryPowerLinearTerm)
void	resetAncillaryPowerLinearTerm ()
bool	setSkinLossUFactorTimesAreaValue (double skinLossUFactorTimesAreaValue)
void	resetSkinLossUFactorTimesAreaValue ()
bool	setSkinLossDestination (const std::string &skinLossDestination)
void	resetSkinLossDestination ()
bool	setZonetoReceiveSkinLosses (const ThermalZone &zone)
void	resetZonetoReceiveSkinLosses ()
bool	setHeatingCapacityUnits (const std::string &heatingCapacityUnits)
void	resetHeatingCapacityUnits ()
bool	setMaximumHeatingCapacityinWatts (double maximumHeatingCapacityinWatts)
void	resetMaximumHeatingCapacityinWatts ()
bool	setMinimumHeatingCapacityinWatts (double minimumHeatingCapacityinWatts)
void	resetMinimumHeatingCapacityinWatts ()
bool	setMaximumHeatingCapacityinKmolperSecond (double maximumHeatingCapacityinKmolperSecond)
void	resetMaximumHeatingCapacityinKmolperSecond ()
bool	setMinimumHeatingCapacityinKmolperSecond (double minimumHeatingCapacityinKmolperSecond)
void	resetMinimumHeatingCapacityinKmolperSecond ()
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< 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...
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 (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< ModelObject >	connectedObject (unsigned port) const
boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Static Public Member Functions
static std::vector< std::string >	heatingCapacityUnitsValues ()
static IddObjectType	iddObjectType ()
static std::vector< std::string >	skinLossDestinationValues ()

Related Functions
(Note that these are not member functions.)
typedef std::vector < GeneratorFuelCellAuxiliaryHeater >	GeneratorFuelCellAuxiliaryHeaterVector
typedef boost::optional < GeneratorFuelCellAuxiliaryHeater >	OptionalGeneratorFuelCellAuxiliaryHeater
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...
typedef std::pair< std::string, std::string >	ScheduleTypeKey
	Typedef for ScheduleTypeRegistry key. More...
typedef std::pair< std::string, std::string >	ScheduleTypeKey
	Typedef for ScheduleTypeRegistry key. More...

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

GeneratorFuelCellAuxiliaryHeater is a ModelObject that wraps the OpenStudio IDD object 'OS:Generator:FuelCell:AuxiliaryHeater'.

Constructor & Destructor Documentation

openstudio::model::GeneratorFuelCellAuxiliaryHeater::GeneratorFuelCellAuxiliaryHeater ( const Model &  model )

explicit

virtual openstudio::model::GeneratorFuelCellAuxiliaryHeater::~GeneratorFuelCellAuxiliaryHeater ( )

inlinevirtual

Member Function Documentation

double openstudio::model::GeneratorFuelCellAuxiliaryHeater::ancillaryPowerConstantTerm

(

)

const

double openstudio::model::GeneratorFuelCellAuxiliaryHeater::ancillaryPowerLinearTerm

(

)

const

double openstudio::model::GeneratorFuelCellAuxiliaryHeater::excessAirRatio

(

)

const

boost::optional<GeneratorFuelCell> openstudio::model::GeneratorFuelCellAuxiliaryHeater::fuelCell

(

)

const

std::string openstudio::model::GeneratorFuelCellAuxiliaryHeater::heatingCapacityUnits

(

)

const

static std::vector<std::string> openstudio::model::GeneratorFuelCellAuxiliaryHeater::heatingCapacityUnitsValues ( )

static

static IddObjectType openstudio::model::GeneratorFuelCellAuxiliaryHeater::iddObjectType ( )

static

double openstudio::model::GeneratorFuelCellAuxiliaryHeater::maximumHeatingCapacityinKmolperSecond

(

)

const

double openstudio::model::GeneratorFuelCellAuxiliaryHeater::maximumHeatingCapacityinWatts

(

)

const

double openstudio::model::GeneratorFuelCellAuxiliaryHeater::minimumHeatingCapacityinKmolperSecond

(

)

const

double openstudio::model::GeneratorFuelCellAuxiliaryHeater::minimumHeatingCapacityinWatts

(

)

const

void openstudio::model::GeneratorFuelCellAuxiliaryHeater::resetAncillaryPowerConstantTerm

(

)

void openstudio::model::GeneratorFuelCellAuxiliaryHeater::resetAncillaryPowerLinearTerm

(

)

void openstudio::model::GeneratorFuelCellAuxiliaryHeater::resetExcessAirRatio

(

)

void openstudio::model::GeneratorFuelCellAuxiliaryHeater::resetHeatingCapacityUnits

(

)

void openstudio::model::GeneratorFuelCellAuxiliaryHeater::resetMaximumHeatingCapacityinKmolperSecond

(

)

void openstudio::model::GeneratorFuelCellAuxiliaryHeater::resetMaximumHeatingCapacityinWatts

(

)

void openstudio::model::GeneratorFuelCellAuxiliaryHeater::resetMinimumHeatingCapacityinKmolperSecond

(

)

void openstudio::model::GeneratorFuelCellAuxiliaryHeater::resetMinimumHeatingCapacityinWatts

(

)

void openstudio::model::GeneratorFuelCellAuxiliaryHeater::resetSkinLossDestination

(

)

void openstudio::model::GeneratorFuelCellAuxiliaryHeater::resetSkinLossUFactorTimesAreaValue

(

)

void openstudio::model::GeneratorFuelCellAuxiliaryHeater::resetZonetoReceiveSkinLosses

(

)

bool openstudio::model::GeneratorFuelCellAuxiliaryHeater::setAncillaryPowerConstantTerm

(

double

ancillaryPowerConstantTerm

)

bool openstudio::model::GeneratorFuelCellAuxiliaryHeater::setAncillaryPowerLinearTerm

(

double

ancillaryPowerLinearTerm

)

bool openstudio::model::GeneratorFuelCellAuxiliaryHeater::setExcessAirRatio

(

double

excessAirRatio

)

bool openstudio::model::GeneratorFuelCellAuxiliaryHeater::setHeatingCapacityUnits

(

const std::string &

heatingCapacityUnits

)

bool openstudio::model::GeneratorFuelCellAuxiliaryHeater::setMaximumHeatingCapacityinKmolperSecond

(

double

maximumHeatingCapacityinKmolperSecond

)

bool openstudio::model::GeneratorFuelCellAuxiliaryHeater::setMaximumHeatingCapacityinWatts

(

double

maximumHeatingCapacityinWatts

)

bool openstudio::model::GeneratorFuelCellAuxiliaryHeater::setMinimumHeatingCapacityinKmolperSecond

(

double

minimumHeatingCapacityinKmolperSecond

)

bool openstudio::model::GeneratorFuelCellAuxiliaryHeater::setMinimumHeatingCapacityinWatts

(

double

minimumHeatingCapacityinWatts

)

bool openstudio::model::GeneratorFuelCellAuxiliaryHeater::setSkinLossDestination

(

const std::string &

skinLossDestination

)

bool openstudio::model::GeneratorFuelCellAuxiliaryHeater::setSkinLossUFactorTimesAreaValue

(

double

skinLossUFactorTimesAreaValue

)

bool openstudio::model::GeneratorFuelCellAuxiliaryHeater::setZonetoReceiveSkinLosses

(

const ThermalZone &

zone

)

std::string openstudio::model::GeneratorFuelCellAuxiliaryHeater::skinLossDestination

(

)

const

static std::vector<std::string> openstudio::model::GeneratorFuelCellAuxiliaryHeater::skinLossDestinationValues ( )

static

double openstudio::model::GeneratorFuelCellAuxiliaryHeater::skinLossUFactorTimesAreaValue

(

)

const

boost::optional<ThermalZone> openstudio::model::GeneratorFuelCellAuxiliaryHeater::zonetoReceiveSkinLosses

(

)

const

Friends And Related Function Documentation

typedef std::vector<GeneratorFuelCellAuxiliaryHeater> GeneratorFuelCellAuxiliaryHeaterVector

related

typedef boost::optional<GeneratorFuelCellAuxiliaryHeater> OptionalGeneratorFuelCellAuxiliaryHeater

related