openstudio::RunOptions Class Reference

#include <RunOptions.hpp>

Public Member Functions
bool	cleanup () const
	Remove unnecessary files during post processing, defaults to true.
boost::optional< CustomOutputAdapter >	customOutputAdapter () const
bool	debug () const
	Print debugging messages, defaults to false.
bool	epjson () const
	Create, export and run using epjson format.
bool	fast () const
	Speeds up workflow by skipping steps not needed for running simulations, defaults to false.
OS_DEPRECATED std::string	forwardTranslateOptions () const
ForwardTranslatorOptions	forwardTranslatorOptions () const
bool	isCleanupDefaulted () const
bool	isDebugDefaulted () const
bool	isEpjsonDefaulted () const
bool	isFastDefaulted () const
bool	isPreserveRunDirDefaulted () const
bool	isSkipEnergyPlusPreprocessDefaulted () const
bool	isSkipExpandObjectsDefaulted () const
bool	isSkipZipResultsDefaulted () const
void	overrideValuesWith (const RunOptions &other)
bool	preserveRunDir () const
void	resetCleanup ()
void	resetCustomOutputAdapter ()
void	resetDebug ()
void	resetEpjson ()
void	resetFast ()
OS_DEPRECATED void	resetForwardTranslateOptions ()
void	resetForwardTranslatorOptions ()
void	resetPreserveRunDir ()
void	resetSkipEnergyPlusPreprocess ()
void	resetSkipExpandObjects ()
void	resetSkipZipResults ()
	RunOptions ()
bool	setCleanup (bool cleanup)
bool	setCustomOutputAdapter (const CustomOutputAdapter &adapter)
bool	setDebug (bool debug)
bool	setEpjson (bool epjson)
bool	setFast (bool fast)
OS_DEPRECATED bool	setForwardTranslateOptions (const std::string &options)
bool	setForwardTranslatorOptions (const ForwardTranslatorOptions &forwardTranslatorOptions)
bool	setPreserveRunDir (bool preserveRunDir)
bool	setSkipEnergyPlusPreprocess (bool skipEnergyPlusPreprocess)
bool	setSkipExpandObjects (bool skipExpandObjects)
bool	setSkipZipResults (bool skipZipResults)
bool	skipEnergyPlusPreprocess () const
	Does not add add default output requests to EnergyPlus input if true.
bool	skipExpandObjects () const
	Skips the call to the EnergyPlus ExpandObjects program, defaults to false.
bool	skipZipResults () const
	Skips creating the data_point.zip file.
std::string	string () const
	Serialize to JSON formatted string.
Json::Value	toJSON () const
virtual	~RunOptions ()

Static Public Member Functions
static boost::optional< RunOptions >	fromString (const std::string &s)
	Construct from JSON formatted string.

Detailed Description

Base class for defining a run options for a OpenStudio Workflow.

Constructor & Destructor Documentation

RunOptions()

openstudio::RunOptions::RunOptions

(

)

~RunOptions()

virtual openstudio::RunOptions::~RunOptions ( )

virtual

Member Function Documentation

cleanup()

bool openstudio::RunOptions::cleanup

(

)

const

Remove unnecessary files during post processing, defaults to true.

customOutputAdapter()

boost::optional< CustomOutputAdapter > openstudio::RunOptions::customOutputAdapter

(

)

const

debug()

bool openstudio::RunOptions::debug

(

)

const

Print debugging messages, defaults to false.

epjson()

bool openstudio::RunOptions::epjson

(

)

const

Create, export and run using epjson format.

Default is false

fast()

bool openstudio::RunOptions::fast

(

)

const

Speeds up workflow by skipping steps not needed for running simulations, defaults to false.

forwardTranslateOptions()

OS_DEPRECATED std::string openstudio::RunOptions::forwardTranslateOptions

(

)

const

forwardTranslatorOptions()

ForwardTranslatorOptions openstudio::RunOptions::forwardTranslatorOptions

(

)

const

fromString()

static boost::optional< RunOptions > openstudio::RunOptions::fromString ( const std::string & s )

static

Construct from JSON formatted string.

isCleanupDefaulted()

bool openstudio::RunOptions::isCleanupDefaulted

(

)

const

isDebugDefaulted()

bool openstudio::RunOptions::isDebugDefaulted

(

)

const

isEpjsonDefaulted()

bool openstudio::RunOptions::isEpjsonDefaulted

(

)

const

isFastDefaulted()

bool openstudio::RunOptions::isFastDefaulted

(

)

const

isPreserveRunDirDefaulted()

bool openstudio::RunOptions::isPreserveRunDirDefaulted

(

)

const

isSkipEnergyPlusPreprocessDefaulted()

bool openstudio::RunOptions::isSkipEnergyPlusPreprocessDefaulted

(

)

const

isSkipExpandObjectsDefaulted()

bool openstudio::RunOptions::isSkipExpandObjectsDefaulted

(

)

const

isSkipZipResultsDefaulted()

bool openstudio::RunOptions::isSkipZipResultsDefaulted

(

)

const

overrideValuesWith()

void openstudio::RunOptions::overrideValuesWith

(

const RunOptions &

other

)

preserveRunDir()

bool openstudio::RunOptions::preserveRunDir

(

)

const

resetCleanup()

void openstudio::RunOptions::resetCleanup

(

)

resetCustomOutputAdapter()

void openstudio::RunOptions::resetCustomOutputAdapter

(

)

resetDebug()

void openstudio::RunOptions::resetDebug

(

)

resetEpjson()

void openstudio::RunOptions::resetEpjson

(

)

resetFast()

void openstudio::RunOptions::resetFast

(

)

resetForwardTranslateOptions()

OS_DEPRECATED void openstudio::RunOptions::resetForwardTranslateOptions

(

)

resetForwardTranslatorOptions()

void openstudio::RunOptions::resetForwardTranslatorOptions

(

)

resetPreserveRunDir()

void openstudio::RunOptions::resetPreserveRunDir

(

)

resetSkipEnergyPlusPreprocess()

void openstudio::RunOptions::resetSkipEnergyPlusPreprocess

(

)

resetSkipExpandObjects()

void openstudio::RunOptions::resetSkipExpandObjects

(

)

resetSkipZipResults()

void openstudio::RunOptions::resetSkipZipResults

(

)

setCleanup()

bool openstudio::RunOptions::setCleanup

(

bool

cleanup

)

setCustomOutputAdapter()

bool openstudio::RunOptions::setCustomOutputAdapter

(

const CustomOutputAdapter &

adapter

)

setDebug()

bool openstudio::RunOptions::setDebug

(

bool

debug

)

setEpjson()

bool openstudio::RunOptions::setEpjson

(

bool

epjson

)

setFast()

bool openstudio::RunOptions::setFast

(

bool

fast

)

setForwardTranslateOptions()

OS_DEPRECATED bool openstudio::RunOptions::setForwardTranslateOptions

(

const std::string &

options

)

setForwardTranslatorOptions()

bool openstudio::RunOptions::setForwardTranslatorOptions

(

const ForwardTranslatorOptions &

forwardTranslatorOptions

)

setPreserveRunDir()

bool openstudio::RunOptions::setPreserveRunDir

(

bool

preserveRunDir

)

setSkipEnergyPlusPreprocess()

bool openstudio::RunOptions::setSkipEnergyPlusPreprocess

(

bool

skipEnergyPlusPreprocess

)

setSkipExpandObjects()

bool openstudio::RunOptions::setSkipExpandObjects

(

bool

skipExpandObjects

)

setSkipZipResults()

bool openstudio::RunOptions::setSkipZipResults

(

bool

skipZipResults

)

skipEnergyPlusPreprocess()

bool openstudio::RunOptions::skipEnergyPlusPreprocess

(

)

const

Does not add add default output requests to EnergyPlus input if true.

Requests from reporting measures are added in either case, defaults to false

skipExpandObjects()

bool openstudio::RunOptions::skipExpandObjects

(

)

const

Skips the call to the EnergyPlus ExpandObjects program, defaults to false.

skipZipResults()

bool openstudio::RunOptions::skipZipResults

(

)

const

Skips creating the data_point.zip file.

Setting to true can cause issues with workflows expecting .zip files to signal completion (e.g., OpenStudio Analysis Framework), defaults to false

string()

std::string openstudio::RunOptions::string

(

)

const

Serialize to JSON formatted string.

toJSON()

Json::Value openstudio::RunOptions::toJSON

(

)

const