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

#include <WorkflowStepResult.hpp>

+ Inheritance diagram for openstudio::StepResult:

Public Types

enum  domain { BOOST_PP_SEQ_FOR_EACH =(OPENSTUDIO_ENUM_DOMAIN_ELEM, StepResult , ((Skip)(Skipped)(-2)) ((NA)(NotApplicable)(-1)) ((Success)(Pass)(0)) ((Fail)(Fail)(1)) ) }
 

Public Member Functions

 StepResult ()
 
 StepResult (const std::string &t_name)
 
 StepResult (int t_value)
 
domain value () const
 
- Public Member Functions inherited from EnumBase< StepResult >
 EnumBase ()=delete
 Default constructor. More...
 
 EnumBase (int t_value)
 Construct from t_value. More...
 
 EnumBase (const std::string &t_value)
 Construct from t_value. More...
 
int lookupValue (std::string t_name)
 Returns the (integer) value associated with t_name, as determined by case-insensitive comparison to the enumerated names and descriptions. More...
 
int lookupValue (int t_value)
 Returns t_value if it is in the domain. More...
 
bool operator!= (const StepResult &other) const
 
bool operator< (const StepResult &other) const
 
bool operator<= (const StepResult &other) const
 
bool operator== (const StepResult &other) const
 
bool operator> (const StepResult &other) const
 
bool operator>= (const StepResult &other) const
 
void setValue (int t_value)
 Set this instance's value to t_value. More...
 
int value () const
 Returns this instance's current value (as an integer). More...
 
std::string valueDescription () const
 Returns the description associated with this instance's current value. More...
 
std::string valueName () const
 Returns the name associated with this instance's current value. More...
 
- Public Member Functions inherited from StaticInitializer< StepResult >
 StaticInitializer ()
 

Static Public Member Functions

static std::string enumName ()
 
- Static Public Member Functions inherited from EnumBase< StepResult >
static const std::map< int,
std::string > & 
getDescriptions ()
 
static const std::map
< std::string, int > & 
getLookupMap ()
 
static const std::map< int,
std::string > & 
getNames ()
 
static const std::set< int > & getValues ()
 Returns the set of all values in this enum's domain. More...
 
static void initialize ()
 
static std::string valueDescription (int t_value)
 Returns the description associated with t_value, if it exists. More...
 
static std::string valueName (int t_value)
 Returns the name associated with t_value, if it exists. More...
 
- Static Public Member Functions inherited from StaticInitializer< StepResult >
static void do_initialize ()
 

Additional Inherited Members

- Protected Attributes inherited from EnumBase< StepResult >
int m_value
 

Detailed Description

Possible outcomes of running a WorkflowStep.

See the OPENSTUDIO_ENUM documentation in utilities/core/Enum.hpp. The actual macro call is:

OPENSTUDIO_ENUM( StepResult,
((Skip)(Skipped)(-2))
((NA)(NotApplicable)(-1))
((Success)(Pass)(0))
((Fail)(Fail)(1))
);

Member Enumeration Documentation

Enumerator
BOOST_PP_SEQ_FOR_EACH 

Constructor & Destructor Documentation

openstudio::StepResult::StepResult ( )
inline
openstudio::StepResult::StepResult ( const std::string &  t_name)
inline
openstudio::StepResult::StepResult ( int  t_value)
inline

Member Function Documentation

static std::string openstudio::StepResult::enumName ( )
inlinestatic
domain openstudio::StepResult::value ( ) const
inline