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

#include <SpaceLoad.hpp>

+ Inheritance diagram for openstudio::model::SpaceLoad:

Public Member Functions

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...
 
SpaceLoadoperator= (const SpaceLoad &)=default
 
SpaceLoadoperator= (SpaceLoad &&)=default
 
void resetSpaceType ()
 
bool setSpaceType (const SpaceType &spaceType)
 Sets the parent SpaceType. More...
 
 SpaceLoad (const SpaceLoad &other)=default
 
 SpaceLoad (SpaceLoad &&other)=default
 
boost::optional< SpaceTypespaceType () const
 Returns the parent SpaceType. More...
 
virtual ~SpaceLoad ()=default
 
- Public Member Functions inherited from openstudio::model::SpaceItem
SpaceItemoperator= (const SpaceItem &)=default
 
SpaceItemoperator= (SpaceItem &&)=default
 
void resetSpace ()
 
bool setSpace (const Space &space)
 Sets the parent Space. More...
 
boost::optional< Spacespace () const
 Returns the parent Space. More...
 
 SpaceItem (const SpaceItem &other)=default
 
 SpaceItem (SpaceItem &&other)=default
 
virtual ~SpaceItem ()=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
 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.)

using OptionalSpaceLoad = boost::optional< SpaceLoad >
 
using SpaceLoadVector = std::vector< SpaceLoad >
 

Additional Inherited Members

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

Detailed Description

SpaceLoad is an abstract class derived from SpaceItem.

Constructor & Destructor Documentation

virtual openstudio::model::SpaceLoad::~SpaceLoad ( )
virtualdefault
openstudio::model::SpaceLoad::SpaceLoad ( const SpaceLoad other)
default
openstudio::model::SpaceLoad::SpaceLoad ( SpaceLoad &&  other)
default
openstudio::model::SpaceLoad::SpaceLoad ( IddObjectType  type,
const Model model 
)
protected

Constructs a new SpaceLoad object in the model.

Member Function Documentation

bool openstudio::model::SpaceLoad::hardApplySchedules ( )

Directly applies default schedules to this space load if found.

bool openstudio::model::SpaceLoad::hardSize ( )

Converts space load levels to absolute values rather than by per area, etc.

Also hard sizes any costs associated with this load. Only possible if this space load is parented by a space, returns false if parented by a space type.

bool openstudio::model::SpaceLoad::isAbsolute ( ) const

Returns true if the load represents an absolute quantity that must be added when combining space types.

SpaceLoad& openstudio::model::SpaceLoad::operator= ( const SpaceLoad )
default
SpaceLoad& openstudio::model::SpaceLoad::operator= ( SpaceLoad &&  )
default
void openstudio::model::SpaceLoad::resetSpaceType ( )
bool openstudio::model::SpaceLoad::setSpaceType ( const SpaceType spaceType)

Sets the parent SpaceType.

boost::optional<SpaceType> openstudio::model::SpaceLoad::spaceType ( ) const

Returns the parent SpaceType.

Friends And Related Function Documentation

using OptionalSpaceLoad = boost::optional<SpaceLoad>
related
using SpaceLoadVector = std::vector<SpaceLoad>
related