OpenStudioCore:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "SpaceLoad.hpp"

Inheritance diagram for openstudio::model::SpaceLoad:

Public Member Functions

bool hardApplySchedules ()
bool hardSize ()
bool isAbsolute () const
void resetSpaceType ()
bool setSpaceType (const SpaceType &spaceType)
boost::optional< SpaceTypespaceType () const
virtual ~SpaceLoad ()

Protected Member Functions

 SpaceLoad (IddObjectType type, const Model &model)

Related Functions

typedef boost::optional
< SpaceLoad
OptionalSpaceLoad
typedef std::vector< SpaceLoadSpaceLoadVector

Detailed Description

SpaceLoad is an abstract class derived from SpaceItem.

Constructor & Destructor Documentation

virtual openstudio::model::SpaceLoad::~SpaceLoad ( )
inlinevirtual
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.

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

typedef boost::optional<SpaceLoad> OptionalSpaceLoad
related
typedef std::vector<SpaceLoad> SpaceLoadVector
related