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

#include <GeneratorMicroTurbine.hpp>

+ Inheritance diagram for openstudio::model::GeneratorMicroTurbine:

Public Member Functions

Constructors and Destructors
 GeneratorMicroTurbine (const Model &model)
 
virtual ~GeneratorMicroTurbine ()=default
 
 GeneratorMicroTurbine (const GeneratorMicroTurbine &other)=default
 
 GeneratorMicroTurbine (GeneratorMicroTurbine &&other)=default
 
GeneratorMicroTurbineoperator= (const GeneratorMicroTurbine &)=default
 
GeneratorMicroTurbineoperator= (GeneratorMicroTurbine &&)=default
 
virtual boost::optional< double > ratedThermaltoElectricalPowerRatio () const
 
Getters
boost::optional< ScheduleavailabilitySchedule () const
 
double referenceElectricalPowerOutput () const
 
double minimumFullLoadElectricalPowerOutput () const
 
bool isMinimumFullLoadElectricalPowerOutputDefaulted () const
 
double maximumFullLoadElectricalPowerOutput () const
 
bool isMaximumFullLoadElectricalPowerOutputDefaulted () const
 
double referenceElectricalEfficiencyUsingLowerHeatingValue () const
 
double referenceCombustionAirInletTemperature () const
 
bool isReferenceCombustionAirInletTemperatureDefaulted () const
 
double referenceCombustionAirInletHumidityRatio () const
 
bool isReferenceCombustionAirInletHumidityRatioDefaulted () const
 
double referenceElevation () const
 
bool isReferenceElevationDefaulted () const
 
Curve electricalPowerFunctionofTemperatureandElevationCurve () const
 
Curve electricalEfficiencyFunctionofTemperatureCurve () const
 
Curve electricalEfficiencyFunctionofPartLoadRatioCurve () const
 
std::string fuelType () const
 
bool isFuelTypeDefaulted () const
 
double fuelHigherHeatingValue () const
 
bool isFuelHigherHeatingValueDefaulted () const
 
double fuelLowerHeatingValue () const
 
bool isFuelLowerHeatingValueDefaulted () const
 
double standbyPower () const
 
bool isStandbyPowerDefaulted () const
 
double ancillaryPower () const
 
bool isAncillaryPowerDefaulted () const
 
boost::optional< CurveancillaryPowerFunctionofFuelInputCurve () const
 
boost::optional
< GeneratorMicroTurbineHeatRecovery
generatorMicroTurbineHeatRecovery () const
 
boost::optional< double > referenceExhaustAirMassFlowRate () const
 
boost::optional< CurveexhaustAirFlowRateFunctionofTemperatureCurve () const
 
boost::optional< CurveexhaustAirFlowRateFunctionofPartLoadRatioCurve () const
 
boost::optional< double > nominalExhaustAirOutletTemperature () const
 
boost::optional< CurveexhaustAirTemperatureFunctionofTemperatureCurve () const
 
boost::optional< CurveexhaustAirTemperatureFunctionofPartLoadRatioCurve () const
 
Setters
bool setAvailabilitySchedule (Schedule &schedule)
 
void resetAvailabilitySchedule ()
 
bool setReferenceElectricalPowerOutput (double referenceElectricalPowerOutput)
 
bool setMinimumFullLoadElectricalPowerOutput (double minimumFullLoadElectricalPowerOutput)
 
void resetMinimumFullLoadElectricalPowerOutput ()
 
bool setMaximumFullLoadElectricalPowerOutput (double maximumFullLoadElectricalPowerOutput)
 
void resetMaximumFullLoadElectricalPowerOutput ()
 
bool setReferenceElectricalEfficiencyUsingLowerHeatingValue (double referenceElectricalEfficiencyUsingLowerHeatingValue)
 
bool setReferenceCombustionAirInletTemperature (double referenceCombustionAirInletTemperature)
 
void resetReferenceCombustionAirInletTemperature ()
 
bool setReferenceCombustionAirInletHumidityRatio (double referenceCombustionAirInletHumidityRatio)
 
void resetReferenceCombustionAirInletHumidityRatio ()
 
bool setReferenceElevation (double referenceElevation)
 
void resetReferenceElevation ()
 
bool setElectricalPowerFunctionofTemperatureandElevationCurve (const Curve &electricalPowerFunctionofTemperatureandElevationCurve)
 
bool setElectricalEfficiencyFunctionofTemperatureCurve (const Curve &electricalEfficiencyFunctionofTemperatureCurve)
 
bool setElectricalEfficiencyFunctionofPartLoadRatioCurve (const Curve &electricalEfficiencyFunctionofPartLoadRatioCurve)
 
bool setFuelType (const std::string &fuelType)
 
void resetFuelType ()
 
bool setFuelHigherHeatingValue (double fuelHigherHeatingValue)
 
void resetFuelHigherHeatingValue ()
 
bool setFuelLowerHeatingValue (double fuelLowerHeatingValue)
 
void resetFuelLowerHeatingValue ()
 
bool setStandbyPower (double standbyPower)
 
void resetStandbyPower ()
 
bool setAncillaryPower (double ancillaryPower)
 
void resetAncillaryPower ()
 
bool setAncillaryPowerFunctionofFuelInputCurve (const Curve &ancillaryPowerFunctionofFuelInputCurve)
 
void resetAncillaryPowerFunctionofFuelInputCurve ()
 
bool setReferenceExhaustAirMassFlowRate (double referenceExhaustAirMassFlowRate)
 
void resetReferenceExhaustAirMassFlowRate ()
 
bool setExhaustAirFlowRateFunctionofTemperatureCurve (const Curve &exhaustAirFlowRateFunctionofTemperatureCurve)
 
void resetExhaustAirFlowRateFunctionofTemperatureCurve ()
 
bool setExhaustAirFlowRateFunctionofPartLoadRatioCurve (const Curve &exhaustAirFlowRateFunctionofPartLoadRatioCurve)
 
void resetExhaustAirFlowRateFunctionofPartLoadRatioCurve ()
 
bool setNominalExhaustAirOutletTemperature (double nominalExhaustAirOutletTemperature)
 
void resetNominalExhaustAirOutletTemperature ()
 
bool setExhaustAirTemperatureFunctionofTemperatureCurve (const Curve &exhaustAirTemperatureFunctionofTemperatureCurve)
 
void resetExhaustAirTemperatureFunctionofTemperatureCurve ()
 
bool setExhaustAirTemperatureFunctionofPartLoadRatioCurve (const Curve &exhaustAirTemperatureFunctionofPartLoadRatioCurve)
 
void resetExhaustAirTemperatureFunctionofPartLoadRatioCurve ()
 
- Public Member Functions inherited from openstudio::model::Generator
boost::optional< ScheduleavailabilitySchedule () const
 
boost::optional
< ElectricLoadCenterDistribution
electricLoadCenterDistribution () const
 
 Generator (IddObjectType type, const Model &model)
 
 Generator (const Generator &other)=default
 
 Generator (Generator &&other)=default
 
std::string generatorObjectType () const
 
Generatoroperator= (const Generator &)=default
 
Generatoroperator= (Generator &&)=default
 
boost::optional< double > ratedElectricPowerOutput () const
 
boost::optional< double > ratedThermaltoElectricalPowerRatio () const
 
virtual ~Generator ()=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< 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< 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
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 
static std::vector< std::string > validFuelTypeValues ()
 

Related Functions

(Note that these are not member functions.)

using GeneratorMicroTurbineVector = std::vector< GeneratorMicroTurbine >
 
using OptionalGeneratorMicroTurbine = boost::optional< GeneratorMicroTurbine >
 

Additional Inherited Members

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

GeneratorMicroTurbine is a Generator that wraps the OpenStudio IDD object 'OS:Generator:MicroTurbine'.

Constructor & Destructor Documentation

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

Member Function Documentation

double openstudio::model::GeneratorMicroTurbine::ancillaryPower ( ) const
boost::optional<Curve> openstudio::model::GeneratorMicroTurbine::ancillaryPowerFunctionofFuelInputCurve ( ) const
boost::optional<Schedule> openstudio::model::GeneratorMicroTurbine::availabilitySchedule ( ) const
Curve openstudio::model::GeneratorMicroTurbine::electricalEfficiencyFunctionofPartLoadRatioCurve ( ) const
Curve openstudio::model::GeneratorMicroTurbine::electricalEfficiencyFunctionofTemperatureCurve ( ) const
Curve openstudio::model::GeneratorMicroTurbine::electricalPowerFunctionofTemperatureandElevationCurve ( ) const
boost::optional<Curve> openstudio::model::GeneratorMicroTurbine::exhaustAirFlowRateFunctionofPartLoadRatioCurve ( ) const
boost::optional<Curve> openstudio::model::GeneratorMicroTurbine::exhaustAirFlowRateFunctionofTemperatureCurve ( ) const
boost::optional<Curve> openstudio::model::GeneratorMicroTurbine::exhaustAirTemperatureFunctionofPartLoadRatioCurve ( ) const
boost::optional<Curve> openstudio::model::GeneratorMicroTurbine::exhaustAirTemperatureFunctionofTemperatureCurve ( ) const
double openstudio::model::GeneratorMicroTurbine::fuelHigherHeatingValue ( ) const
double openstudio::model::GeneratorMicroTurbine::fuelLowerHeatingValue ( ) const
std::string openstudio::model::GeneratorMicroTurbine::fuelType ( ) const
boost::optional<GeneratorMicroTurbineHeatRecovery> openstudio::model::GeneratorMicroTurbine::generatorMicroTurbineHeatRecovery ( ) const
static IddObjectType openstudio::model::GeneratorMicroTurbine::iddObjectType ( )
static
bool openstudio::model::GeneratorMicroTurbine::isAncillaryPowerDefaulted ( ) const
bool openstudio::model::GeneratorMicroTurbine::isFuelHigherHeatingValueDefaulted ( ) const
bool openstudio::model::GeneratorMicroTurbine::isFuelLowerHeatingValueDefaulted ( ) const
bool openstudio::model::GeneratorMicroTurbine::isFuelTypeDefaulted ( ) const
bool openstudio::model::GeneratorMicroTurbine::isMaximumFullLoadElectricalPowerOutputDefaulted ( ) const
bool openstudio::model::GeneratorMicroTurbine::isMinimumFullLoadElectricalPowerOutputDefaulted ( ) const
bool openstudio::model::GeneratorMicroTurbine::isReferenceCombustionAirInletHumidityRatioDefaulted ( ) const
bool openstudio::model::GeneratorMicroTurbine::isReferenceCombustionAirInletTemperatureDefaulted ( ) const
bool openstudio::model::GeneratorMicroTurbine::isReferenceElevationDefaulted ( ) const
bool openstudio::model::GeneratorMicroTurbine::isStandbyPowerDefaulted ( ) const
double openstudio::model::GeneratorMicroTurbine::maximumFullLoadElectricalPowerOutput ( ) const
double openstudio::model::GeneratorMicroTurbine::minimumFullLoadElectricalPowerOutput ( ) const
boost::optional<double> openstudio::model::GeneratorMicroTurbine::nominalExhaustAirOutletTemperature ( ) const
GeneratorMicroTurbine& openstudio::model::GeneratorMicroTurbine::operator= ( const GeneratorMicroTurbine )
default
GeneratorMicroTurbine& openstudio::model::GeneratorMicroTurbine::operator= ( GeneratorMicroTurbine &&  )
default
virtual boost::optional<double> openstudio::model::GeneratorMicroTurbine::ratedThermaltoElectricalPowerRatio ( ) const
virtual
double openstudio::model::GeneratorMicroTurbine::referenceCombustionAirInletHumidityRatio ( ) const
double openstudio::model::GeneratorMicroTurbine::referenceCombustionAirInletTemperature ( ) const
double openstudio::model::GeneratorMicroTurbine::referenceElectricalEfficiencyUsingLowerHeatingValue ( ) const
double openstudio::model::GeneratorMicroTurbine::referenceElectricalPowerOutput ( ) const
double openstudio::model::GeneratorMicroTurbine::referenceElevation ( ) const
boost::optional<double> openstudio::model::GeneratorMicroTurbine::referenceExhaustAirMassFlowRate ( ) const
void openstudio::model::GeneratorMicroTurbine::resetAncillaryPower ( )
void openstudio::model::GeneratorMicroTurbine::resetAncillaryPowerFunctionofFuelInputCurve ( )
void openstudio::model::GeneratorMicroTurbine::resetAvailabilitySchedule ( )
void openstudio::model::GeneratorMicroTurbine::resetExhaustAirFlowRateFunctionofPartLoadRatioCurve ( )
void openstudio::model::GeneratorMicroTurbine::resetExhaustAirFlowRateFunctionofTemperatureCurve ( )
void openstudio::model::GeneratorMicroTurbine::resetExhaustAirTemperatureFunctionofPartLoadRatioCurve ( )
void openstudio::model::GeneratorMicroTurbine::resetExhaustAirTemperatureFunctionofTemperatureCurve ( )
void openstudio::model::GeneratorMicroTurbine::resetFuelHigherHeatingValue ( )
void openstudio::model::GeneratorMicroTurbine::resetFuelLowerHeatingValue ( )
void openstudio::model::GeneratorMicroTurbine::resetFuelType ( )
void openstudio::model::GeneratorMicroTurbine::resetMaximumFullLoadElectricalPowerOutput ( )
void openstudio::model::GeneratorMicroTurbine::resetMinimumFullLoadElectricalPowerOutput ( )
void openstudio::model::GeneratorMicroTurbine::resetNominalExhaustAirOutletTemperature ( )
void openstudio::model::GeneratorMicroTurbine::resetReferenceCombustionAirInletHumidityRatio ( )
void openstudio::model::GeneratorMicroTurbine::resetReferenceCombustionAirInletTemperature ( )
void openstudio::model::GeneratorMicroTurbine::resetReferenceElevation ( )
void openstudio::model::GeneratorMicroTurbine::resetReferenceExhaustAirMassFlowRate ( )
void openstudio::model::GeneratorMicroTurbine::resetStandbyPower ( )
bool openstudio::model::GeneratorMicroTurbine::setAncillaryPower ( double  ancillaryPower)
bool openstudio::model::GeneratorMicroTurbine::setAncillaryPowerFunctionofFuelInputCurve ( const Curve ancillaryPowerFunctionofFuelInputCurve)
bool openstudio::model::GeneratorMicroTurbine::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::GeneratorMicroTurbine::setElectricalEfficiencyFunctionofPartLoadRatioCurve ( const Curve electricalEfficiencyFunctionofPartLoadRatioCurve)
bool openstudio::model::GeneratorMicroTurbine::setElectricalEfficiencyFunctionofTemperatureCurve ( const Curve electricalEfficiencyFunctionofTemperatureCurve)
bool openstudio::model::GeneratorMicroTurbine::setElectricalPowerFunctionofTemperatureandElevationCurve ( const Curve electricalPowerFunctionofTemperatureandElevationCurve)
bool openstudio::model::GeneratorMicroTurbine::setExhaustAirFlowRateFunctionofPartLoadRatioCurve ( const Curve exhaustAirFlowRateFunctionofPartLoadRatioCurve)
bool openstudio::model::GeneratorMicroTurbine::setExhaustAirFlowRateFunctionofTemperatureCurve ( const Curve exhaustAirFlowRateFunctionofTemperatureCurve)
bool openstudio::model::GeneratorMicroTurbine::setExhaustAirTemperatureFunctionofPartLoadRatioCurve ( const Curve exhaustAirTemperatureFunctionofPartLoadRatioCurve)
bool openstudio::model::GeneratorMicroTurbine::setExhaustAirTemperatureFunctionofTemperatureCurve ( const Curve exhaustAirTemperatureFunctionofTemperatureCurve)
bool openstudio::model::GeneratorMicroTurbine::setFuelHigherHeatingValue ( double  fuelHigherHeatingValue)
bool openstudio::model::GeneratorMicroTurbine::setFuelLowerHeatingValue ( double  fuelLowerHeatingValue)
bool openstudio::model::GeneratorMicroTurbine::setFuelType ( const std::string &  fuelType)
bool openstudio::model::GeneratorMicroTurbine::setMaximumFullLoadElectricalPowerOutput ( double  maximumFullLoadElectricalPowerOutput)
bool openstudio::model::GeneratorMicroTurbine::setMinimumFullLoadElectricalPowerOutput ( double  minimumFullLoadElectricalPowerOutput)
bool openstudio::model::GeneratorMicroTurbine::setNominalExhaustAirOutletTemperature ( double  nominalExhaustAirOutletTemperature)
bool openstudio::model::GeneratorMicroTurbine::setReferenceCombustionAirInletHumidityRatio ( double  referenceCombustionAirInletHumidityRatio)
bool openstudio::model::GeneratorMicroTurbine::setReferenceCombustionAirInletTemperature ( double  referenceCombustionAirInletTemperature)
bool openstudio::model::GeneratorMicroTurbine::setReferenceElectricalEfficiencyUsingLowerHeatingValue ( double  referenceElectricalEfficiencyUsingLowerHeatingValue)
bool openstudio::model::GeneratorMicroTurbine::setReferenceElectricalPowerOutput ( double  referenceElectricalPowerOutput)
bool openstudio::model::GeneratorMicroTurbine::setReferenceElevation ( double  referenceElevation)
bool openstudio::model::GeneratorMicroTurbine::setReferenceExhaustAirMassFlowRate ( double  referenceExhaustAirMassFlowRate)
bool openstudio::model::GeneratorMicroTurbine::setStandbyPower ( double  standbyPower)
double openstudio::model::GeneratorMicroTurbine::standbyPower ( ) const
static std::vector<std::string> openstudio::model::GeneratorMicroTurbine::validFuelTypeValues ( )
static

Friends And Related Function Documentation

using GeneratorMicroTurbineVector = std::vector<GeneratorMicroTurbine>
related
using OptionalGeneratorMicroTurbine = boost::optional<GeneratorMicroTurbine>
related