openstudio::ruleset::OSResultValue Class Reference

#include <OSResult.hpp>

Inheritance diagram for openstudio::ruleset::OSResultValue:

Public Types
enum	domain { BOOST_PP_SEQ_FOR_EACH =(OPENSTUDIO_ENUM_DOMAIN_ELEM, OSResultValue , ((NA)(NotApplicable)(-1)) ((Success)(Pass)(0)) ((Fail)(Fail)(1)) ) }

Public Member Functions
	OSResultValue ()
	OSResultValue (const std::string &t_name)
	OSResultValue (int t_value)
domain	value () const

Static Public Member Functions
static std::string	enumName ()

Detailed Description

Possible outcomes of running a UserScript or a Ruleset.

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

OPENSTUDIO_ENUM( OSResultValue,
  ((NA)(NotApplicable)(-1))
  ((Success)(Pass)(0))
  ((Fail)(Fail)(1))
);

Member Enumeration Documentation

enum openstudio::ruleset::OSResultValue::domain

Enumerator
BOOST_PP_SEQ_FOR_EACH

Constructor & Destructor Documentation

openstudio::ruleset::OSResultValue::OSResultValue ( )

inline

openstudio::ruleset::OSResultValue::OSResultValue ( const std::string &  t_name )

inline

openstudio::ruleset::OSResultValue::OSResultValue ( int  t_value )

inline

Member Function Documentation

static std::string openstudio::ruleset::OSResultValue::enumName ( )

inlinestatic

domain openstudio::ruleset::OSResultValue::value ( ) const

inline