openstudio::model::GeneratorFuelSupply Class Reference

#include <GeneratorFuelSupply.hpp>

Inheritance diagram for openstudio::model::GeneratorFuelSupply:

Public Member Functions
bool	addConstituent (const FuelSupplyConstituent &constituent)
bool	addConstituent (const std::string &name, double molarFraction)
std::vector < FuelSupplyConstituent >	constituents () const
void	removeAllConstituents ()
void	removeConstituent (int groupIndex)
Constructors and Destructors
	GeneratorFuelSupply (const Model &model)
	GeneratorFuelSupply (const Model &model, Schedule &tempSchedule, const CurveCubic &powerCurve)
virtual	~GeneratorFuelSupply ()=default
	GeneratorFuelSupply (const GeneratorFuelSupply &other)=default
	GeneratorFuelSupply (GeneratorFuelSupply &&other)=default
GeneratorFuelSupply &	operator= (const GeneratorFuelSupply &)=default
GeneratorFuelSupply &	operator= (GeneratorFuelSupply &&)=default
Getters
std::string	fuelTemperatureModelingMode () const
boost::optional< Node >	fuelTemperatureReferenceNode () const
boost::optional< Schedule >	fuelTemperatureSchedule () const
CurveCubic	compressorPowerMultiplierFunctionofFuelRateCurve () const
double	compressorHeatLossFactor () const
std::string	fuelType () const
boost::optional< double >	liquidGenericFuelLowerHeatingValue () const
boost::optional< double >	liquidGenericFuelHigherHeatingValue () const
boost::optional< double >	liquidGenericFuelMolecularWeight () const
boost::optional< double >	liquidGenericFuelCO2EmissionFactor () const
boost::optional< unsigned int >	numberofConstituentsinGaseousConstituentFuelSupply () const
double	sumofConstituentsMolarFractions () const
boost::optional < GeneratorFuelCell >	fuelCell () const
Setters
bool	setFuelTemperatureModelingMode (const std::string &fuelTemperatureModelingMode)
void	resetFuelTemperatureModelingMode ()
bool	setFuelTemperatureReferenceNode (const Node &connection)
void	resetFuelTemperatureReferenceNode ()
bool	setFuelTemperatureSchedule (Schedule &schedule)
void	resetFuelTemperatureSchedule ()
bool	setCompressorPowerMultiplierFunctionofFuelRateCurve (const CurveCubic &cubicCurves)
bool	setCompressorHeatLossFactor (double compressorHeatLossFactor)
void	resetCompressorHeatLossFactor ()
bool	setFuelType (const std::string &fuelType)
void	resetFuelType ()
bool	setLiquidGenericFuelLowerHeatingValue (double liquidGenericFuelLowerHeatingValue)
void	resetLiquidGenericFuelLowerHeatingValue ()
bool	setLiquidGenericFuelHigherHeatingValue (double liquidGenericFuelHigherHeatingValue)
void	resetLiquidGenericFuelHigherHeatingValue ()
bool	setLiquidGenericFuelMolecularWeight (double liquidGenericFuelMolecularWeight)
void	resetLiquidGenericFuelMolecularWeight ()
bool	setLiquidGenericFuelCO2EmissionFactor (double liquidGenericFuelCO2EmissionFactor)
void	resetLiquidGenericFuelCO2EmissionFactor ()
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 std::vector< std::string >	fuelTemperatureModelingModeValues ()
static std::vector< std::string >	fuelTypeValues ()
static IddObjectType	iddObjectType ()

Related Functions
(Note that these are not member functions.)
using	GeneratorFuelSupplyVector = std::vector< GeneratorFuelSupply >
using	OptionalGeneratorFuelSupply = boost::optional< GeneratorFuelSupply >
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
using	ImplType = detail::ModelObject_Impl
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

GeneratorFuelSupply is a ModelObject that wraps the OpenStudio IDD object 'OS:Generator:FuelSupply'.

Constructor & Destructor Documentation

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

explicit

openstudio::model::GeneratorFuelSupply::GeneratorFuelSupply ( const Model &  model, Schedule &  tempSchedule, const CurveCubic &  powerCurve  )

explicit

virtual openstudio::model::GeneratorFuelSupply::~GeneratorFuelSupply ( )

virtualdefault

openstudio::model::GeneratorFuelSupply::GeneratorFuelSupply ( const GeneratorFuelSupply &  other )

default

openstudio::model::GeneratorFuelSupply::GeneratorFuelSupply ( GeneratorFuelSupply &&  other )

default

Member Function Documentation

bool openstudio::model::GeneratorFuelSupply::addConstituent

(

const FuelSupplyConstituent &

constituent

)

bool openstudio::model::GeneratorFuelSupply::addConstituent	(	const std::string &	name,
		double	molarFraction
	)

double openstudio::model::GeneratorFuelSupply::compressorHeatLossFactor

(

)

const

CurveCubic openstudio::model::GeneratorFuelSupply::compressorPowerMultiplierFunctionofFuelRateCurve

(

)

const

std::vector<FuelSupplyConstituent> openstudio::model::GeneratorFuelSupply::constituents

(

)

const

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

(

)

const

std::string openstudio::model::GeneratorFuelSupply::fuelTemperatureModelingMode

(

)

const

static std::vector<std::string> openstudio::model::GeneratorFuelSupply::fuelTemperatureModelingModeValues ( )

static

boost::optional<Node> openstudio::model::GeneratorFuelSupply::fuelTemperatureReferenceNode

(

)

const

boost::optional<Schedule> openstudio::model::GeneratorFuelSupply::fuelTemperatureSchedule

(

)

const

std::string openstudio::model::GeneratorFuelSupply::fuelType

(

)

const

static std::vector<std::string> openstudio::model::GeneratorFuelSupply::fuelTypeValues ( )

static

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

static

boost::optional<double> openstudio::model::GeneratorFuelSupply::liquidGenericFuelCO2EmissionFactor

(

)

const

boost::optional<double> openstudio::model::GeneratorFuelSupply::liquidGenericFuelHigherHeatingValue

(

)

const

boost::optional<double> openstudio::model::GeneratorFuelSupply::liquidGenericFuelLowerHeatingValue

(

)

const

boost::optional<double> openstudio::model::GeneratorFuelSupply::liquidGenericFuelMolecularWeight

(

)

const

boost::optional<unsigned int> openstudio::model::GeneratorFuelSupply::numberofConstituentsinGaseousConstituentFuelSupply

(

)

const

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

default

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

default

void openstudio::model::GeneratorFuelSupply::removeAllConstituents

(

)

void openstudio::model::GeneratorFuelSupply::removeConstituent

(

int

groupIndex

)

void openstudio::model::GeneratorFuelSupply::resetCompressorHeatLossFactor

(

)

void openstudio::model::GeneratorFuelSupply::resetFuelTemperatureModelingMode

(

)

void openstudio::model::GeneratorFuelSupply::resetFuelTemperatureReferenceNode

(

)

void openstudio::model::GeneratorFuelSupply::resetFuelTemperatureSchedule

(

)

void openstudio::model::GeneratorFuelSupply::resetFuelType

(

)

void openstudio::model::GeneratorFuelSupply::resetLiquidGenericFuelCO2EmissionFactor

(

)

void openstudio::model::GeneratorFuelSupply::resetLiquidGenericFuelHigherHeatingValue

(

)

void openstudio::model::GeneratorFuelSupply::resetLiquidGenericFuelLowerHeatingValue

(

)

void openstudio::model::GeneratorFuelSupply::resetLiquidGenericFuelMolecularWeight

(

)

bool openstudio::model::GeneratorFuelSupply::setCompressorHeatLossFactor

(

double

compressorHeatLossFactor

)

bool openstudio::model::GeneratorFuelSupply::setCompressorPowerMultiplierFunctionofFuelRateCurve

(

const CurveCubic &

cubicCurves

)

bool openstudio::model::GeneratorFuelSupply::setFuelTemperatureModelingMode

(

const std::string &

fuelTemperatureModelingMode

)

bool openstudio::model::GeneratorFuelSupply::setFuelTemperatureReferenceNode

(

const Node &

connection

)

bool openstudio::model::GeneratorFuelSupply::setFuelTemperatureSchedule

(

Schedule &

schedule

)

bool openstudio::model::GeneratorFuelSupply::setFuelType

(

const std::string &

fuelType

)

bool openstudio::model::GeneratorFuelSupply::setLiquidGenericFuelCO2EmissionFactor

(

double

liquidGenericFuelCO2EmissionFactor

)

bool openstudio::model::GeneratorFuelSupply::setLiquidGenericFuelHigherHeatingValue

(

double

liquidGenericFuelHigherHeatingValue

)

bool openstudio::model::GeneratorFuelSupply::setLiquidGenericFuelLowerHeatingValue

(

double

liquidGenericFuelLowerHeatingValue

)

bool openstudio::model::GeneratorFuelSupply::setLiquidGenericFuelMolecularWeight

(

double

liquidGenericFuelMolecularWeight

)

double openstudio::model::GeneratorFuelSupply::sumofConstituentsMolarFractions

(

)

const

Friends And Related Function Documentation

using GeneratorFuelSupplyVector = std::vector<GeneratorFuelSupply>

related

using OptionalGeneratorFuelSupply = boost::optional<GeneratorFuelSupply>

related