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

#include <ExteriorLoadInstance.hpp>

+ Inheritance diagram for openstudio::model::ExteriorLoadInstance:

Public Member Functions

ExteriorLoadDefinition definition () const
 Returns the definition of this instance. More...
 
 ExteriorLoadInstance (const ExteriorLoadInstance &other)=default
 
 ExteriorLoadInstance (ExteriorLoadInstance &&other)=default
 
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...
 
ExteriorLoadInstanceoperator= (const ExteriorLoadInstance &)=default
 
ExteriorLoadInstanceoperator= (ExteriorLoadInstance &&)=default
 
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 ()=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
 

Protected Member Functions

Constructors and Destructors
 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)
 

Related Functions

(Note that these are not member functions.)

using ExteriorLoadInstanceVector = std::vector< ExteriorLoadInstance >
 
using OptionalExteriorLoadInstance = boost::optional< ExteriorLoadInstance >
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 

Detailed Description

ExteriorLoadInstance is an abstract class derived from ModelObject.

ExteriorLoadInstances instantiate a given ExteriorLoadDefinition in the facility by defining a multiplier and a schedule.

Constructor & Destructor Documentation

virtual openstudio::model::ExteriorLoadInstance::~ExteriorLoadInstance ( )
virtualdefault
openstudio::model::ExteriorLoadInstance::ExteriorLoadInstance ( const ExteriorLoadInstance other)
default
openstudio::model::ExteriorLoadInstance::ExteriorLoadInstance ( ExteriorLoadInstance &&  other)
default
openstudio::model::ExteriorLoadInstance::ExteriorLoadInstance ( IddObjectType  type,
const ExteriorLoadDefinition definition 
)
protected

Constructs a new ExteriorLoadInstance object in the model.

Member Function Documentation

ExteriorLoadDefinition openstudio::model::ExteriorLoadInstance::definition ( ) const

Returns the definition of this instance.

bool openstudio::model::ExteriorLoadInstance::isMultiplierDefaulted ( ) const

Returns true if the multiplier is defaulted.

void openstudio::model::ExteriorLoadInstance::makeUnique ( )

Ensures that no other instances share this instances definition.

double openstudio::model::ExteriorLoadInstance::multiplier ( ) const

Gets the multiplier for this space instance, defaults to 1.

ExteriorLoadInstance& openstudio::model::ExteriorLoadInstance::operator= ( const ExteriorLoadInstance )
default
ExteriorLoadInstance& openstudio::model::ExteriorLoadInstance::operator= ( ExteriorLoadInstance &&  )
default
int openstudio::model::ExteriorLoadInstance::quantity ( ) const

Returns the number of instances this space load instance represents.

This just forwards to multiplier() here but is included for consistency with SpaceLoadInstance

bool openstudio::model::ExteriorLoadInstance::setDefinition ( const ExteriorLoadDefinition definition)

Sets the definition of this instance.

Friends And Related Function Documentation

using ExteriorLoadInstanceVector = std::vector<ExteriorLoadInstance>
related
using OptionalExteriorLoadInstance = boost::optional<ExteriorLoadInstance>
related