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

#include "ExteriorLoadInstance.hpp"

Inheritance diagram for openstudio::model::ExteriorLoadInstance:

Public Member Functions

ExteriorLoadDefinition definition () const
bool isMultiplierDefaulted () const
void makeUnique ()
double multiplier () const
int quantity () const
bool setDefinition (const ExteriorLoadDefinition &definition)
virtual ~ExteriorLoadInstance ()

Protected Member Functions

 ExteriorLoadInstance (IddObjectType type, const ExteriorLoadDefinition &definition)

Related Functions

typedef std::vector
< ExteriorLoadInstance
ExteriorLoadInstanceVector
typedef boost::optional
< ExteriorLoadInstance
OptionalExteriorLoadInstance

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 ( )
inlinevirtual
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.

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

typedef std::vector<ExteriorLoadInstance> ExteriorLoadInstanceVector
related
typedef boost::optional<ExteriorLoadInstance> OptionalExteriorLoadInstance
related