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

#include <ElectricLoadCenterStorageSimple.hpp>

+ Inheritance diagram for openstudio::model::ElectricLoadCenterStorageSimple:

Public Member Functions

Constructors and Destructors
 ElectricLoadCenterStorageSimple (const Model &model)
 
virtual ~ElectricLoadCenterStorageSimple ()
 
Getters
Schedule availabilitySchedule () const
 
bool isAvailabilityScheduleDefaulted () const
 
double radiativeFractionforZoneHeatGains () const
 
bool isRadiativeFractionforZoneHeatGainsDefaulted () const
 
double nominalEnergeticEfficiencyforCharging () const
 
bool isNominalEnergeticEfficiencyforChargingDefaulted () const
 
double nominalDischargingEnergeticEfficiency () const
 
bool isNominalDischargingEnergeticEfficiencyDefaulted () const
 
double maximumStorageCapacity () const
 
double maximumPowerforDischarging () const
 
double maximumPowerforCharging () const
 
double initialStateofCharge () const
 
bool isInitialStateofChargeDefaulted () const
 
Setters
bool setAvailabilitySchedule (Schedule &schedule)
 
void resetAvailabilitySchedule ()
 
bool setRadiativeFractionforZoneHeatGains (double radiativeFractionforZoneHeatGains)
 
void resetRadiativeFractionforZoneHeatGains ()
 
bool setNominalEnergeticEfficiencyforCharging (double nominalEnergeticEfficiencyforCharging)
 
void resetNominalEnergeticEfficiencyforCharging ()
 
bool setNominalDischargingEnergeticEfficiency (double nominalDischargingEnergeticEfficiency)
 
void resetNominalDischargingEnergeticEfficiency ()
 
bool setMaximumStorageCapacity (double maximumStorageCapacity)
 
bool setMaximumPowerforDischarging (double maximumPowerforDischarging)
 
bool setMaximumPowerforCharging (double maximumPowerforCharging)
 
bool setInitialStateofCharge (double initialStateofCharge)
 
void resetInitialStateofCharge ()
 
- Public Member Functions inherited from openstudio::model::ElectricalStorage
 ElectricalStorage (IddObjectType type, const Model &model)
 
boost::optional
< ElectricLoadCenterDistribution
electricLoadCenterDistribution () const
 
virtual void resetThermalZone ()
 
virtual bool setThermalZone (const ThermalZone &thermalZone)
 
virtual boost::optional
< ThermalZone
thermalZone () const
 
virtual ~ElectricalStorage ()
 
- 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...
 
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< 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...
 
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 IddObjectType iddObjectType ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< ElectricLoadCenterStorageSimple
ElectricLoadCenterStorageSimpleVector
 
typedef boost::optional
< ElectricLoadCenterStorageSimple
OptionalElectricLoadCenterStorageSimple
 

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

ElectricLoadCenterStorageSimple is a ElectricalStorage that wraps the OpenStudio IDD object 'OS:ElectricLoadCenter:Storage:Simple'.

Constructor & Destructor Documentation

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

Member Function Documentation

Schedule openstudio::model::ElectricLoadCenterStorageSimple::availabilitySchedule ( ) const
static IddObjectType openstudio::model::ElectricLoadCenterStorageSimple::iddObjectType ( )
static
double openstudio::model::ElectricLoadCenterStorageSimple::initialStateofCharge ( ) const
bool openstudio::model::ElectricLoadCenterStorageSimple::isAvailabilityScheduleDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterStorageSimple::isInitialStateofChargeDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterStorageSimple::isNominalDischargingEnergeticEfficiencyDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterStorageSimple::isNominalEnergeticEfficiencyforChargingDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterStorageSimple::isRadiativeFractionforZoneHeatGainsDefaulted ( ) const
double openstudio::model::ElectricLoadCenterStorageSimple::maximumPowerforCharging ( ) const
double openstudio::model::ElectricLoadCenterStorageSimple::maximumPowerforDischarging ( ) const
double openstudio::model::ElectricLoadCenterStorageSimple::maximumStorageCapacity ( ) const
double openstudio::model::ElectricLoadCenterStorageSimple::nominalDischargingEnergeticEfficiency ( ) const
double openstudio::model::ElectricLoadCenterStorageSimple::nominalEnergeticEfficiencyforCharging ( ) const
double openstudio::model::ElectricLoadCenterStorageSimple::radiativeFractionforZoneHeatGains ( ) const
void openstudio::model::ElectricLoadCenterStorageSimple::resetAvailabilitySchedule ( )
void openstudio::model::ElectricLoadCenterStorageSimple::resetInitialStateofCharge ( )
void openstudio::model::ElectricLoadCenterStorageSimple::resetNominalDischargingEnergeticEfficiency ( )
void openstudio::model::ElectricLoadCenterStorageSimple::resetNominalEnergeticEfficiencyforCharging ( )
void openstudio::model::ElectricLoadCenterStorageSimple::resetRadiativeFractionforZoneHeatGains ( )
bool openstudio::model::ElectricLoadCenterStorageSimple::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::ElectricLoadCenterStorageSimple::setInitialStateofCharge ( double  initialStateofCharge)
bool openstudio::model::ElectricLoadCenterStorageSimple::setMaximumPowerforCharging ( double  maximumPowerforCharging)
bool openstudio::model::ElectricLoadCenterStorageSimple::setMaximumPowerforDischarging ( double  maximumPowerforDischarging)
bool openstudio::model::ElectricLoadCenterStorageSimple::setMaximumStorageCapacity ( double  maximumStorageCapacity)
bool openstudio::model::ElectricLoadCenterStorageSimple::setNominalDischargingEnergeticEfficiency ( double  nominalDischargingEnergeticEfficiency)
bool openstudio::model::ElectricLoadCenterStorageSimple::setNominalEnergeticEfficiencyforCharging ( double  nominalEnergeticEfficiencyforCharging)
bool openstudio::model::ElectricLoadCenterStorageSimple::setRadiativeFractionforZoneHeatGains ( double  radiativeFractionforZoneHeatGains)

Friends And Related Function Documentation