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

#include <ExteriorFuelEquipment.hpp>

+ Inheritance diagram for openstudio::model::ExteriorFuelEquipment:

Public Member Functions

Constructors and Destructors
 ExteriorFuelEquipment (const ExteriorFuelEquipmentDefinition &definition)
 This constructor sets schedule to always on, defaults to Fuel Type = Electricity. More...
 ExteriorFuelEquipment (const ExteriorFuelEquipmentDefinition &definition, Schedule &schedule)
 This constructor requires a user-specified schedule. More...
virtual ~ExteriorFuelEquipment ()
ExteriorFuelEquipmentDefinition exteriorFuelEquipmentDefinition () const
Schedule schedule () const
std::string fuelType () const
double multiplier () const
bool isMultiplierDefaulted () const
std::string endUseSubcategory () const
bool isEndUseSubcategoryDefaulted () const
bool setExteriorFuelEquipmentDefinition (const ExteriorFuelEquipmentDefinition &exteriorFuelEquipmentDefinition)
bool setSchedule (Schedule &schedule)
void resetSchedule ()
bool setFuelType (std::string fuelType)
bool setMultiplier (double multiplier)
void resetMultiplier ()
bool setEndUseSubcategory (std::string endUseSubcategory)
void resetEndUseSubcategory ()
Facility facility () const
- Public Member Functions inherited from openstudio::model::ExteriorLoadInstance
ExteriorLoadDefinition definition () const
 Returns the definition of this instance. More...
bool isMultiplierDefaulted () const
 Returns true if the multiplier is defaulted. More...
void makeUnique ()
 Ensures that no other instances share this instances definition. More...
double multiplier () const
 Gets the multiplier for this space instance, defaults to 1. More...
int quantity () const
 Returns the number of instances this space load instance represents. More...
bool setDefinition (const ExteriorLoadDefinition &definition)
 Sets the definition of this instance. More...
virtual ~ExteriorLoadInstance ()
- 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...
< 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...
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 > fuelTypeValues ()
static IddObjectType iddObjectType ()
static std::vector< std::string > validFuelTypeValues ()

Related Functions

(Note that these are not member functions.)

typedef std::vector
< ExteriorFuelEquipment
typedef boost::optional
< ExteriorFuelEquipment

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
- Protected Member Functions inherited from openstudio::model::ExteriorLoadInstance
 ExteriorLoadInstance (IddObjectType type, const ExteriorLoadDefinition &definition)
 Constructs a new ExteriorLoadInstance 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

ExteriorFuelEquipment is a ExteriorLoadInstance that wraps the OpenStudio IDD object 'OS:Exterior:FuelEquipment'.

ExteriorFuelEquipment is a child of Facility and instances ExteriorFuelEquipmentDefinition.

Constructor & Destructor Documentation

openstudio::model::ExteriorFuelEquipment::ExteriorFuelEquipment ( const ExteriorFuelEquipmentDefinition definition)

This constructor sets schedule to always on, defaults to Fuel Type = Electricity.

openstudio::model::ExteriorFuelEquipment::ExteriorFuelEquipment ( const ExteriorFuelEquipmentDefinition definition,
Schedule schedule 

This constructor requires a user-specified schedule.

virtual openstudio::model::ExteriorFuelEquipment::~ExteriorFuelEquipment ( )

Member Function Documentation

std::string openstudio::model::ExteriorFuelEquipment::endUseSubcategory ( ) const
ExteriorFuelEquipmentDefinition openstudio::model::ExteriorFuelEquipment::exteriorFuelEquipmentDefinition ( ) const
Facility openstudio::model::ExteriorFuelEquipment::facility ( ) const
std::string openstudio::model::ExteriorFuelEquipment::fuelType ( ) const
static std::vector<std::string> openstudio::model::ExteriorFuelEquipment::fuelTypeValues ( )
static IddObjectType openstudio::model::ExteriorFuelEquipment::iddObjectType ( )
bool openstudio::model::ExteriorFuelEquipment::isEndUseSubcategoryDefaulted ( ) const
bool openstudio::model::ExteriorFuelEquipment::isMultiplierDefaulted ( ) const
double openstudio::model::ExteriorFuelEquipment::multiplier ( ) const
void openstudio::model::ExteriorFuelEquipment::resetEndUseSubcategory ( )
void openstudio::model::ExteriorFuelEquipment::resetMultiplier ( )
void openstudio::model::ExteriorFuelEquipment::resetSchedule ( )
Schedule openstudio::model::ExteriorFuelEquipment::schedule ( ) const
bool openstudio::model::ExteriorFuelEquipment::setEndUseSubcategory ( std::string  endUseSubcategory)
bool openstudio::model::ExteriorFuelEquipment::setExteriorFuelEquipmentDefinition ( const ExteriorFuelEquipmentDefinition exteriorFuelEquipmentDefinition)
bool openstudio::model::ExteriorFuelEquipment::setFuelType ( std::string  fuelType)
bool openstudio::model::ExteriorFuelEquipment::setMultiplier ( double  multiplier)
bool openstudio::model::ExteriorFuelEquipment::setSchedule ( Schedule schedule)
static std::vector<std::string> openstudio::model::ExteriorFuelEquipment::validFuelTypeValues ( )

Friends And Related Function Documentation

typedef std::vector<ExteriorFuelEquipment> ExteriorFuelEquipmentVector
typedef boost::optional<ExteriorFuelEquipment> OptionalExteriorFuelEquipment