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



52
53
54
55
56
 
# File 'lib/measures/openstudio_extension_test_measure/measure.rb', line 52

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

  return args
end

#name ⇒ Object

define the name that a user will see



47
48
49
 
# File 'lib/measures/openstudio_extension_test_measure/measure.rb', line 47

def name
  return 'OpenStudio Extension Test Measure'
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is run



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/measures/openstudio_extension_test_measure/measure.rb', line 59

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