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

#include <SpaceLoadInstance.hpp>

+ Inheritance diagram for openstudio::model::SpaceLoadInstance:

Public Member Functions

SpaceLoadDefinition definition () const
 Returns the definition of this instance. More...
 
double floorArea () const
 Returns the floor area associated with this space load 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 SpaceLoadDefinition &definition)
 Sets the definition of this instance. More...
 
virtual ~SpaceLoadInstance ()
 
- Public Member Functions inherited from openstudio::model::SpaceLoad
bool hardApplySchedules ()
 Directly applies default schedules to this space load if found. More...
 
bool hardSize ()
 Converts space load levels to absolute values rather than by per area, etc. More...
 
bool isAbsolute () const
 Returns true if the load represents an absolute quantity that must be added when combining space types. More...
 
void resetSpaceType ()
 
bool setSpaceType (const SpaceType &spaceType)
 Sets the parent SpaceType. More...
 
boost::optional< SpaceTypespaceType () const
 Returns the parent SpaceType. More...
 
virtual ~SpaceLoad ()
 
- Public Member Functions inherited from openstudio::model::SpaceItem
void resetSpace ()
 
bool setSpace (const Space &space)
 Sets the parent Space. More...
 
boost::optional< Spacespace () const
 Returns the parent Space. More...
 
virtual ~SpaceItem ()
 
- 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
 

Protected Member Functions

Constructors and Destructors
 SpaceLoadInstance (IddObjectType type, const SpaceLoadDefinition &definition)
 Constructs a new SpaceLoadInstance object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::SpaceLoad
 SpaceLoad (IddObjectType type, const Model &model)
 Constructs a new SpaceLoad object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::SpaceItem
 SpaceItem (IddObjectType type, const Model &model)
 Constructs a new SpaceItem 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.)

typedef boost::optional
< SpaceLoadInstance
OptionalSpaceLoadInstance
 
typedef std::vector
< SpaceLoadInstance
SpaceLoadInstanceVector
 

Additional Inherited Members

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

Detailed Description

SpaceLoadInstance is an abstract class derived from SpaceLoad.

SpaceLoadInstances instantiate a given SpaceLoadDefinition in a Space or SpaceType by defining a multiplier and a schedule.

Constructor & Destructor Documentation

virtual openstudio::model::SpaceLoadInstance::~SpaceLoadInstance ( )
inlinevirtual
openstudio::model::SpaceLoadInstance::SpaceLoadInstance ( IddObjectType  type,
const SpaceLoadDefinition definition 
)
protected

Constructs a new SpaceLoadInstance object in the model.

Member Function Documentation

SpaceLoadDefinition openstudio::model::SpaceLoadInstance::definition ( ) const

Returns the definition of this instance.

double openstudio::model::SpaceLoadInstance::floorArea ( ) const

Returns the floor area associated with this space load instance.

If this space load is associated with a single space then that space's floor area is returned. If this space load is associated with a space type then the sum of all space floor area in that space type is returned. Space and SpaceLoadInstance multipliers are included in the result

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

Returns true if the multiplier is defaulted.

void openstudio::model::SpaceLoadInstance::makeUnique ( )

Ensures that no other instances share this instances definition.

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

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

int openstudio::model::SpaceLoadInstance::quantity ( ) const

Returns the number of instances this space load instance represents.

Space and SpaceLoadInstance multipliers are included in the result

bool openstudio::model::SpaceLoadInstance::setDefinition ( const SpaceLoadDefinition definition)

Sets the definition of this instance.

Friends And Related Function Documentation

typedef boost::optional<SpaceLoadInstance> OptionalSpaceLoadInstance
related
typedef std::vector<SpaceLoadInstance> SpaceLoadInstanceVector
related