 |
OpenStudioCore:ruleset |
#include <UtilityUserScript.hpp>
Inheritance diagram for openstudio::ruleset::UtilityUserScript:Public Member Functions | |
Constructors and Destructors | |
| virtual | ~UtilityUserScript () |
Getters | |
| virtual std::vector< OSArgument > | arguments () const |
| Returns the arguments for this script. More... | |
Actions | |
| virtual bool | run (OSRunner &runner, const std::map< std::string, OSArgument > &user_arguments) const |
| Run the script 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 | |
| UtilityUserScript () | |
| 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 |
UtilityUserScript is an abstract base class for UserScripts that fulfill some purpose that is independent of any particular building energy model.
|
virtual |
|
inlineprotected |
|
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 |
Run the script 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 UtilityUserScript::run(runner, user_arguments). In Ruby that call looks like super(runner, user_arguments).