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

#include <ElectricLoadCenterTransformer.hpp>

+ Inheritance diagram for openstudio::model::ElectricLoadCenterTransformer:

Public Member Functions

Constructors and Destructors
 ElectricLoadCenterTransformer (const Model &model)
 
virtual ~ElectricLoadCenterTransformer ()
 
Getters
boost::optional< ScheduleavailabilitySchedule () const
 
std::string transformerUsage () const
 
bool isTransformerUsageDefaulted () const
 
boost::optional< ThermalZonezone () const
 
double radiativeFraction () const
 
bool isRadiativeFractionDefaulted () const
 
boost::optional< double > ratedCapacity () const
 
std::string phase () const
 
bool isPhaseDefaulted () const
 
std::string conductorMaterial () const
 
bool isConductorMaterialDefaulted () const
 
double fullLoadTemperatureRise () const
 
bool isFullLoadTemperatureRiseDefaulted () const
 
double fractionofEddyCurrentLosses () const
 
bool isFractionofEddyCurrentLossesDefaulted () const
 
std::string performanceInputMethod () const
 
bool isPerformanceInputMethodDefaulted () const
 
boost::optional< double > ratedNoLoadLoss () const
 
boost::optional< double > ratedLoadLoss () const
 
double nameplateEfficiency () const
 
bool isNameplateEfficiencyDefaulted () const
 
double perUnitLoadforNameplateEfficiency () const
 
bool isPerUnitLoadforNameplateEfficiencyDefaulted () const
 
double referenceTemperatureforNameplateEfficiency () const
 
bool isReferenceTemperatureforNameplateEfficiencyDefaulted () const
 
boost::optional< double > perUnitLoadforMaximumEfficiency () const
 
bool considerTransformerLossforUtilityCost () const
 
bool isConsiderTransformerLossforUtilityCostDefaulted () const
 
std::vector< std::string > meters () const
 
boost::optional< std::string > getMeter (unsigned index) const
 
Setters
bool setAvailabilitySchedule (Schedule &schedule)
 
void resetAvailabilitySchedule ()
 
bool setTransformerUsage (const std::string &transformerUsage)
 
void resetTransformerUsage ()
 
bool setZone (const ThermalZone &thermalZone)
 
void resetZone ()
 
bool setRadiativeFraction (double radiativeFraction)
 
void resetRadiativeFraction ()
 
bool setRatedCapacity (double ratedCapacity)
 
void resetRatedCapacity ()
 
bool setPhase (const std::string &phase)
 
void resetPhase ()
 
bool setConductorMaterial (const std::string &conductorMaterial)
 
void resetConductorMaterial ()
 
bool setFullLoadTemperatureRise (double fullLoadTemperatureRise)
 
void resetFullLoadTemperatureRise ()
 
bool setFractionofEddyCurrentLosses (double fractionofEddyCurrentLosses)
 
void resetFractionofEddyCurrentLosses ()
 
bool setPerformanceInputMethod (const std::string &performanceInputMethod)
 
void resetPerformanceInputMethod ()
 
bool setRatedNoLoadLoss (double ratedNoLoadLoss)
 
void resetRatedNoLoadLoss ()
 
bool setRatedLoadLoss (double ratedLoadLoss)
 
void resetRatedLoadLoss ()
 
bool setNameplateEfficiency (double nameplateEfficiency)
 
void resetNameplateEfficiency ()
 
bool setPerUnitLoadforNameplateEfficiency (double perUnitLoadforNameplateEfficiency)
 
void resetPerUnitLoadforNameplateEfficiency ()
 
bool setReferenceTemperatureforNameplateEfficiency (double referenceTemperatureforNameplateEfficiency)
 
void resetReferenceTemperatureforNameplateEfficiency ()
 
bool setPerUnitLoadforMaximumEfficiency (double perUnitLoadforMaximumEfficiency)
 
void resetPerUnitLoadforMaximumEfficiency ()
 
bool setConsiderTransformerLossforUtilityCost (bool considerTransformerLossforUtilityCost)
 
void resetConsiderTransformerLossforUtilityCost ()
 
void eraseMeters ()
 
bool eraseMeter (unsigned index)
 
bool addMeter (const std::string &meterName)
 
bool setMeter (const std::string &meterName, unsigned index)
 
- 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 > conductorMaterialValues ()
 
static IddObjectType iddObjectType ()
 
static std::vector< std::string > performanceInputMethodValues ()
 
static std::vector< std::string > phaseValues ()
 
static std::vector< std::string > transformerUsageValues ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< ElectricLoadCenterTransformer
ElectricLoadCenterTransformerVector
 
typedef boost::optional
< ElectricLoadCenterTransformer
OptionalElectricLoadCenterTransformer
 

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

ElectricLoadCenterTransformer is a ModelObject that wraps the OpenStudio IDD object 'OS:ElectricLoadCenter:Transformer'.

Constructor & Destructor Documentation

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

Member Function Documentation

bool openstudio::model::ElectricLoadCenterTransformer::addMeter ( const std::string &  meterName)
boost::optional<Schedule> openstudio::model::ElectricLoadCenterTransformer::availabilitySchedule ( ) const
std::string openstudio::model::ElectricLoadCenterTransformer::conductorMaterial ( ) const
static std::vector<std::string> openstudio::model::ElectricLoadCenterTransformer::conductorMaterialValues ( )
static
bool openstudio::model::ElectricLoadCenterTransformer::considerTransformerLossforUtilityCost ( ) const
bool openstudio::model::ElectricLoadCenterTransformer::eraseMeter ( unsigned  index)
void openstudio::model::ElectricLoadCenterTransformer::eraseMeters ( )
double openstudio::model::ElectricLoadCenterTransformer::fractionofEddyCurrentLosses ( ) const
double openstudio::model::ElectricLoadCenterTransformer::fullLoadTemperatureRise ( ) const
boost::optional<std::string> openstudio::model::ElectricLoadCenterTransformer::getMeter ( unsigned  index) const
static IddObjectType openstudio::model::ElectricLoadCenterTransformer::iddObjectType ( )
static
bool openstudio::model::ElectricLoadCenterTransformer::isConductorMaterialDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterTransformer::isConsiderTransformerLossforUtilityCostDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterTransformer::isFractionofEddyCurrentLossesDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterTransformer::isFullLoadTemperatureRiseDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterTransformer::isNameplateEfficiencyDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterTransformer::isPerformanceInputMethodDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterTransformer::isPerUnitLoadforNameplateEfficiencyDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterTransformer::isPhaseDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterTransformer::isRadiativeFractionDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterTransformer::isReferenceTemperatureforNameplateEfficiencyDefaulted ( ) const
bool openstudio::model::ElectricLoadCenterTransformer::isTransformerUsageDefaulted ( ) const
std::vector<std::string> openstudio::model::ElectricLoadCenterTransformer::meters ( ) const
double openstudio::model::ElectricLoadCenterTransformer::nameplateEfficiency ( ) const
std::string openstudio::model::ElectricLoadCenterTransformer::performanceInputMethod ( ) const
static std::vector<std::string> openstudio::model::ElectricLoadCenterTransformer::performanceInputMethodValues ( )
static
boost::optional<double> openstudio::model::ElectricLoadCenterTransformer::perUnitLoadforMaximumEfficiency ( ) const
double openstudio::model::ElectricLoadCenterTransformer::perUnitLoadforNameplateEfficiency ( ) const
std::string openstudio::model::ElectricLoadCenterTransformer::phase ( ) const
static std::vector<std::string> openstudio::model::ElectricLoadCenterTransformer::phaseValues ( )
static
double openstudio::model::ElectricLoadCenterTransformer::radiativeFraction ( ) const
boost::optional<double> openstudio::model::ElectricLoadCenterTransformer::ratedCapacity ( ) const
boost::optional<double> openstudio::model::ElectricLoadCenterTransformer::ratedLoadLoss ( ) const
boost::optional<double> openstudio::model::ElectricLoadCenterTransformer::ratedNoLoadLoss ( ) const
double openstudio::model::ElectricLoadCenterTransformer::referenceTemperatureforNameplateEfficiency ( ) const
void openstudio::model::ElectricLoadCenterTransformer::resetAvailabilitySchedule ( )
void openstudio::model::ElectricLoadCenterTransformer::resetConductorMaterial ( )
void openstudio::model::ElectricLoadCenterTransformer::resetConsiderTransformerLossforUtilityCost ( )
void openstudio::model::ElectricLoadCenterTransformer::resetFractionofEddyCurrentLosses ( )
void openstudio::model::ElectricLoadCenterTransformer::resetFullLoadTemperatureRise ( )
void openstudio::model::ElectricLoadCenterTransformer::resetNameplateEfficiency ( )
void openstudio::model::ElectricLoadCenterTransformer::resetPerformanceInputMethod ( )
void openstudio::model::ElectricLoadCenterTransformer::resetPerUnitLoadforMaximumEfficiency ( )
void openstudio::model::ElectricLoadCenterTransformer::resetPerUnitLoadforNameplateEfficiency ( )
void openstudio::model::ElectricLoadCenterTransformer::resetPhase ( )
void openstudio::model::ElectricLoadCenterTransformer::resetRadiativeFraction ( )
void openstudio::model::ElectricLoadCenterTransformer::resetRatedCapacity ( )
void openstudio::model::ElectricLoadCenterTransformer::resetRatedLoadLoss ( )
void openstudio::model::ElectricLoadCenterTransformer::resetRatedNoLoadLoss ( )
void openstudio::model::ElectricLoadCenterTransformer::resetReferenceTemperatureforNameplateEfficiency ( )
void openstudio::model::ElectricLoadCenterTransformer::resetTransformerUsage ( )
void openstudio::model::ElectricLoadCenterTransformer::resetZone ( )
bool openstudio::model::ElectricLoadCenterTransformer::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::ElectricLoadCenterTransformer::setConductorMaterial ( const std::string &  conductorMaterial)
bool openstudio::model::ElectricLoadCenterTransformer::setConsiderTransformerLossforUtilityCost ( bool  considerTransformerLossforUtilityCost)
bool openstudio::model::ElectricLoadCenterTransformer::setFractionofEddyCurrentLosses ( double  fractionofEddyCurrentLosses)
bool openstudio::model::ElectricLoadCenterTransformer::setFullLoadTemperatureRise ( double  fullLoadTemperatureRise)
bool openstudio::model::ElectricLoadCenterTransformer::setMeter ( const std::string &  meterName,
unsigned  index 
)
bool openstudio::model::ElectricLoadCenterTransformer::setNameplateEfficiency ( double  nameplateEfficiency)
bool openstudio::model::ElectricLoadCenterTransformer::setPerformanceInputMethod ( const std::string &  performanceInputMethod)
bool openstudio::model::ElectricLoadCenterTransformer::setPerUnitLoadforMaximumEfficiency ( double  perUnitLoadforMaximumEfficiency)
bool openstudio::model::ElectricLoadCenterTransformer::setPerUnitLoadforNameplateEfficiency ( double  perUnitLoadforNameplateEfficiency)
bool openstudio::model::ElectricLoadCenterTransformer::setPhase ( const std::string &  phase)
bool openstudio::model::ElectricLoadCenterTransformer::setRadiativeFraction ( double  radiativeFraction)
bool openstudio::model::ElectricLoadCenterTransformer::setRatedCapacity ( double  ratedCapacity)
bool openstudio::model::ElectricLoadCenterTransformer::setRatedLoadLoss ( double  ratedLoadLoss)
bool openstudio::model::ElectricLoadCenterTransformer::setRatedNoLoadLoss ( double  ratedNoLoadLoss)
bool openstudio::model::ElectricLoadCenterTransformer::setReferenceTemperatureforNameplateEfficiency ( double  referenceTemperatureforNameplateEfficiency)
bool openstudio::model::ElectricLoadCenterTransformer::setTransformerUsage ( const std::string &  transformerUsage)
bool openstudio::model::ElectricLoadCenterTransformer::setZone ( const ThermalZone thermalZone)
std::string openstudio::model::ElectricLoadCenterTransformer::transformerUsage ( ) const
static std::vector<std::string> openstudio::model::ElectricLoadCenterTransformer::transformerUsageValues ( )
static
boost::optional<ThermalZone> openstudio::model::ElectricLoadCenterTransformer::zone ( ) const

Friends And Related Function Documentation