openstudio::ruleset::RubyUserScriptInfoGetter Class Reference

#include <RubyUserScriptInfoGetter.hpp>

Inheritance diagram for openstudio::ruleset::RubyUserScriptInfoGetter:

Public Member Functions
virtual RubyUserScriptInfo	getInfo (const BCLMeasure &measure)=0
virtual RubyUserScriptInfo	getInfo (const BCLMeasure &measure, const Workspace &workspace)=0
	Use this method to pass in a (EnergyPlus) Workspace or a (OpenStudio) Model. More...
virtual RubyUserScriptInfo	getInfo (const BCLMeasure &measure, const model::Model &model, const Workspace &workspace)=0
RubyUserScriptInfo	getInfo (const BCLMeasure &measure, const boost::optional< model::Model > &model, const boost::optional< Workspace > &workspace)
virtual	~RubyUserScriptInfoGetter ()

Related Functions
(Note that these are not member functions.)
std::string	infoExtractorRubyFunction ()
	Non-member function that returns Ruby code text for retrieving info from a BCLMeasure. More...

Detailed Description

Interface class for using embedded Ruby to extract arguments from a Ruby measure (UserScript).

See the documentation for detail::RubyUserScriptArgumentGetter_Impl and src/ruleset/test/EmbeddedRuby_GTest.cpp for this use case. If your application is written in Ruby, this functionality is available through non-member helper function OpenStudio::Ruleset::getArguments(BCLMeasure), see ruby/openstudio/ruleset/test/RubyUserScriptArgumentGetter_Test.rb for an example.

Constructor & Destructor Documentation

virtual openstudio::ruleset::RubyUserScriptInfoGetter::~RubyUserScriptInfoGetter ( )

inlinevirtual

Member Function Documentation

virtual RubyUserScriptInfo openstudio::ruleset::RubyUserScriptInfoGetter::getInfo ( const BCLMeasure &  measure )

pure virtual

Implemented in openstudio::ruleset::EmbeddedRubyUserScriptInfoGetter< RubyInterpreterType >.

virtual RubyUserScriptInfo openstudio::ruleset::RubyUserScriptInfoGetter::getInfo ( const BCLMeasure &  measure, const Workspace &  workspace  )

pure virtual

Use this method to pass in a (EnergyPlus) Workspace or a (OpenStudio) Model.

Implemented in openstudio::ruleset::EmbeddedRubyUserScriptInfoGetter< RubyInterpreterType >.

virtual RubyUserScriptInfo openstudio::ruleset::RubyUserScriptInfoGetter::getInfo ( const BCLMeasure &  measure, const model::Model &  model, const Workspace &  workspace  )

pure virtual

Implemented in openstudio::ruleset::EmbeddedRubyUserScriptInfoGetter< RubyInterpreterType >.

RubyUserScriptInfo openstudio::ruleset::RubyUserScriptInfoGetter::getInfo	(	const BCLMeasure &	measure,
		const boost::optional< model::Model > &	model,
		const boost::optional< Workspace > &	workspace
	)

Friends And Related Function Documentation

std::string infoExtractorRubyFunction ( )

related

Non-member function that returns Ruby code text for retrieving info from a BCLMeasure.

This function is used by both the embedded Ruby (RubyScriptArgumentGetter) and native Ruby (OpenStudio::Ruleset::getArguments) implementations of the functionality, such that either usage pathway should produce identical results.