#include <ValidityEnums.hpp>

Inheritance diagram for openstudio::Scope:

Public Types
enum	domain { BOOST_PP_SEQ_FOR_EACH =(OPENSTUDIO_ENUM_DOMAIN_ELEM, Scope , ((Field)) ((Object)) ((Collection)) ) }

Public Member Functions
	Scope ()

	Scope (const std::string &t_name)

	Scope (int t_value)

domain	value () const

Public Member Functions inherited from EnumBase< Scope >
	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 Scope &other) const

bool	operator< (const Scope &other) const

bool	operator<= (const Scope &other) const

bool	operator== (const Scope &other) const

bool	operator> (const Scope &other) const

bool	operator>= (const Scope &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< Scope >
	StaticInitializer ()

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

Static Public Member Functions inherited from EnumBase< Scope >
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< Scope >
static void	do_initialize ()

Additional Inherited Members
Protected Attributes inherited from EnumBase< Scope >
int	m_value

Detailed Description

Indicates whether a ValidityReport or DataError pertains to a single field, a single object, or the entire collection.

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

OPENSTUDIO_ENUM(Scope,
  ((Field))
  ((Object))
  ((Collection))
);

Member Enumeration Documentation

Enumerator
BOOST_PP_SEQ_FOR_EACH

openstudio::Scope::Scope ( )

inline

openstudio::Scope::Scope ( const std::string & t_name )

inline

openstudio::Scope::Scope ( int t_value )

inline

static std::string openstudio::Scope::enumName ( )

inlinestatic

domain openstudio::Scope::value ( ) const

inline