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

#include <ElectricLoadCenterDistribution.hpp>

+ Inheritance diagram for openstudio::model::ElectricLoadCenterDistribution:

Public Member Functions

Constructors and Destructors
 ElectricLoadCenterDistribution (const Model &model)
 
virtual ~ElectricLoadCenterDistribution ()=default
 
 ElectricLoadCenterDistribution (const ElectricLoadCenterDistribution &other)=default
 
 ElectricLoadCenterDistribution (ElectricLoadCenterDistribution &&other)=default
 
ElectricLoadCenterDistributionoperator= (const ElectricLoadCenterDistribution &)=default
 
ElectricLoadCenterDistributionoperator= (ElectricLoadCenterDistribution &&)=default
 
Getters
std::vector< Generatorgenerators () const
 Returns associated generators, note there is no ElectricLoadCenter:Generators object in OpenStudio. More...
 
std::string generatorOperationSchemeType () const
 
bool isGeneratorOperationSchemeTypeDefaulted () const
 
boost::optional< double > demandLimitSchemePurchasedElectricDemandLimit () const
 
boost::optional< ScheduletrackScheduleSchemeSchedule () const
 
boost::optional< std::string > trackMeterSchemeMeterName () const
 
std::string electricalBussType () const
 
bool isElectricalBussTypeDefaulted () const
 
boost::optional< Inverterinverter () const
 
boost::optional
< ElectricalStorage
electricalStorage () const
 
boost::optional
< ElectricLoadCenterTransformer
transformer () const
 
std::string storageOperationScheme () const
 
bool isStorageOperationSchemeDefaulted () const
 
boost::optional< std::string > storageControlTrackMeterName () const
 
boost::optional
< ElectricLoadCenterStorageConverter
storageConverter () const
 
double maximumStorageStateofChargeFraction () const
 
bool isMaximumStorageStateofChargeFractionDefaulted () const
 
double minimumStorageStateofChargeFraction () const
 
bool isMinimumStorageStateofChargeFractionDefaulted () const
 
boost::optional< double > designStorageControlChargePower () const
 
boost::optional< SchedulestorageChargePowerFractionSchedule () const
 
boost::optional< double > designStorageControlDischargePower () const
 
boost::optional< SchedulestorageDischargePowerFractionSchedule () const
 
boost::optional< double > storageControlUtilityDemandTarget () const
 
Schedule storageControlUtilityDemandTargetFractionSchedule () const
 
bool isStorageControlUtilityDemandTargetFractionScheduleDefaulted () const
 
Setters
bool addGenerator (const Generator &generator)
 
bool removeGenerator (const Generator &generator)
 
void resetGenerators ()
 
bool setGeneratorOperationSchemeType (const std::string &generatorOperationSchemeType)
 
void resetGeneratorOperationSchemeType ()
 
bool setDemandLimitSchemePurchasedElectricDemandLimit (double demandLimitSchemePurchasedElectricDemandLimit)
 
void resetDemandLimitSchemePurchasedElectricDemandLimit ()
 
bool setTrackScheduleSchemeSchedule (Schedule &schedule)
 
void resetTrackScheduleSchemeSchedule ()
 
bool setTrackMeterSchemeMeterName (const std::string &trackMeterSchemeMeterName)
 
void resetTrackMeterSchemeMeterName ()
 
bool setElectricalBussType (const std::string &electricalBussType)
 
void resetElectricalBussType ()
 
bool setInverter (const Inverter &inverter)
 
void resetInverter ()
 
bool setElectricalStorage (const ElectricalStorage &electricalStorage)
 
void resetElectricalStorage ()
 
bool setTransformer (const ElectricLoadCenterTransformer &transformer)
 
void resetTransformer ()
 
bool setStorageOperationScheme (const std::string &operationScheme)
 
void resetStorageOperationScheme ()
 
bool setStorageControlTrackMeterName (const std::string &meterName)
 
void resetStorageControlTrackMeterName ()
 
bool setStorageConverter (const ElectricLoadCenterStorageConverter &converter)
 
void resetStorageConverter ()
 
bool setMaximumStorageStateofChargeFraction (const double maxStateofCharge)
 
void resetMaximumStorageStateofChargeFraction ()
 
bool setMinimumStorageStateofChargeFraction (const double minStateofCharge)
 
void resetMinimumStorageStateofChargeFraction ()
 
bool setDesignStorageControlChargePower (const double designStorageControlChargePower)
 
void resetDesignStorageControlChargePower ()
 
bool setStorageChargePowerFractionSchedule (Schedule &schedule)
 
void resetStorageChargePowerFractionSchedule ()
 
bool setDesignStorageControlDischargePower (const double designStorageControlDischargePower)
 
void resetDesignStorageControlDischargePower ()
 
bool setStorageDischargePowerFractionSchedule (Schedule &schedule)
 
void resetStorageDischargePowerFractionSchedule ()
 
bool setStorageControlUtilityDemandTarget (const double storageControlUtilityDemandTarget)
 
void resetStorageControlUtilityDemandTarget ()
 
bool setStorageControlUtilityDemandTargetFractionSchedule (Schedule &schedule)
 
void resetStorageControlUtilityDemandTargetFractionSchedule ()
 
Other
bool validityCheck () const
 
- 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 std::vector< std::string > electricalBussTypeValues ()
 
static std::vector< std::string > generatorOperationSchemeTypeValues ()
 
static IddObjectType iddObjectType ()
 
static std::vector< std::string > storageOperationSchemeValues ()
 

Related Functions

(Note that these are not member functions.)

using ElectricLoadCenterDistributionVector = std::vector< ElectricLoadCenterDistribution >
 
using OptionalElectricLoadCenterDistribution = boost::optional< ElectricLoadCenterDistribution >
 

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

ElectricLoadCenterDistribution is a ParentObject that wraps the OpenStudio IDD object 'OS:ElectricLoadCenter:Distribution'.

There is no ElectricLoadCenter:Generators object in OpenStudio. Instead, the ElectricLoadCenterDistribution object references a model object list which references all of the associated generators. The rated electric power, availability schedule, and thermal to electric power ratio fields are contained in the generator objects themselves rather than the ElectricLoadCenter:Generators as in EnergyPlus. Electric storage and transformers will be added at a later date.

Constructor & Destructor Documentation

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

Member Function Documentation

bool openstudio::model::ElectricLoadCenterDistribution::addGenerator ( const Generator generator)
boost::optional<double> openstudio::model::ElectricLoadCenterDistribution::demandLimitSchemePurchasedElectricDemandLimit ( ) const
boost::optional<double> openstudio::model::ElectricLoadCenterDistribution::designStorageControlChargePower ( ) const
boost::optional<double> openstudio::model::ElectricLoadCenterDistribution::designStorageControlDischargePower ( ) const
std::string openstudio::model::ElectricLoadCenterDistribution::electricalBussType ( ) const
static std::vector<std::string> openstudio::model::ElectricLoadCenterDistribution::electricalBussTypeValues ( )
static
boost::optional<ElectricalStorage> openstudio::model::ElectricLoadCenterDistribution::electricalStorage ( ) const
std::string openstudio::model::ElectricLoadCenterDistribution::generatorOperationSchemeType ( ) const
static std::vector<std::string> openstudio::model::ElectricLoadCenterDistribution::generatorOperationSchemeTypeValues ( )
static
std::vector<Generator> openstudio::model::ElectricLoadCenterDistribution::generators ( ) const

Returns associated generators, note there is no ElectricLoadCenter:Generators object in OpenStudio.

static IddObjectType openstudio::model::ElectricLoadCenterDistribution::iddObjectType ( )
static
boost::optional<Inverter> openstudio::model::ElectricLoadCenterDistribution::inverter ( ) const
bool openstudio::model::ElectricLoadCenterDistribution::isElectricalBussTypeDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterDistribution::isGeneratorOperationSchemeTypeDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterDistribution::isMaximumStorageStateofChargeFractionDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterDistribution::isMinimumStorageStateofChargeFractionDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterDistribution::isStorageControlUtilityDemandTargetFractionScheduleDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterDistribution::isStorageOperationSchemeDefaulted ( ) const
double openstudio::model::ElectricLoadCenterDistribution::maximumStorageStateofChargeFraction ( ) const
double openstudio::model::ElectricLoadCenterDistribution::minimumStorageStateofChargeFraction ( ) const
ElectricLoadCenterDistribution& openstudio::model::ElectricLoadCenterDistribution::operator= ( const ElectricLoadCenterDistribution )
default
ElectricLoadCenterDistribution& openstudio::model::ElectricLoadCenterDistribution::operator= ( ElectricLoadCenterDistribution &&  )
default
bool openstudio::model::ElectricLoadCenterDistribution::removeGenerator ( const Generator generator)
void openstudio::model::ElectricLoadCenterDistribution::resetDemandLimitSchemePurchasedElectricDemandLimit ( )
void openstudio::model::ElectricLoadCenterDistribution::resetDesignStorageControlChargePower ( )
void openstudio::model::ElectricLoadCenterDistribution::resetDesignStorageControlDischargePower ( )
void openstudio::model::ElectricLoadCenterDistribution::resetElectricalBussType ( )
void openstudio::model::ElectricLoadCenterDistribution::resetElectricalStorage ( )
void openstudio::model::ElectricLoadCenterDistribution::resetGeneratorOperationSchemeType ( )
void openstudio::model::ElectricLoadCenterDistribution::resetGenerators ( )
void openstudio::model::ElectricLoadCenterDistribution::resetInverter ( )
void openstudio::model::ElectricLoadCenterDistribution::resetMaximumStorageStateofChargeFraction ( )
void openstudio::model::ElectricLoadCenterDistribution::resetMinimumStorageStateofChargeFraction ( )
void openstudio::model::ElectricLoadCenterDistribution::resetStorageChargePowerFractionSchedule ( )
void openstudio::model::ElectricLoadCenterDistribution::resetStorageControlTrackMeterName ( )
void openstudio::model::ElectricLoadCenterDistribution::resetStorageControlUtilityDemandTarget ( )
void openstudio::model::ElectricLoadCenterDistribution::resetStorageControlUtilityDemandTargetFractionSchedule ( )
void openstudio::model::ElectricLoadCenterDistribution::resetStorageConverter ( )
void openstudio::model::ElectricLoadCenterDistribution::resetStorageDischargePowerFractionSchedule ( )
void openstudio::model::ElectricLoadCenterDistribution::resetStorageOperationScheme ( )
void openstudio::model::ElectricLoadCenterDistribution::resetTrackMeterSchemeMeterName ( )
void openstudio::model::ElectricLoadCenterDistribution::resetTrackScheduleSchemeSchedule ( )
void openstudio::model::ElectricLoadCenterDistribution::resetTransformer ( )
bool openstudio::model::ElectricLoadCenterDistribution::setDemandLimitSchemePurchasedElectricDemandLimit ( double  demandLimitSchemePurchasedElectricDemandLimit)
bool openstudio::model::ElectricLoadCenterDistribution::setDesignStorageControlChargePower ( const double  designStorageControlChargePower)
bool openstudio::model::ElectricLoadCenterDistribution::setDesignStorageControlDischargePower ( const double  designStorageControlDischargePower)
bool openstudio::model::ElectricLoadCenterDistribution::setElectricalBussType ( const std::string &  electricalBussType)
bool openstudio::model::ElectricLoadCenterDistribution::setElectricalStorage ( const ElectricalStorage electricalStorage)
bool openstudio::model::ElectricLoadCenterDistribution::setGeneratorOperationSchemeType ( const std::string &  generatorOperationSchemeType)
bool openstudio::model::ElectricLoadCenterDistribution::setInverter ( const Inverter inverter)
bool openstudio::model::ElectricLoadCenterDistribution::setMaximumStorageStateofChargeFraction ( const double  maxStateofCharge)
bool openstudio::model::ElectricLoadCenterDistribution::setMinimumStorageStateofChargeFraction ( const double  minStateofCharge)
bool openstudio::model::ElectricLoadCenterDistribution::setStorageChargePowerFractionSchedule ( Schedule schedule)
bool openstudio::model::ElectricLoadCenterDistribution::setStorageControlTrackMeterName ( const std::string &  meterName)
bool openstudio::model::ElectricLoadCenterDistribution::setStorageControlUtilityDemandTarget ( const double  storageControlUtilityDemandTarget)
bool openstudio::model::ElectricLoadCenterDistribution::setStorageControlUtilityDemandTargetFractionSchedule ( Schedule schedule)
bool openstudio::model::ElectricLoadCenterDistribution::setStorageConverter ( const ElectricLoadCenterStorageConverter converter)
bool openstudio::model::ElectricLoadCenterDistribution::setStorageDischargePowerFractionSchedule ( Schedule schedule)
bool openstudio::model::ElectricLoadCenterDistribution::setStorageOperationScheme ( const std::string &  operationScheme)
bool openstudio::model::ElectricLoadCenterDistribution::setTrackMeterSchemeMeterName ( const std::string &  trackMeterSchemeMeterName)
bool openstudio::model::ElectricLoadCenterDistribution::setTrackScheduleSchemeSchedule ( Schedule schedule)
bool openstudio::model::ElectricLoadCenterDistribution::setTransformer ( const ElectricLoadCenterTransformer transformer)
boost::optional<Schedule> openstudio::model::ElectricLoadCenterDistribution::storageChargePowerFractionSchedule ( ) const
boost::optional<std::string> openstudio::model::ElectricLoadCenterDistribution::storageControlTrackMeterName ( ) const
boost::optional<double> openstudio::model::ElectricLoadCenterDistribution::storageControlUtilityDemandTarget ( ) const
Schedule openstudio::model::ElectricLoadCenterDistribution::storageControlUtilityDemandTargetFractionSchedule ( ) const
boost::optional<ElectricLoadCenterStorageConverter> openstudio::model::ElectricLoadCenterDistribution::storageConverter ( ) const
boost::optional<Schedule> openstudio::model::ElectricLoadCenterDistribution::storageDischargePowerFractionSchedule ( ) const
std::string openstudio::model::ElectricLoadCenterDistribution::storageOperationScheme ( ) const
static std::vector<std::string> openstudio::model::ElectricLoadCenterDistribution::storageOperationSchemeValues ( )
static
boost::optional<std::string> openstudio::model::ElectricLoadCenterDistribution::trackMeterSchemeMeterName ( ) const
boost::optional<Schedule> openstudio::model::ElectricLoadCenterDistribution::trackScheduleSchemeSchedule ( ) const
boost::optional<ElectricLoadCenterTransformer> openstudio::model::ElectricLoadCenterDistribution::transformer ( ) const
bool openstudio::model::ElectricLoadCenterDistribution::validityCheck ( ) const

Friends And Related Function Documentation