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

#include <EmbeddedRubyUserScriptArgumentGetter.hpp>

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

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

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

Detailed Description

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

Should only be instantiated in C++ Applications.

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

Deprecated:

in preference to EmbeddedRubyUserScriptInfoGetter

Constructor & Destructor Documentation

template<typename RubyInterpreterType >

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

inline

template<typename RubyInterpreterType >

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

inlinevirtual

Member Function Documentation

template<typename RubyInterpreterType >

std::vector<OSArgument> openstudio::ruleset::EmbeddedRubyUserScriptArgumentGetter< RubyInterpreterType >::getArguments ( const BCLMeasure &  measure )

inlineoverridevirtual

Implements openstudio::ruleset::RubyUserScriptArgumentGetter.

template<typename RubyInterpreterType >

std::vector<OSArgument> openstudio::ruleset::EmbeddedRubyUserScriptArgumentGetter< RubyInterpreterType >::getArguments ( const BCLMeasure &  measure, const Workspace &  workspace  )

inlineoverridevirtual

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

Implements openstudio::ruleset::RubyUserScriptArgumentGetter.

template<typename RubyInterpreterType >

std::vector<OSArgument> openstudio::ruleset::EmbeddedRubyUserScriptArgumentGetter< RubyInterpreterType >::getArguments ( const BCLMeasure &  measure, const model::Model &  model, const Workspace &  workspace  )

inlineoverridevirtual

Implements openstudio::ruleset::RubyUserScriptArgumentGetter.