openstudio::measure::OSMeasureInfoGetter Class Reference

#include <OSMeasureInfoGetter.hpp>

Inheritance diagram for openstudio::measure::OSMeasureInfoGetter:

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

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 an OSMeasure.

See src/measure/test/EmbeddedRuby_GTest.cpp for this use case. If your application is written in Ruby, this functionality is available through non-member helper function Opudio::Measure::infoExtractorRubyFunction(BCLMeasure), see ruby/openstudio/measure/test/OSMeasureInfoGetter_Test.rb for an example.

Constructor & Destructor Documentation

virtual openstudio::measure::OSMeasureInfoGetter::~OSMeasureInfoGetter ( )

virtualdefault

Member Function Documentation

virtual OSMeasureInfo openstudio::measure::OSMeasureInfoGetter::getInfo ( const BCLMeasure &  measure )

pure virtual

Implemented in openstudio::measure::EmbeddedRubyMeasureInfoGetter< RubyInterpreterType >.

virtual OSMeasureInfo openstudio::measure::OSMeasureInfoGetter::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::measure::EmbeddedRubyMeasureInfoGetter< RubyInterpreterType >.

virtual OSMeasureInfo openstudio::measure::OSMeasureInfoGetter::getInfo ( const BCLMeasure &  measure, const model::Model &  model, const Workspace &  workspace  )

pure virtual

Implemented in openstudio::measure::EmbeddedRubyMeasureInfoGetter< RubyInterpreterType >.

OSMeasureInfo openstudio::measure::OSMeasureInfoGetter::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 OSMeasureInfoGetter and native Ruby (OpenStudio::Measure::getInfo) implementations of the functionality, such that either usage pathway should produce identical results.