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

#include "MeterCustom.hpp"

Inheritance diagram for openstudio::model::MeterCustom:

Public Member Functions

 MeterCustom (const Model &model)
virtual ~MeterCustom ()
boost::optional< std::string > fuelType () const
std::vector< std::pair
< std::string, std::string > > 
keyVarGroups ()
unsigned numKeyVarGroups () const
boost::optional< std::string > keyName (unsigned index) const
boost::optional< std::string > outputVariableorMeterName (unsigned index) const
bool setFuelType (const std::string &fuelType)
void resetFuelType ()
bool addKeyVarGroup (const std::string &keyName, const std::string &outputVariableorMeterName)
bool removeKeyVarGroup (unsigned groupIndex)
void removeAllKeyVarGroups ()
bool setKeyName (unsigned index, const std::string &str)
bool setOutputVariableorMeterName (unsigned index, const std::string &str)

Static Public Member Functions

static std::vector< std::string > fuelTypeValues ()
static IddObjectType iddObjectType ()

Related Functions

typedef std::vector< MeterCustomMeterCustomVector
typedef boost::optional
< MeterCustom
OptionalMeterCustom

Detailed Description

MeterCustom is a ModelObject that wraps the OpenStudio IDD object 'OS:Meter:Custom'.

Constructor & Destructor Documentation

openstudio::model::MeterCustom::MeterCustom ( const Model model)
explicit
virtual openstudio::model::MeterCustom::~MeterCustom ( )
inlinevirtual

Member Function Documentation

bool openstudio::model::MeterCustom::addKeyVarGroup ( const std::string &  keyName,
const std::string &  outputVariableorMeterName 
)
boost::optional<std::string> openstudio::model::MeterCustom::fuelType ( ) const
static std::vector<std::string> openstudio::model::MeterCustom::fuelTypeValues ( )
static
static IddObjectType openstudio::model::MeterCustom::iddObjectType ( )
static
boost::optional<std::string> openstudio::model::MeterCustom::keyName ( unsigned  index) const

Get the Key Name at index.

Indexing starts at 0.

std::vector< std::pair<std::string, std::string> > openstudio::model::MeterCustom::keyVarGroups ( )
unsigned openstudio::model::MeterCustom::numKeyVarGroups ( ) const
boost::optional<std::string> openstudio::model::MeterCustom::outputVariableorMeterName ( unsigned  index) const

Get the Output Variable of Meter Name at index.

Indexing starts at 0.

void openstudio::model::MeterCustom::removeAllKeyVarGroups ( )
bool openstudio::model::MeterCustom::removeKeyVarGroup ( unsigned  groupIndex)
void openstudio::model::MeterCustom::resetFuelType ( )
bool openstudio::model::MeterCustom::setFuelType ( const std::string &  fuelType)
bool openstudio::model::MeterCustom::setKeyName ( unsigned  index,
const std::string &  str 
)

Set the Key Name at index.

Indexing starts at 0.

bool openstudio::model::MeterCustom::setOutputVariableorMeterName ( unsigned  index,
const std::string &  str 
)

Set the Output Variable of Meter Name at index.

Indexing starts at 0.

Friends And Related Function Documentation

typedef std::vector<MeterCustom> MeterCustomVector
related
typedef boost::optional<MeterCustom> OptionalMeterCustom
related