openstudio::ruleset::EmbeddedRubyUserScriptInfoGetter< RubyInterpreterType > Class Template Reference

#include <EmbeddedRubyUserScriptInfoGetter.hpp>

Inheritance diagram for openstudio::ruleset::EmbeddedRubyUserScriptInfoGetter< RubyInterpreterType >:

Public Member Functions
	EmbeddedRubyUserScriptInfoGetter (const std::shared_ptr< RubyInterpreterType > &rubyInterpreter)
RubyUserScriptInfo	getInfo (const BCLMeasure &measure) override
RubyUserScriptInfo	getInfo (const BCLMeasure &measure, const Workspace &workspace) override
	Use this method to pass in a (EnergyPlus) Workspace or a (OpenStudio) Model. More...
RubyUserScriptInfo	getInfo (const BCLMeasure &measure, const model::Model &model, const Workspace &workspace) override
virtual	~EmbeddedRubyUserScriptInfoGetter ()
Public Member Functions inherited from openstudio::ruleset::RubyUserScriptInfoGetter
RubyUserScriptInfo	getInfo (const BCLMeasure &measure, const boost::optional< model::Model > &model, const boost::optional< Workspace > &workspace)
virtual	~RubyUserScriptInfoGetter ()

Additional Inherited Members
Related Functions inherited from openstudio::ruleset::RubyUserScriptInfoGetter
std::string	infoExtractorRubyFunction ()
	Non-member function that returns Ruby code text for retrieving info from a BCLMeasure. More...

Detailed Description

template<typename RubyInterpreterType>
class openstudio::ruleset::EmbeddedRubyUserScriptInfoGetter< RubyInterpreterType >

Should only be instantiated in C++ Applications.

For an example of how to use this, see src/ruleset/test/EmbeddedRuby_GTest.cpp.

Constructor & Destructor Documentation

template<typename RubyInterpreterType >

openstudio::ruleset::EmbeddedRubyUserScriptInfoGetter< RubyInterpreterType >::EmbeddedRubyUserScriptInfoGetter ( const std::shared_ptr< RubyInterpreterType > &  rubyInterpreter )

inline

template<typename RubyInterpreterType >

virtual openstudio::ruleset::EmbeddedRubyUserScriptInfoGetter< RubyInterpreterType >::~EmbeddedRubyUserScriptInfoGetter ( )

inlinevirtual

Member Function Documentation

template<typename RubyInterpreterType >

RubyUserScriptInfo openstudio::ruleset::EmbeddedRubyUserScriptInfoGetter< RubyInterpreterType >::getInfo ( const BCLMeasure &  measure )

inlineoverridevirtual

Implements openstudio::ruleset::RubyUserScriptInfoGetter.

template<typename RubyInterpreterType >

RubyUserScriptInfo openstudio::ruleset::EmbeddedRubyUserScriptInfoGetter< RubyInterpreterType >::getInfo ( const BCLMeasure &  measure, const Workspace &  workspace  )

inlineoverridevirtual

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

Implements openstudio::ruleset::RubyUserScriptInfoGetter.

template<typename RubyInterpreterType >

RubyUserScriptInfo openstudio::ruleset::EmbeddedRubyUserScriptInfoGetter< RubyInterpreterType >::getInfo ( const BCLMeasure &  measure, const model::Model &  model, const Workspace &  workspace  )

inlineoverridevirtual

Implements openstudio::ruleset::RubyUserScriptInfoGetter.