Class: OpenStudioExtensionTestMeasure

Inherits:
OpenStudio::Measure::ModelMeasure
  • Object
show all
Defined in:
lib/measures/openstudio_extension_test_measure/measure.rb

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(model) ⇒ Object

define the arguments that the user will input



22
23
24
25
26
 
# File 'lib/measures/openstudio_extension_test_measure/measure.rb', line 22

def arguments(model)
  args = OpenStudio::Measure::OSArgumentVector.new

  return args
end

#name ⇒ Object

define the name that a user will see



17
18
19
 
# File 'lib/measures/openstudio_extension_test_measure/measure.rb', line 17

def name
  return 'OpenStudio Extension Test Measure'
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is run



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/measures/openstudio_extension_test_measure/measure.rb', line 29

def run(model, runner, user_arguments)
  super(model, runner, user_arguments)

  # use the built-in error checking
  if !runner.validateUserArguments(arguments(model), user_arguments)
    return false
  end

  return true
end