#include <EnergyPlusMeasure.hpp>
EnergyPlusMeasure is an abstract base class for OSMeasures that operate on EnergyPlus Workspaces.
virtual openstudio::measure::EnergyPlusMeasure::~EnergyPlusMeasure |
( |
| ) |
|
|
virtualdefault |
openstudio::measure::EnergyPlusMeasure::EnergyPlusMeasure |
( |
| ) |
|
|
protected |
virtual std::vector<OSArgument> openstudio::measure::EnergyPlusMeasure::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 std::vector<OSOutput> openstudio::measure::EnergyPlusMeasure::outputs |
( |
| ) |
const |
|
virtual |
Returns the outputs for this script.
The base class implementation returns an empty vector.
virtual bool openstudio::measure::EnergyPlusMeasure::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.prepareForMeasureRun(*this) and should be called at the beginning of derived class implementations of this method. (In C++, that call looks like EnergyPlusMeasure::run(workspace, runner, user_arguments). In Ruby that call looks like super(workspace, runner, user_arguments).