openstudio::ruleset::UserScript Class Reference

#include <UserScript.hpp>

Inheritance diagram for openstudio::ruleset::UserScript:

Public Member Functions
Constructors and Destructors
virtual	~UserScript ()
Getters
virtual std::string	name () const
	user facing name of this script, defaults to empty More...
virtual std::string	description () const
	user facing description of this script, defaults to empty More...
virtual std::string	modeler_description () const
	user facing technical description of this script, defaults to empty More...

Related Functions
(Note that these are not member functions.)
typedef boost::optional < UserScript >	OptionalUserScript
typedef std::vector< UserScript >	UserScriptVector

Actions
virtual OS_DEPRECATED bool	registerWithSketchUp () const
	Register this script with SketchUp. More...
virtual OS_DEPRECATED bool	registerWithApplication () const
	Register this script with an Application. More...
	UserScript ()

Detailed Description

UserScript is an abstract base class for a user script.

There are derived types that operate on OpenStudio Models and EnergyPlus Workspaces.

Constructor & Destructor Documentation

virtual openstudio::ruleset::UserScript::~UserScript ( )

virtual

openstudio::ruleset::UserScript::UserScript ( )

inlineprotected

Member Function Documentation

virtual std::string openstudio::ruleset::UserScript::description ( ) const

virtual

user facing description of this script, defaults to empty

virtual std::string openstudio::ruleset::UserScript::modeler_description ( ) const

virtual

user facing technical description of this script, defaults to empty

virtual std::string openstudio::ruleset::UserScript::name ( ) const

virtual

user facing name of this script, defaults to empty

virtual OS_DEPRECATED bool openstudio::ruleset::UserScript::registerWithApplication ( ) const

virtual

Register this script with an Application.

Base class implementation does nothing and returns false.

Deprecated:

virtual OS_DEPRECATED bool openstudio::ruleset::UserScript::registerWithSketchUp ( ) const

virtual

Register this script with SketchUp.

Deprecated in favor of registerWithApplication(). Base class implementation does nothing and returns false.

Deprecated:

Friends And Related Function Documentation

typedef boost::optional<UserScript> OptionalUserScript

related

typedef std::vector<UserScript> UserScriptVector

related