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

#include <RunOptions.hpp>

Public Member Functions

bool cleanup () const
 
boost::optional
< CustomOutputAdapter
customOutputAdapter () const
 
bool debug () const
 
bool epjson () const
 
bool fast () const
 
std::string forwardTranslateOptions () const
 
bool preserveRunDir () const
 
void resetCleanup ()
 
void resetCustomOutputAdapter ()
 
void resetDebug ()
 
void resetEpjson ()
 
void resetFast ()
 
void resetForwardTranslateOptions ()
 
void resetPreserveRunDir ()
 
void resetSkipEnergyPlusPreprocess ()
 
void resetSkipExpandObjects ()
 
 RunOptions ()
 
bool setCleanup (bool cleanup)
 
bool setCustomOutputAdapter (const CustomOutputAdapter &adapter)
 
bool setDebug (bool debug)
 
bool setEpjson (bool epjson)
 
bool setFast (bool fast)
 
bool setForwardTranslateOptions (const std::string &options)
 
bool setPreserveRunDir (bool preserve)
 
bool setSkipEnergyPlusPreprocess (bool skip)
 
bool setSkipExpandObjects (bool skip)
 
bool skipEnergyPlusPreprocess () const
 
bool skipExpandObjects () const
 
std::string string () const
 Serialize to JSON formatted string. More...
 
virtual ~RunOptions ()
 

Static Public Member Functions

static boost::optional
< RunOptions
fromString (const std::string &s)
 Construct from JSON formatted string. More...
 

Detailed Description

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

Constructor & Destructor Documentation

openstudio::RunOptions::RunOptions ( )
virtual openstudio::RunOptions::~RunOptions ( )
virtual

Member Function Documentation

bool openstudio::RunOptions::cleanup ( ) const
boost::optional<CustomOutputAdapter> openstudio::RunOptions::customOutputAdapter ( ) const
bool openstudio::RunOptions::debug ( ) const
bool openstudio::RunOptions::epjson ( ) const
bool openstudio::RunOptions::fast ( ) const
std::string openstudio::RunOptions::forwardTranslateOptions ( ) const
static boost::optional<RunOptions> openstudio::RunOptions::fromString ( const std::string &  s)
static

Construct from JSON formatted string.

bool openstudio::RunOptions::preserveRunDir ( ) const
void openstudio::RunOptions::resetCleanup ( )
void openstudio::RunOptions::resetCustomOutputAdapter ( )
void openstudio::RunOptions::resetDebug ( )
void openstudio::RunOptions::resetEpjson ( )
void openstudio::RunOptions::resetFast ( )
void openstudio::RunOptions::resetForwardTranslateOptions ( )
void openstudio::RunOptions::resetPreserveRunDir ( )
void openstudio::RunOptions::resetSkipEnergyPlusPreprocess ( )
void openstudio::RunOptions::resetSkipExpandObjects ( )
bool openstudio::RunOptions::setCleanup ( bool  cleanup)
bool openstudio::RunOptions::setCustomOutputAdapter ( const CustomOutputAdapter adapter)
bool openstudio::RunOptions::setDebug ( bool  debug)
bool openstudio::RunOptions::setEpjson ( bool  epjson)
bool openstudio::RunOptions::setFast ( bool  fast)
bool openstudio::RunOptions::setForwardTranslateOptions ( const std::string &  options)
bool openstudio::RunOptions::setPreserveRunDir ( bool  preserve)
bool openstudio::RunOptions::setSkipEnergyPlusPreprocess ( bool  skip)
bool openstudio::RunOptions::setSkipExpandObjects ( bool  skip)
bool openstudio::RunOptions::skipEnergyPlusPreprocess ( ) const
bool openstudio::RunOptions::skipExpandObjects ( ) const
std::string openstudio::RunOptions::string ( ) const

Serialize to JSON formatted string.