OpenStudio:measure
 All Classes Namespaces Functions Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::measure::OSOutput Class Reference

#include <OSOutput.hpp>

Public Member Functions

Constructors and Destructors
 OSOutput ()
 
 OSOutput (const std::string &name, const OSOutputType &type, bool modelDependent)
 
Getters
std::string name () const
 Returns the name of this output. More...
 
std::string displayName () const
 Returns the display name of this output. More...
 
std::string shortName () const
 Returns the short name of this output. More...
 
boost::optional< std::string > description () const
 Returns the description of this output. More...
 
OSOutputType type () const
 Returns this output's type. More...
 
boost::optional< std::string > units () const
 Returns the units of this output. More...
 
bool modelDependent () const
 Returns true if this output's properties can changed based on the specific model used in the measure. More...
 
Setters
void setDisplayName (const std::string &displayName)
 Set the display name of this output. More...
 
void setShortName (const std::string &shortName)
 Set the short name of this output. More...
 
void setDescription (const std::string &description)
 Set the description of this output. More...
 
void setUnits (const std::string &units)
 Set the units for this output. More...
 
Serialization
std::string print () const
 Prints output data for debugging purposes. More...
 
Json::Value toJSON () const
 
std::string toJSONString () const
 

Static Public Member Functions

static OSOutput makeBoolOutput (const std::string &name, bool modelDependent=false)
 Creates an OSOutput for bool values. More...
 
static OSOutput makeDoubleOutput (const std::string &name, bool modelDependent=false)
 Creates an OSOutput for double values. More...
 
static OSOutput makeIntegerOutput (const std::string &name, bool modelDependent=false)
 Creates an OSOutput for int values. More...
 
static OSOutput makeStringOutput (const std::string &name, bool modelDependent=false)
 Creates an OSOutput for string values. More...
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &os, const OSOutput &arg)
 Prints argument data to ostream for debugging purposes. More...
 
using OptionalOSOutput = boost::optional< OSOutput >
 
using OSOutputVector = std::vector< OSOutput >
 

Detailed Description

OSOutput is an output of an OSMeasure.

Constructor & Destructor Documentation

openstudio::measure::OSOutput::OSOutput ( )
openstudio::measure::OSOutput::OSOutput ( const std::string &  name,
const OSOutputType type,
bool  modelDependent 
)

Member Function Documentation

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

Returns the description of this output.

std::string openstudio::measure::OSOutput::displayName ( ) const

Returns the display name of this output.

static OSOutput openstudio::measure::OSOutput::makeBoolOutput ( const std::string &  name,
bool  modelDependent = false 
)
static

Creates an OSOutput for bool values.

static OSOutput openstudio::measure::OSOutput::makeDoubleOutput ( const std::string &  name,
bool  modelDependent = false 
)
static

Creates an OSOutput for double values.

static OSOutput openstudio::measure::OSOutput::makeIntegerOutput ( const std::string &  name,
bool  modelDependent = false 
)
static

Creates an OSOutput for int values.

static OSOutput openstudio::measure::OSOutput::makeStringOutput ( const std::string &  name,
bool  modelDependent = false 
)
static

Creates an OSOutput for string values.

bool openstudio::measure::OSOutput::modelDependent ( ) const

Returns true if this output's properties can changed based on the specific model used in the measure.

std::string openstudio::measure::OSOutput::name ( ) const

Returns the name of this output.

std::string openstudio::measure::OSOutput::print ( ) const

Prints output data for debugging purposes.

void openstudio::measure::OSOutput::setDescription ( const std::string &  description)

Set the description of this output.

void openstudio::measure::OSOutput::setDisplayName ( const std::string &  displayName)

Set the display name of this output.

void openstudio::measure::OSOutput::setShortName ( const std::string &  shortName)

Set the short name of this output.

void openstudio::measure::OSOutput::setUnits ( const std::string &  units)

Set the units for this output.

std::string openstudio::measure::OSOutput::shortName ( ) const

Returns the short name of this output.

Json::Value openstudio::measure::OSOutput::toJSON ( ) const
std::string openstudio::measure::OSOutput::toJSONString ( ) const
OSOutputType openstudio::measure::OSOutput::type ( ) const

Returns this output's type.

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

Returns the units of this output.

Friends And Related Function Documentation

std::ostream & operator<< ( std::ostream &  os,
const OSOutput arg 
)
related

Prints argument data to ostream for debugging purposes.

using OptionalOSOutput = boost::optional<OSOutput>
related
using OSOutputVector = std::vector<OSOutput>
related