OpenStudio:utilities
Loading...
Searching...
No Matches
openstudio::BCLMeasureOutput Class Reference

#include <BCLMeasureOutput.hpp>

Public Member Functions

 BCLMeasureOutput (const pugi::xml_node &element)
 
 BCLMeasureOutput (const std::string &name, const std::string &displayName, const boost::optional< std::string > &shortName, const boost::optional< std::string > &description, const std::string &type, const boost::optional< std::string > &units, bool modelDependent)
 
boost::optional< std::string > description () const
 
std::string displayName () const
 
bool modelDependent () const
 
std::string name () const
 
bool operator== (const BCLMeasureOutput &other) const
 
boost::optional< std::string > shortName () 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 Symbols

(Note that these are not member symbols.)

std::ostream & operator<< (std::ostream &os, const BCLMeasureOutput &output)
 Prints BCLMeasureOutput to os.
 

Detailed Description

BCLMeasureOutput is a class representing an output of a measure.

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

Constructor & Destructor Documentation

◆ BCLMeasureOutput() [1/2]

openstudio::BCLMeasureOutput::BCLMeasureOutput ( const pugi::xml_node & element)

◆ BCLMeasureOutput() [2/2]

openstudio::BCLMeasureOutput::BCLMeasureOutput ( const std::string & name,
const std::string & displayName,
const boost::optional< std::string > & shortName,
const boost::optional< std::string > & description,
const std::string & type,
const boost::optional< std::string > & units,
bool modelDependent )

Member Function Documentation

◆ description()

boost::optional< std::string > openstudio::BCLMeasureOutput::description ( ) const

◆ displayName()

std::string openstudio::BCLMeasureOutput::displayName ( ) const

◆ modelDependent()

bool openstudio::BCLMeasureOutput::modelDependent ( ) const

◆ name()

std::string openstudio::BCLMeasureOutput::name ( ) const

◆ operator==()

bool openstudio::BCLMeasureOutput::operator== ( const BCLMeasureOutput & other) const

◆ shortName()

boost::optional< std::string > openstudio::BCLMeasureOutput::shortName ( ) const

◆ toJSON()

Json::Value openstudio::BCLMeasureOutput::toJSON ( ) const

◆ toJSONString()

std::string openstudio::BCLMeasureOutput::toJSONString ( ) const

◆ type()

std::string openstudio::BCLMeasureOutput::type ( ) const

◆ units()

boost::optional< std::string > openstudio::BCLMeasureOutput::units ( ) const

◆ writeValues()

void openstudio::BCLMeasureOutput::writeValues ( pugi::xml_node & element) const

Friends And Related Symbol Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream & os,
const BCLMeasureOutput & output )
related

Prints BCLMeasureOutput to os.