OpenStudioCore:ruleset
 All Classes Namespaces Functions Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
openstudio::ruleset::RubyUserScriptInfo Class Reference

#include <RubyUserScriptInfoGetter.hpp>

Public Member Functions

std::vector< OSArgumentarguments () const
 result of measure's arguments method called with empty model if information was successfully extracted from the script, otherwise empty More...
 
std::string className () const
 name of measure class if information was successfully extracted from the script, otherwise empty More...
 
std::string description () const
 result of measure's description method if information was successfully extracted from the script, otherwise empty More...
 
boost::optional< std::string > error () const
 will be empty if information was successfully extracted from the script, otherwise includes error information More...
 
MeasureType measureType () const
 type of measure if information was successfully extracted from the script, otherwise undefined More...
 
std::string modelerDescription () const
 result of measure's modeler_description method if information was successfully extracted from the script, otherwise empty More...
 
std::string name () const
 result of measure's name method if information was successfully extracted from the script, otherwise empty More...
 
 RubyUserScriptInfo (const std::string &error)
 Constructor used when Ruby interpreter fails to get information about the script. More...
 
 RubyUserScriptInfo (const MeasureType &measureType, const std::string &className, const std::string &name, const std::string &description, const std::string &modelerDescription, const std::vector< OSArgument > &arguments)
 Constructor used when Ruby interpreter succeeds to get information about the script. More...
 
bool update (BCLMeasure &measure) const
 Compares the measure's information from the xml with information extracted from the ruby measure Updates the measure if needed, returns true if an update was performed. More...
 

Detailed Description

BCLMeasureInfo contains information that can be extracted from a by the Ruby parser.

Constructor & Destructor Documentation

openstudio::ruleset::RubyUserScriptInfo::RubyUserScriptInfo ( const std::string &  error)

Constructor used when Ruby interpreter fails to get information about the script.

openstudio::ruleset::RubyUserScriptInfo::RubyUserScriptInfo ( const MeasureType &  measureType,
const std::string &  className,
const std::string &  name,
const std::string &  description,
const std::string &  modelerDescription,
const std::vector< OSArgument > &  arguments 
)

Constructor used when Ruby interpreter succeeds to get information about the script.

Member Function Documentation

std::vector<OSArgument> openstudio::ruleset::RubyUserScriptInfo::arguments ( ) const

result of measure's arguments method called with empty model if information was successfully extracted from the script, otherwise empty

std::string openstudio::ruleset::RubyUserScriptInfo::className ( ) const

name of measure class if information was successfully extracted from the script, otherwise empty

std::string openstudio::ruleset::RubyUserScriptInfo::description ( ) const

result of measure's description method if information was successfully extracted from the script, otherwise empty

boost::optional<std::string> openstudio::ruleset::RubyUserScriptInfo::error ( ) const

will be empty if information was successfully extracted from the script, otherwise includes error information

MeasureType openstudio::ruleset::RubyUserScriptInfo::measureType ( ) const

type of measure if information was successfully extracted from the script, otherwise undefined

std::string openstudio::ruleset::RubyUserScriptInfo::modelerDescription ( ) const

result of measure's modeler_description method if information was successfully extracted from the script, otherwise empty

std::string openstudio::ruleset::RubyUserScriptInfo::name ( ) const

result of measure's name method if information was successfully extracted from the script, otherwise empty

bool openstudio::ruleset::RubyUserScriptInfo::update ( BCLMeasure &  measure) const

Compares the measure's information from the xml with information extracted from the ruby measure Updates the measure if needed, returns true if an update was performed.