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

#include <WorkflowStep.hpp>

+ Inheritance diagram for openstudio::MeasureStep:

Public Member Functions

std::map< std::string, Variantarguments () const
 
void clearArguments ()
 
boost::optional< std::string > description () const
 
boost::optional< VariantgetArgument (const std::string &name) const
 
std::string measureDirName () const
 
 MeasureStep (const std::string &measureDirName)
 
boost::optional< std::string > modelerDescription () const
 
boost::optional< std::string > name () const
 
void removeArgument (const std::string &name)
 
void resetDescription ()
 
void resetModelerDescription ()
 
void resetName ()
 
void setArgument (const std::string &name, const Variant &value)
 
void setArgument (const std::string &name, bool value)
 
void setArgument (const std::string &name, double value)
 
void setArgument (const std::string &name, int value)
 
void setArgument (const std::string &name, const char *value)
 
void setArgument (const std::string &name, const std::string &value)
 
bool setDescription (const std::string &description)
 
bool setModelerDescription (const std::string &modelerDescription)
 
bool setName (const std::string &name)
 
- Public Member Functions inherited from openstudio::WorkflowStep
template<typename T >
cast () const
 cast to type T, can throw std::bad_cast More...
 
bool operator== (const WorkflowStep &other) const
 Tests pointer equality. More...
 
template<typename T >
boost::optional< T > optionalCast () const
 cast to optional of type T More...
 
void resetResult ()
 Resets the optional WorkflowStepResult. More...
 
boost::optional
< WorkflowStepResult
result () const
 Returns the optional WorkflowStepResult. More...
 
void setResult (const WorkflowStepResult &result)
 Sets the optional WorkflowStepResult. More...
 
std::string string () const
 Serialize to JSON formatted string. More...
 
Json::Value toJSON () const
 
virtual ~WorkflowStep ()=default
 

Protected Member Functions

 MeasureStep (std::shared_ptr< detail::MeasureStep_Impl > impl)
 
bool setMeasureDirName (const std::string &measureDirName)
 
- Protected Member Functions inherited from openstudio::WorkflowStep
 WorkflowStep (std::shared_ptr< detail::WorkflowStep_Impl > impl)
 Protected constructor from impl. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from openstudio::WorkflowStep
static boost::optional
< WorkflowStep
fromString (const std::string &s)
 Construct from JSON formatted string. More...
 

Detailed Description

Base class for defining a step in an OpenStudio Workflow.

Constructor & Destructor Documentation

openstudio::MeasureStep::MeasureStep ( const std::string &  measureDirName)
openstudio::MeasureStep::MeasureStep ( std::shared_ptr< detail::MeasureStep_Impl >  impl)
protected

Member Function Documentation

std::map<std::string, Variant> openstudio::MeasureStep::arguments ( ) const
void openstudio::MeasureStep::clearArguments ( )
boost::optional<std::string> openstudio::MeasureStep::description ( ) const
boost::optional<Variant> openstudio::MeasureStep::getArgument ( const std::string &  name) const
std::string openstudio::MeasureStep::measureDirName ( ) const
boost::optional<std::string> openstudio::MeasureStep::modelerDescription ( ) const
boost::optional<std::string> openstudio::MeasureStep::name ( ) const
void openstudio::MeasureStep::removeArgument ( const std::string &  name)
void openstudio::MeasureStep::resetDescription ( )
void openstudio::MeasureStep::resetModelerDescription ( )
void openstudio::MeasureStep::resetName ( )
void openstudio::MeasureStep::setArgument ( const std::string &  name,
const Variant value 
)
void openstudio::MeasureStep::setArgument ( const std::string &  name,
bool  value 
)
void openstudio::MeasureStep::setArgument ( const std::string &  name,
double  value 
)
void openstudio::MeasureStep::setArgument ( const std::string &  name,
int  value 
)
void openstudio::MeasureStep::setArgument ( const std::string &  name,
const char *  value 
)
void openstudio::MeasureStep::setArgument ( const std::string &  name,
const std::string &  value 
)
bool openstudio::MeasureStep::setDescription ( const std::string &  description)
bool openstudio::MeasureStep::setMeasureDirName ( const std::string &  measureDirName)
protected
bool openstudio::MeasureStep::setModelerDescription ( const std::string &  modelerDescription)
bool openstudio::MeasureStep::setName ( const std::string &  name)