 |
OpenStudio:model |
#include "SpaceLoadInstance.hpp"
Public Member Functions | |
| SpaceLoadDefinition | definition () const |
| double | floorArea () const |
| bool | isMultiplierDefaulted () const |
| void | makeUnique () |
| double | multiplier () const |
| int | quantity () const |
| bool | setDefinition (const SpaceLoadDefinition &definition) |
| virtual | ~SpaceLoadInstance () |
Protected Member Functions | |
| SpaceLoadInstance (IddObjectType type, const SpaceLoadDefinition &definition) | |
Related Functions | |
| typedef boost::optional < SpaceLoadInstance > | OptionalSpaceLoadInstance |
| typedef std::vector < SpaceLoadInstance > | SpaceLoadInstanceVector |
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.
|
inlinevirtual |
|
protected |
Constructs a new SpaceLoadInstance object in the model.
| 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.
|
related |
|
related |