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

#include <FuelFactors.hpp>

+ Inheritance diagram for openstudio::model::FuelFactors:

Public Member Functions

Constructors and Destructors
 FuelFactors (const Model &model)
 
virtual ~FuelFactors ()
 
Getters
std::string existingFuelResourceName () const
 
double sourceEnergyFactor () const
 
boost::optional< SchedulesourceEnergySchedule () const
 
double cO2EmissionFactor () const
 
boost::optional< SchedulecO2EmissionFactorSchedule () const
 
double cOEmissionFactor () const
 
boost::optional< SchedulecOEmissionFactorSchedule () const
 
double cH4EmissionFactor () const
 
boost::optional< SchedulecH4EmissionFactorSchedule () const
 
double nOxEmissionFactor () const
 
boost::optional< SchedulenOxEmissionFactorSchedule () const
 
double n2OEmissionFactor () const
 
boost::optional< Schedulen2OEmissionFactorSchedule () const
 
double sO2EmissionFactor () const
 
boost::optional< SchedulesO2EmissionFactorSchedule () const
 
double pMEmissionFactor () const
 
boost::optional< SchedulepMEmissionFactorSchedule () const
 
double pM10EmissionFactor () const
 
boost::optional< SchedulepM10EmissionFactorSchedule () const
 
double pM25EmissionFactor () const
 
boost::optional< SchedulepM25EmissionFactorSchedule () const
 
double nH3EmissionFactor () const
 
boost::optional< SchedulenH3EmissionFactorSchedule () const
 
double nMVOCEmissionFactor () const
 
boost::optional< SchedulenMVOCEmissionFactorSchedule () const
 
double hgEmissionFactor () const
 
boost::optional< SchedulehgEmissionFactorSchedule () const
 
double pbEmissionFactor () const
 
boost::optional< SchedulepbEmissionFactorSchedule () const
 
double waterEmissionFactor () const
 
boost::optional< SchedulewaterEmissionFactorSchedule () const
 
double nuclearHighLevelEmissionFactor () const
 
boost::optional< SchedulenuclearHighLevelEmissionFactorSchedule () const
 
double nuclearLowLevelEmissionFactor () const
 
boost::optional< SchedulenuclearLowLevelEmissionFactorSchedule () const
 
Setters
bool setExistingFuelResourceName (const std::string &existingFuelResourceName)
 
bool setSourceEnergyFactor (double sourceEnergyFactor)
 
bool setSourceEnergySchedule (Schedule &schedule)
 
void resetSourceEnergySchedule ()
 
bool setCO2EmissionFactor (double cO2EmissionFactor)
 
bool setCO2EmissionFactorSchedule (Schedule &schedule)
 
void resetCO2EmissionFactorSchedule ()
 
bool setCOEmissionFactor (double cOEmissionFactor)
 
bool setCOEmissionFactorSchedule (Schedule &schedule)
 
void resetCOEmissionFactorSchedule ()
 
bool setCH4EmissionFactor (double cH4EmissionFactor)
 
bool setCH4EmissionFactorSchedule (Schedule &schedule)
 
void resetCH4EmissionFactorSchedule ()
 
bool setNOxEmissionFactor (double nOxEmissionFactor)
 
bool setNOxEmissionFactorSchedule (Schedule &schedule)
 
void resetNOxEmissionFactorSchedule ()
 
bool setN2OEmissionFactor (double n2OEmissionFactor)
 
bool setN2OEmissionFactorSchedule (Schedule &schedule)
 
void resetN2OEmissionFactorSchedule ()
 
bool setSO2EmissionFactor (double sO2EmissionFactor)
 
bool setSO2EmissionFactorSchedule (Schedule &schedule)
 
void resetSO2EmissionFactorSchedule ()
 
bool setPMEmissionFactor (double pMEmissionFactor)
 
bool setPMEmissionFactorSchedule (Schedule &schedule)
 
void resetPMEmissionFactorSchedule ()
 
bool setPM10EmissionFactor (double pM10EmissionFactor)
 
bool setPM10EmissionFactorSchedule (Schedule &schedule)
 
void resetPM10EmissionFactorSchedule ()
 
bool setPM25EmissionFactor (double pM25EmissionFactor)
 
bool setPM25EmissionFactorSchedule (Schedule &schedule)
 
void resetPM25EmissionFactorSchedule ()
 
bool setNH3EmissionFactor (double nH3EmissionFactor)
 
bool setNH3EmissionFactorSchedule (Schedule &schedule)
 
void resetNH3EmissionFactorSchedule ()
 
bool setNMVOCEmissionFactor (double nMVOCEmissionFactor)
 
bool setNMVOCEmissionFactorSchedule (Schedule &schedule)
 
void resetNMVOCEmissionFactorSchedule ()
 
bool setHgEmissionFactor (double hgEmissionFactor)
 
bool setHgEmissionFactorSchedule (Schedule &schedule)
 
void resetHgEmissionFactorSchedule ()
 
bool setPbEmissionFactor (double pbEmissionFactor)
 
bool setPbEmissionFactorSchedule (Schedule &schedule)
 
void resetPbEmissionFactorSchedule ()
 
bool setWaterEmissionFactor (double waterEmissionFactor)
 
bool setWaterEmissionFactorSchedule (Schedule &schedule)
 
void resetWaterEmissionFactorSchedule ()
 
bool setNuclearHighLevelEmissionFactor (double nuclearHighLevelEmissionFactor)
 
bool setNuclearHighLevelEmissionFactorSchedule (Schedule &schedule)
 
void resetNuclearHighLevelEmissionFactorSchedule ()
 
bool setNuclearLowLevelEmissionFactor (double nuclearLowLevelEmissionFactor)
 
bool setNuclearLowLevelEmissionFactorSchedule (Schedule &schedule)
 
void resetNuclearLowLevelEmissionFactorSchedule ()
 
- 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< 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 (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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Static Public Member Functions

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

Related Functions

(Note that these are not member functions.)

typedef std::vector< FuelFactorsFuelFactorsVector
 
typedef boost::optional
< FuelFactors
OptionalFuelFactors
 

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

FuelFactors is a ModelObject that wraps the OpenStudio IDD object 'OS:FuelFactors'.

Constructor & Destructor Documentation

openstudio::model::FuelFactors::FuelFactors ( const Model model)
explicit
virtual openstudio::model::FuelFactors::~FuelFactors ( )
inlinevirtual

Member Function Documentation

double openstudio::model::FuelFactors::cH4EmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::cH4EmissionFactorSchedule ( ) const
double openstudio::model::FuelFactors::cO2EmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::cO2EmissionFactorSchedule ( ) const
double openstudio::model::FuelFactors::cOEmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::cOEmissionFactorSchedule ( ) const
std::string openstudio::model::FuelFactors::existingFuelResourceName ( ) const
static std::vector<std::string> openstudio::model::FuelFactors::existingFuelResourceNameValues ( )
static
double openstudio::model::FuelFactors::hgEmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::hgEmissionFactorSchedule ( ) const
static IddObjectType openstudio::model::FuelFactors::iddObjectType ( )
static
double openstudio::model::FuelFactors::n2OEmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::n2OEmissionFactorSchedule ( ) const
double openstudio::model::FuelFactors::nH3EmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::nH3EmissionFactorSchedule ( ) const
double openstudio::model::FuelFactors::nMVOCEmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::nMVOCEmissionFactorSchedule ( ) const
double openstudio::model::FuelFactors::nOxEmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::nOxEmissionFactorSchedule ( ) const
double openstudio::model::FuelFactors::nuclearHighLevelEmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::nuclearHighLevelEmissionFactorSchedule ( ) const
double openstudio::model::FuelFactors::nuclearLowLevelEmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::nuclearLowLevelEmissionFactorSchedule ( ) const
double openstudio::model::FuelFactors::pbEmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::pbEmissionFactorSchedule ( ) const
double openstudio::model::FuelFactors::pM10EmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::pM10EmissionFactorSchedule ( ) const
double openstudio::model::FuelFactors::pM25EmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::pM25EmissionFactorSchedule ( ) const
double openstudio::model::FuelFactors::pMEmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::pMEmissionFactorSchedule ( ) const
void openstudio::model::FuelFactors::resetCH4EmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetCO2EmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetCOEmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetHgEmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetN2OEmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetNH3EmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetNMVOCEmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetNOxEmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetNuclearHighLevelEmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetNuclearLowLevelEmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetPbEmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetPM10EmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetPM25EmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetPMEmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetSO2EmissionFactorSchedule ( )
void openstudio::model::FuelFactors::resetSourceEnergySchedule ( )
void openstudio::model::FuelFactors::resetWaterEmissionFactorSchedule ( )
bool openstudio::model::FuelFactors::setCH4EmissionFactor ( double  cH4EmissionFactor)
bool openstudio::model::FuelFactors::setCH4EmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setCO2EmissionFactor ( double  cO2EmissionFactor)
bool openstudio::model::FuelFactors::setCO2EmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setCOEmissionFactor ( double  cOEmissionFactor)
bool openstudio::model::FuelFactors::setCOEmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setExistingFuelResourceName ( const std::string &  existingFuelResourceName)
bool openstudio::model::FuelFactors::setHgEmissionFactor ( double  hgEmissionFactor)
bool openstudio::model::FuelFactors::setHgEmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setN2OEmissionFactor ( double  n2OEmissionFactor)
bool openstudio::model::FuelFactors::setN2OEmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setNH3EmissionFactor ( double  nH3EmissionFactor)
bool openstudio::model::FuelFactors::setNH3EmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setNMVOCEmissionFactor ( double  nMVOCEmissionFactor)
bool openstudio::model::FuelFactors::setNMVOCEmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setNOxEmissionFactor ( double  nOxEmissionFactor)
bool openstudio::model::FuelFactors::setNOxEmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setNuclearHighLevelEmissionFactor ( double  nuclearHighLevelEmissionFactor)
bool openstudio::model::FuelFactors::setNuclearHighLevelEmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setNuclearLowLevelEmissionFactor ( double  nuclearLowLevelEmissionFactor)
bool openstudio::model::FuelFactors::setNuclearLowLevelEmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setPbEmissionFactor ( double  pbEmissionFactor)
bool openstudio::model::FuelFactors::setPbEmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setPM10EmissionFactor ( double  pM10EmissionFactor)
bool openstudio::model::FuelFactors::setPM10EmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setPM25EmissionFactor ( double  pM25EmissionFactor)
bool openstudio::model::FuelFactors::setPM25EmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setPMEmissionFactor ( double  pMEmissionFactor)
bool openstudio::model::FuelFactors::setPMEmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setSO2EmissionFactor ( double  sO2EmissionFactor)
bool openstudio::model::FuelFactors::setSO2EmissionFactorSchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setSourceEnergyFactor ( double  sourceEnergyFactor)
bool openstudio::model::FuelFactors::setSourceEnergySchedule ( Schedule schedule)
bool openstudio::model::FuelFactors::setWaterEmissionFactor ( double  waterEmissionFactor)
bool openstudio::model::FuelFactors::setWaterEmissionFactorSchedule ( Schedule schedule)
double openstudio::model::FuelFactors::sO2EmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::sO2EmissionFactorSchedule ( ) const
double openstudio::model::FuelFactors::sourceEnergyFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::sourceEnergySchedule ( ) const
double openstudio::model::FuelFactors::waterEmissionFactor ( ) const
boost::optional<Schedule> openstudio::model::FuelFactors::waterEmissionFactorSchedule ( ) const

Friends And Related Function Documentation

typedef std::vector<FuelFactors> FuelFactorsVector
related
typedef boost::optional<FuelFactors> OptionalFuelFactors
related