UtilityCost_Ratchet Class Reference

#include "UtilityCost_Ratchet.hpp"

Inheritance diagram for openstudio::model::UtilityCost_Ratchet:

Public Member Functions
	UtilityCost_Ratchet (const Model &model)
virtual	~UtilityCost_Ratchet ()
boost::optional< std::string >	tariffName () const
boost::optional< std::string >	baselineSourceVariable () const
boost::optional< std::string >	adjustmentSourceVariable () const
boost::optional< std::string >	seasonFrom () const
boost::optional< std::string >	seasonTo () const
boost::optional< std::string >	multiplierValueOrVariableName () const
boost::optional< std::string >	offsetValueOrVariableName () const
void	setTariffName (const std::string &tariffName)
void	setBaselineSourceVariable (const std::string &baselineSourceVariable)
void	setAdjustmentSourceVariable (const std::string &adjustmentSourceVariable)
void	setSeasonFrom (const std::string &seasonFrom)
void	setSeasonTo (const std::string &seasonTo)
void	setMultiplierValueOrVariableName (const std::string &multiplierValueOrVariableName)
void	setOffsetValueOrVariableName (const std::string &offsetValueOrVariableName)

Static Public Member Functions
static IddObjectType	iddObjectType ()

Related Functions
typedef boost::optional < UtilityCost_Ratchet >	OptionalUtilityCost_Ratchet
typedef std::vector < UtilityCost_Ratchet >	UtilityCost_RatchetVector

Detailed Description

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

UtilityCost_Ratchet allows the modeling of tariffs that include some type of seasonal ratcheting. Ratchets are most common when used with electric demand charges.

Constructor & Destructor Documentation

openstudio::model::UtilityCost_Ratchet::UtilityCost_Ratchet ( const Model &  model )

explicit

Constructs a new UtilityCost_Ratchet object in the model.

virtual openstudio::model::UtilityCost_Ratchet::~UtilityCost_Ratchet ( )

inlinevirtual

Member Function Documentation

boost::optional<std::string> openstudio::model::UtilityCost_Ratchet::adjustmentSourceVariable

(

)

const

boost::optional<std::string> openstudio::model::UtilityCost_Ratchet::baselineSourceVariable

(

)

const

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

static

Returns the IddObjectType.

boost::optional<std::string> openstudio::model::UtilityCost_Ratchet::multiplierValueOrVariableName

(

)

const

boost::optional<std::string> openstudio::model::UtilityCost_Ratchet::offsetValueOrVariableName

(

)

const

boost::optional<std::string> openstudio::model::UtilityCost_Ratchet::seasonFrom

(

)

const

boost::optional<std::string> openstudio::model::UtilityCost_Ratchet::seasonTo

(

)

const

void openstudio::model::UtilityCost_Ratchet::setAdjustmentSourceVariable

(

const std::string &

adjustmentSourceVariable

)

void openstudio::model::UtilityCost_Ratchet::setBaselineSourceVariable

(

const std::string &

baselineSourceVariable

)

void openstudio::model::UtilityCost_Ratchet::setMultiplierValueOrVariableName

(

const std::string &

multiplierValueOrVariableName

)

void openstudio::model::UtilityCost_Ratchet::setOffsetValueOrVariableName

(

const std::string &

offsetValueOrVariableName

)

void openstudio::model::UtilityCost_Ratchet::setSeasonFrom

(

const std::string &

seasonFrom

)

void openstudio::model::UtilityCost_Ratchet::setSeasonTo

(

const std::string &

seasonTo

)

void openstudio::model::UtilityCost_Ratchet::setTariffName

(

const std::string &

tariffName

)

boost::optional<std::string> openstudio::model::UtilityCost_Ratchet::tariffName

(

)

const

Friends And Related Function Documentation

typedef boost::optional<UtilityCost_Ratchet> OptionalUtilityCost_Ratchet

related

typedef std::vector<UtilityCost_Ratchet> UtilityCost_RatchetVector

related