openstudio::ruleset Namespace Reference

Classes
class	EmbeddedRubyUserScriptArgumentGetter
	Should only be instantiated in C++ Applications. More...
class	EmbeddedRubyUserScriptInfoGetter
	Should only be instantiated in C++ Applications. More...
class	ModelUserScript
	ModelUserScript is an abstract base class for UserScripts that operate on OpenStudio Models. More...
class	OSArgument
	OSArgument is an argument to a UserScript or a Ruleset. More...
class	OSArgumentType
	Listing of OSArgument data types. More...
class	OSDomainType
	Methods for restricting the domain of an OSArgument. More...
class	OSResult
	Class for documenting the outcome of running a UserScript or a Ruleset. More...
class	OSResultValue
	Possible outcomes of running a UserScript or a Ruleset. More...
class	OSRunner
	OSRunner is a concrete base class for application-specific classes that run UserScripts. More...
class	ReportingUserScript
	ReportingUserScript is an abstract base class for UserScripts that generate reports. More...
class	RubyUserScriptArgumentGetter
	Interface class for using embedded Ruby to extract arguments from a Ruby measure (UserScript). More...
class	RubyUserScriptInfo
	BCLMeasureInfo contains information that can be extracted from a by the Ruby parser. More...
class	RubyUserScriptInfoGetter
	Interface class for using embedded Ruby to extract arguments from a Ruby measure (UserScript). More...
class	TranslationUserScript
	TranslationUserScript is an abstract base class for UserScripts that operate on an OpenStudio Model and an OpenStudio Workspace. More...
class	UserScript
	UserScript is an abstract base class for a user script. More...
class	UtilityUserScript
	UtilityUserScript is an abstract base class for UserScripts that fulfill some purpose that is independent of any particular building energy model. More...
class	WorkspaceUserScript
	WorkspaceUserScript is an abstract base class for UserScripts that operate on OpenStudio Workspaces. More...

Typedefs
typedef boost::optional < OSArgumentType >	OptionalOSArgumentType
typedef boost::optional < OSDomainType >	OptionalOSDomainType
typedef boost::optional < OSResultValue >	OptionalOSResultValue
typedef OSArgumentType	UserScriptArgumentType
	Preserves old name for OSArgumentType. More...

Functions
std::ostream &	operator<< (std::ostream &os, const OSResultValue &e)
std::ostream &	operator<< (std::ostream &os, const OSArgumentType &e)
std::ostream &	operator<< (std::ostream &os, const OSDomainType &e)

Typedef Documentation

typedef boost::optional< OSArgumentType > openstudio::ruleset::OptionalOSArgumentType

typedef boost::optional< OSDomainType > openstudio::ruleset::OptionalOSDomainType

typedef boost::optional< OSResultValue > openstudio::ruleset::OptionalOSResultValue

typedef OSArgumentType openstudio::ruleset::UserScriptArgumentType

Preserves old name for OSArgumentType.

Deprecated:

Function Documentation

std::ostream& openstudio::ruleset::operator<< ( std::ostream &  os, const OSResultValue &  e  )

inline

std::ostream& openstudio::ruleset::operator<< ( std::ostream &  os, const OSArgumentType &  e  )

inline

std::ostream& openstudio::ruleset::operator<< ( std::ostream &  os, const OSDomainType &  e  )

inline