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

#include "UtilityCost_Computation.hpp"

Inheritance diagram for openstudio::model::UtilityCost_Computation:

Public Member Functions

unsigned maxComputeSteps () const
unsigned numComputeSteps () const
 UtilityCost_Computation (const Model &model)
virtual ~UtilityCost_Computation ()
boost::optional< std::string > name () const
boost::optional< std::string > tariffName () const
boost::optional< std::string > computeStep (unsigned index) const
void setName (const std::string &name)
void setTariffName (const std::string &tariffName)
bool setComputeStep (unsigned index, const std::string &computeStep)

Static Public Member Functions

static IddObjectType iddObjectType ()

Related Functions

typedef boost::optional
< UtilityCost_Computation
OptionalUtilityCost_Computation
typedef std::vector
< UtilityCost_Computation
UtilityCost_ComputationVector

Detailed Description

UtilityCost_Computation derives from ParentObject and is an interface to the OpenStudio IDD object named "OS:UtilityCost:Computation".

UtilityCost_Computation lists a series of computations that are used to perform the bill calculation. This object is only used for complex tariffs that cannot be modeled any other way.

Constructor & Destructor Documentation

openstudio::model::UtilityCost_Computation::UtilityCost_Computation ( const Model model)
explicit

Constructs a new UtilityCost_Computation object in the model.

virtual openstudio::model::UtilityCost_Computation::~UtilityCost_Computation ( )
inlinevirtual

Member Function Documentation

boost::optional<std::string> openstudio::model::UtilityCost_Computation::computeStep ( unsigned  index) const

Get compute step at index.

Index starts at 0.

static IddObjectType openstudio::model::UtilityCost_Computation::iddObjectType ( )
static

Returns the IddObjectType.

unsigned openstudio::model::UtilityCost_Computation::maxComputeSteps ( ) const

Returns the maximum number of compute steps that may be specified, e.g. the maximum number of extensible fields.

boost::optional<std::string> openstudio::model::UtilityCost_Computation::name ( ) const
unsigned openstudio::model::UtilityCost_Computation::numComputeSteps ( ) const

Returns the number of compute steps specified, e.g. the number of extensible fields.

bool openstudio::model::UtilityCost_Computation::setComputeStep ( unsigned  index,
const std::string &  computeStep 
)

Set compute step at index.

Index starts at 0.

void openstudio::model::UtilityCost_Computation::setName ( const std::string &  name)
void openstudio::model::UtilityCost_Computation::setTariffName ( const std::string &  tariffName)
boost::optional<std::string> openstudio::model::UtilityCost_Computation::tariffName ( ) const

Friends And Related Function Documentation

typedef boost::optional<UtilityCost_Computation> OptionalUtilityCost_Computation
related