OpenStudio:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Related Functions | List of all members
openstudio::BCLMeasureArgument Class Reference

#include <BCLMeasureArgument.hpp>

Public Member Functions

 BCLMeasureArgument (const pugi::xml_node &element)
 
 BCLMeasureArgument (const std::string &name, const std::string &displayName, const boost::optional< std::string > &description, const std::string &type, const boost::optional< std::string > &units, bool required, bool modelDependent, const boost::optional< std::string > &defaultValue, const std::vector< std::string > &choiceValues, const std::vector< std::string > &choiceDisplayNames, const boost::optional< std::string > &minValue, const boost::optional< std::string > &maxValue)
 
std::vector< std::string > choiceDisplayNames () const
 
std::vector< std::string > choiceValues () const
 
boost::optional< std::string > defaultValue () const
 
boost::optional< std::string > description () const
 
std::string displayName () const
 
boost::optional< std::string > maxValue () const
 
boost::optional< std::string > minValue () const
 
bool modelDependent () const
 
std::string name () const
 
bool operator== (const BCLMeasureArgument &other) const
 
bool required () const
 
Json::Value toJSON () const
 
std::string toJSONString () const
 
std::string type () const
 
boost::optional< std::string > units () const
 
void writeValues (pugi::xml_node &element) const
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &os, const BCLMeasureArgument &argument)
 Prints BCLMeasureArgument to os. More...
 

Detailed Description

BCLMeasureArgument is a class representing an argument of a measure.

This class does not hold the particular value of any argument, it simply declares that the BCLMeasure has this argument.

Constructor & Destructor Documentation

openstudio::BCLMeasureArgument::BCLMeasureArgument ( const pugi::xml_node &  element)
openstudio::BCLMeasureArgument::BCLMeasureArgument ( const std::string &  name,
const std::string &  displayName,
const boost::optional< std::string > &  description,
const std::string &  type,
const boost::optional< std::string > &  units,
bool  required,
bool  modelDependent,
const boost::optional< std::string > &  defaultValue,
const std::vector< std::string > &  choiceValues,
const std::vector< std::string > &  choiceDisplayNames,
const boost::optional< std::string > &  minValue,
const boost::optional< std::string > &  maxValue 
)

Member Function Documentation

std::vector<std::string> openstudio::BCLMeasureArgument::choiceDisplayNames ( ) const
std::vector<std::string> openstudio::BCLMeasureArgument::choiceValues ( ) const
boost::optional<std::string> openstudio::BCLMeasureArgument::defaultValue ( ) const
boost::optional<std::string> openstudio::BCLMeasureArgument::description ( ) const
std::string openstudio::BCLMeasureArgument::displayName ( ) const
boost::optional<std::string> openstudio::BCLMeasureArgument::maxValue ( ) const
boost::optional<std::string> openstudio::BCLMeasureArgument::minValue ( ) const
bool openstudio::BCLMeasureArgument::modelDependent ( ) const
std::string openstudio::BCLMeasureArgument::name ( ) const
bool openstudio::BCLMeasureArgument::operator== ( const BCLMeasureArgument other) const
bool openstudio::BCLMeasureArgument::required ( ) const
Json::Value openstudio::BCLMeasureArgument::toJSON ( ) const
std::string openstudio::BCLMeasureArgument::toJSONString ( ) const
std::string openstudio::BCLMeasureArgument::type ( ) const
boost::optional<std::string> openstudio::BCLMeasureArgument::units ( ) const
void openstudio::BCLMeasureArgument::writeValues ( pugi::xml_node &  element) const

Friends And Related Function Documentation

std::ostream & operator<< ( std::ostream &  os,
const BCLMeasureArgument argument 
)
related

Prints BCLMeasureArgument to os.