openstudio::measure::OSOutput Class Reference

#include <OSOutput.hpp>

Public Member Functions
Getters
std::string	name () const
	Returns the name of this output.
std::string	displayName () const
	Returns the display name of this output.
std::string	shortName () const
	Returns the short name of this output.
boost::optional< std::string >	description () const
	Returns the description of this output.
OSOutputType	type () const
	Returns this output's type.
boost::optional< std::string >	units () const
	Returns the units of this output.
bool	modelDependent () const
	Returns true if this output's properties can changed based on the specific model used in the measure.
Setters
void	setDisplayName (const std::string &displayName)
	Set the display name of this output.
void	setShortName (const std::string &shortName)
	Set the short name of this output.
void	setDescription (const std::string &description)
	Set the description of this output.
void	setUnits (const std::string &units)
	Set the units for this output.

Related Symbols
(Note that these are not member symbols.)
std::ostream &	operator<< (std::ostream &os, const OSOutput &arg)
	Prints argument data to ostream for debugging purposes.
using	OptionalOSOutput = boost::optional<OSOutput>
using	OSOutputVector = std::vector<OSOutput>

Serialization
std::string	print () const
	Prints output data for debugging purposes.
Json::Value	toJSON () const
std::string	toJSONString () const

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

Detailed Description

OSOutput is an output of an OSMeasure.

Constructor & Destructor Documentation

OSOutput() [1/2]

openstudio::measure::OSOutput::OSOutput

(

)

OSOutput() [2/2]

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

Member Function Documentation

description()

boost::optional< std::string > openstudio::measure::OSOutput::description

(

)

const

Returns the description of this output.

displayName()

std::string openstudio::measure::OSOutput::displayName

(

)

const

Returns the display name of this output.

makeBoolOutput()

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

static

Creates an OSOutput for bool values.

makeDoubleOutput()

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

static

Creates an OSOutput for double values.

makeIntegerOutput()

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

static

Creates an OSOutput for int values.

makeStringOutput()

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

static

Creates an OSOutput for string values.

modelDependent()

bool openstudio::measure::OSOutput::modelDependent

(

)

const

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

name()

std::string openstudio::measure::OSOutput::name

(

)

const

Returns the name of this output.

print()

std::string openstudio::measure::OSOutput::print

(

)

const

Prints output data for debugging purposes.

setDescription()

void openstudio::measure::OSOutput::setDescription

(

const std::string &

description

)

Set the description of this output.

setDisplayName()

void openstudio::measure::OSOutput::setDisplayName

(

const std::string &

displayName

)

Set the display name of this output.

setShortName()

void openstudio::measure::OSOutput::setShortName

(

const std::string &

shortName

)

Set the short name of this output.

setUnits()

void openstudio::measure::OSOutput::setUnits

(

const std::string &

units

)

Set the units for this output.

shortName()

std::string openstudio::measure::OSOutput::shortName

(

)

const

Returns the short name of this output.

toJSON()

Json::Value openstudio::measure::OSOutput::toJSON

(

)

const

toJSONString()

std::string openstudio::measure::OSOutput::toJSONString

(

)

const

type()

OSOutputType openstudio::measure::OSOutput::type

(

)

const

Returns this output's type.

units()

boost::optional< std::string > openstudio::measure::OSOutput::units

(

)

const

Returns the units of this output.

Friends And Related Symbol Documentation

operator<<()

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

related

Prints argument data to ostream for debugging purposes.

OptionalOSOutput

using OptionalOSOutput = boost::optional<OSOutput>

related

OSOutputVector

using OSOutputVector = std::vector<OSOutput>

related