openstudio::model::GeneratorFuelCell Class Reference

#include <GeneratorFuelCell.hpp>

Inheritance diagram for openstudio::model::GeneratorFuelCell:

Public Member Functions
Constructors and Destructors
	GeneratorFuelCell (const Model &model, const GeneratorFuelCellPowerModule &fCPM, const GeneratorFuelCellAirSupply &fCAS, const GeneratorFuelCellWaterSupply &fCWS, const GeneratorFuelCellAuxiliaryHeater &fCAH, const GeneratorFuelCellExhaustGasToWaterHeatExchanger &fCExhaustHX, const GeneratorFuelCellElectricalStorage &fCES, const GeneratorFuelCellInverter &fCInverter, const GeneratorFuelSupply &fS)
	GeneratorFuelCell (const Model &model)
virtual	~GeneratorFuelCell ()
Getters
GeneratorFuelCellPowerModule	powerModule () const
GeneratorFuelCellAirSupply	airSupply () const
GeneratorFuelSupply	fuelSupply () const
GeneratorFuelCellWaterSupply	waterSupply () const
GeneratorFuelCellAuxiliaryHeater	auxiliaryHeater () const
GeneratorFuelCellExhaustGasToWaterHeatExchanger	heatExchanger () const
GeneratorFuelCellElectricalStorage	electricalStorage () const
GeneratorFuelCellInverter	inverter () const
boost::optional < GeneratorFuelCellStackCooler >	stackCooler () const
Setters
bool	setPowerModule (const GeneratorFuelCellPowerModule &fCPM)
bool	setAirSupply (const GeneratorFuelCellAirSupply &fCAirSup)
bool	setFuelSupply (const GeneratorFuelSupply &genFuelSup)
bool	setWaterSupply (const GeneratorFuelCellWaterSupply &fCWaterSup)
bool	setAuxiliaryHeater (const GeneratorFuelCellAuxiliaryHeater &fCAuxHeat)
bool	setHeatExchanger (const GeneratorFuelCellExhaustGasToWaterHeatExchanger &fCExhaustHX)
bool	setElectricalStorage (const GeneratorFuelCellElectricalStorage &fCStorage)
bool	setInverter (const GeneratorFuelCellInverter &fCInverter)
bool	setStackCooler (const GeneratorFuelCellStackCooler &fCStackCooler)
void	resetStackCooler ()
Public Member Functions inherited from openstudio::model::Generator
boost::optional< Schedule >	availabilitySchedule () const
boost::optional < ElectricLoadCenterDistribution >	electricLoadCenterDistribution () const
	Generator (IddObjectType type, const Model &model)
std::string	generatorObjectType () const
boost::optional< double >	ratedElectricPowerOutput () const
boost::optional< double >	ratedThermaltoElectricalPowerRatio () const
virtual	~Generator ()
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...
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< 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 (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 IddObjectType	iddObjectType ()

Related Functions
(Note that these are not member functions.)
typedef std::vector < GeneratorFuelCell >	GeneratorFuelCellVector
typedef boost::optional < GeneratorFuelCell >	OptionalGeneratorFuelCell
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...

Additional Inherited Members
Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl	ImplType
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

GeneratorFuelCell is a Generator that wraps the OpenStudio IDD object 'OS:Generator:FuelCell'.

Constructor & Destructor Documentation

openstudio::model::GeneratorFuelCell::GeneratorFuelCell ( const Model &  model, const GeneratorFuelCellPowerModule &  fCPM, const GeneratorFuelCellAirSupply &  fCAS, const GeneratorFuelCellWaterSupply &  fCWS, const GeneratorFuelCellAuxiliaryHeater &  fCAH, const GeneratorFuelCellExhaustGasToWaterHeatExchanger &  fCExhaustHX, const GeneratorFuelCellElectricalStorage &  fCES, const GeneratorFuelCellInverter &  fCInverter, const GeneratorFuelSupply &  fS  )

explicit

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

explicit

virtual openstudio::model::GeneratorFuelCell::~GeneratorFuelCell ( )

inlinevirtual

Member Function Documentation

GeneratorFuelCellAirSupply openstudio::model::GeneratorFuelCell::airSupply

(

)

const

GeneratorFuelCellAuxiliaryHeater openstudio::model::GeneratorFuelCell::auxiliaryHeater

(

)

const

GeneratorFuelCellElectricalStorage openstudio::model::GeneratorFuelCell::electricalStorage

(

)

const

GeneratorFuelSupply openstudio::model::GeneratorFuelCell::fuelSupply

(

)

const

GeneratorFuelCellExhaustGasToWaterHeatExchanger openstudio::model::GeneratorFuelCell::heatExchanger

(

)

const

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

static

GeneratorFuelCellInverter openstudio::model::GeneratorFuelCell::inverter

(

)

const

GeneratorFuelCellPowerModule openstudio::model::GeneratorFuelCell::powerModule

(

)

const

void openstudio::model::GeneratorFuelCell::resetStackCooler

(

)

bool openstudio::model::GeneratorFuelCell::setAirSupply

(

const GeneratorFuelCellAirSupply &

fCAirSup

)

bool openstudio::model::GeneratorFuelCell::setAuxiliaryHeater

(

const GeneratorFuelCellAuxiliaryHeater &

fCAuxHeat

)

bool openstudio::model::GeneratorFuelCell::setElectricalStorage

(

const GeneratorFuelCellElectricalStorage &

fCStorage

)

bool openstudio::model::GeneratorFuelCell::setFuelSupply

(

const GeneratorFuelSupply &

genFuelSup

)

bool openstudio::model::GeneratorFuelCell::setHeatExchanger

(

const GeneratorFuelCellExhaustGasToWaterHeatExchanger &

fCExhaustHX

)

bool openstudio::model::GeneratorFuelCell::setInverter

(

const GeneratorFuelCellInverter &

fCInverter

)

bool openstudio::model::GeneratorFuelCell::setPowerModule

(

const GeneratorFuelCellPowerModule &

fCPM

)

bool openstudio::model::GeneratorFuelCell::setStackCooler

(

const GeneratorFuelCellStackCooler &

fCStackCooler

)

bool openstudio::model::GeneratorFuelCell::setWaterSupply

(

const GeneratorFuelCellWaterSupply &

fCWaterSup

)

boost::optional<GeneratorFuelCellStackCooler> openstudio::model::GeneratorFuelCell::stackCooler

(

)

const

GeneratorFuelCellWaterSupply openstudio::model::GeneratorFuelCell::waterSupply

(

)

const

Friends And Related Function Documentation

typedef std::vector<GeneratorFuelCell> GeneratorFuelCellVector

related

typedef boost::optional<GeneratorFuelCell> OptionalGeneratorFuelCell

related