openstudio::ruleset::WorkspaceUserScript Class Reference

#include <WorkspaceUserScript.hpp>

Inheritance diagram for openstudio::ruleset::WorkspaceUserScript:

Public Member Functions
Constructors and Destructors
virtual	~WorkspaceUserScript ()
Getters
virtual std::vector< OSArgument >	arguments (const openstudio::Workspace &workspace) const
	Returns the arguments for this script. More...
Actions
virtual bool	run (openstudio::Workspace &workspace, OSRunner &runner, const std::map< std::string, OSArgument > &user_arguments) const
	Run the script on the given workspace with the given runner and user_arguments. More...
Public Member Functions inherited from openstudio::ruleset::UserScript
virtual	~UserScript ()
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...
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...

Protected Member Functions
	WorkspaceUserScript ()
Protected Member Functions inherited from openstudio::ruleset::UserScript
	UserScript ()

Additional Inherited Members
Related Functions inherited from openstudio::ruleset::UserScript
typedef boost::optional < UserScript >	OptionalUserScript
typedef std::vector< UserScript >	UserScriptVector

Detailed Description

WorkspaceUserScript is an abstract base class for UserScripts that operate on OpenStudio Workspaces.

Most commonly, WorkspaceUserScripts will be designed to operate on EnergyPlus IDFs.

Constructor & Destructor Documentation

virtual openstudio::ruleset::WorkspaceUserScript::~WorkspaceUserScript ( )

virtual

openstudio::ruleset::WorkspaceUserScript::WorkspaceUserScript ( )

inlineprotected

Member Function Documentation

virtual std::vector<OSArgument> openstudio::ruleset::WorkspaceUserScript::arguments ( const openstudio::Workspace &  workspace ) const

virtual

Returns the arguments for this script.

In interactive applications, an OSRunner presents these arguments to the user to produce an OSArgumentMap of user_arguments that it then passes to this script's run method. The same basic steps should happen in applications with non- interactive scripts, but in that case an entity other than an OSRunner may be in charge of collecting user arguments. The base class implementation returns an empty vector.

virtual bool openstudio::ruleset::WorkspaceUserScript::run ( openstudio::Workspace &  workspace, OSRunner &  runner, const std::map< std::string, OSArgument > &  user_arguments  ) const

virtual

Run the script on the given workspace with the given runner and user_arguments.

The base class implementation calls runner.prepareForUserScriptRun(*this) and should be called at the beginning of derived class implementations of this method. (In C++, that call looks like WorkspaceUserScript::run(workspace, runner, user_arguments). In Ruby that call looks like super(workspace, runner, user_arguments).