Class: WorkflowRunner

Inherits:
OpenStudio::Ruleset::OSRunner
  • Object
show all
Defined in:
lib/openstudio/workflow_runner.rb

Overview

Extend OS Runner to persist measure information throughout the workflow Provide shims to support OpenStudio 2.X functionality in OpenStudio 1.X

Instance Method Summary collapse

Constructor Details

#initialize(multi_logger, workflow_json, openstudio_2) ⇒ WorkflowRunner

Returns a new instance of WorkflowRunner.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/openstudio/workflow_runner.rb', line 25

def initialize(multi_logger, workflow_json, openstudio_2)
  @multi_logger = multi_logger
  @workflow_json = workflow_json
  @openstudio_2 = openstudio_2
  @datapoint = nil
  @analysis = nil
  @halted = false
  @use_os_halted = OpenStudio::Ruleset::OSRunner.method_defined?(:halted)
  
  begin
    # OpenStudio 2.X
    super(@workflow_json)
  rescue Exception => e
    # OpenStudio 1.X
    @workflow = workflow_json
    @units_preference = 'SI'
    @language_preference = 'EN'
    super()
  end
end

Instance Method Details

#analysis ⇒ Object 



58
59
60
 
# File 'lib/openstudio/workflow_runner.rb', line 58

def analysis
  @analysis
end

#datapoint ⇒ Object 



50
51
52
 
# File 'lib/openstudio/workflow_runner.rb', line 50

def datapoint
  @datapoint
end

#halted ⇒ Object

Overload halted



248
249
250
251
 
# File 'lib/openstudio/workflow_runner.rb', line 248

def halted
  return @halted unless @use_os_halted
  super
end

#haltWorkflow(completed_status) ⇒ Object

Overload haltSimulation



238
239
240
241
242
243
244
245
 
# File 'lib/openstudio/workflow_runner.rb', line 238

def haltWorkflow(completed_status)
  if @use_os_halted
    super
  else
    @halted = true
    @workflow_json.setCompletedStatus(completed_status)
  end
end

#incrementStep ⇒ Object

incrementing step copies result to previous results void incrementStep();



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/openstudio/workflow_runner.rb', line 196

def incrementStep
  if @openstudio_2
    super
  else
    # compute result
    current_result = result

    @workflow.incrementStep
  end
end

#languagePreference ⇒ Object

Returns preferred language, e.g. ‘en’ or ‘fr’. New in OS 2.0. */ std::string languagePreference() const;



88
89
90
91
92
93
94
 
# File 'lib/openstudio/workflow_runner.rb', line 88

def languagePreference
  if @openstudio_2
    super
  else
    @language_preference
  end
end

#prepareForUserScriptRun(userScript) ⇒ Object

called right when each measure is run only called in OpenStudio 1.X virtual void prepareForUserScriptRun(const UserScript& userScript);



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/openstudio/workflow_runner.rb', line 99

def prepareForUserScriptRun(userScript)
  
  if @openstudio_2
    prepareForMeasureRun(userScript)
  else
    current_step = @workflow.currentStep

    unless current_step.empty?
      current_step.get.step[:result] = {}
      current_step.get.step[:result][:started_at] = timeString
    end

    # TODO: capture std out and err

    # TODO: get initial list of files

    super
  end
end

#registerError(message) ⇒ Object

Overload registerError



220
221
222
223
 
# File 'lib/openstudio/workflow_runner.rb', line 220

def registerError(message)
  super
  @multi_logger.error message
end

#registerFinalCondition(message) ⇒ Object

Overload registerFinalCondition



232
233
234
235
 
# File 'lib/openstudio/workflow_runner.rb', line 232

def registerFinalCondition(message)
  super
  @multi_logger.info message
end

#registerInfo(message) ⇒ Object

Overload registerInfo



208
209
210
211
 
# File 'lib/openstudio/workflow_runner.rb', line 208

def registerInfo(message)
  super
  @multi_logger.info message
end

#registerInitialCondition(message) ⇒ Object

Overload registerInitialCondition



226
227
228
229
 
# File 'lib/openstudio/workflow_runner.rb', line 226

def registerInitialCondition(message)
  super
  @multi_logger.info message
end

#registerWarning(message) ⇒ Object

Overload registerInfo



214
215
216
217
 
# File 'lib/openstudio/workflow_runner.rb', line 214

def registerWarning(message)
  super
  @multi_logger.warn message
end

#result ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/openstudio/workflow_runner.rb', line 119

def result
  if @openstudio_2
    super
  else
    os_result = super

    current_step = @workflow.currentStep

    if current_step.empty?
      raise 'Cannot find current_step'
    end
    current_step = current_step.get

    if current_step.step[:result].nil?
      # skipped, prepareForUserScriptRun was not called
      current_step.step[:result] = {}
      current_step.step[:result][:started_at] = timeString
      current_step.step[:result][:step_result] = 'Skip'
    else
      current_step.step[:result][:step_result] = os_result.value.valueName
    end

    current_step.step[:result][:completed_at] = timeString

    # TODO: restore stdout and stderr

    # TODO: check for created files

    current_step.step[:result][:step_errors] = []
    os_result.errors.each do |error|
      current_step.step[:result][:step_errors] << error.logMessage
    end

    current_step.step[:result][:step_warnings] = []
    os_result.warnings.each do |warning|
      current_step.step[:result][:step_warnings] << warning.logMessage
    end

    current_step.step[:result][:step_info] = []
    os_result.info.each do |info|
      current_step.step[:result][:step_info] << info.logMessage
    end

    unless os_result.initialCondition.empty?
      current_step.step[:result][:initial_condition] = os_result.initialCondition.get.logMessage
      current_step.step[:result][:step_initial_condition] = os_result.initialCondition.get.logMessage
    end

    unless os_result.finalCondition.empty?
      current_step.step[:result][:final_condition] = os_result.finalCondition.get.logMessage
      current_step.step[:result][:step_final_condition] = os_result.finalCondition.get.logMessage
    end

    current_step.step[:result][:step_values] = []
    os_result.attributes.each do |attribute|
      result = nil
      if attribute.valueType == 'Boolean'.to_AttributeValueType
        result = { name: attribute.name, value: attribute.valueAsBoolean, type: 'Boolean' }
      elsif attribute.valueType == 'Double'.to_AttributeValueType
        result = { name: attribute.name, value: attribute.valueAsDouble, type: 'Double' }
      elsif attribute.valueType == 'Integer'.to_AttributeValueType
        result = { name: attribute.name, value: attribute.valueAsInteger, type: 'Integer' }
      elsif attribute.valueType == 'Unsigned'.to_AttributeValueType
        result = { name: attribute.name, value: attribute.valueAsUnsigned, type: 'Integer' }
      elsif attribute.valueType == 'String'.to_AttributeValueType
        result = { name: attribute.name, value: attribute.valueAsString, type: 'String' }
      end

      current_step.step[:result][:step_values] << result unless result.nil?
    end

    return WorkflowStepResult_Shim.new(current_step.step[:result])
  end
end

#setAnalysis(analysis) ⇒ Object 



62
63
64
 
# File 'lib/openstudio/workflow_runner.rb', line 62

def setAnalysis(analysis)
  @analysis = analysis
end

#setDatapoint(datapoint) ⇒ Object 



54
55
56
 
# File 'lib/openstudio/workflow_runner.rb', line 54

def setDatapoint(datapoint)
  @datapoint = datapoint
end

#timeString ⇒ Object 



46
47
48
 
# File 'lib/openstudio/workflow_runner.rb', line 46

def timeString
  ::Time.now.utc.strftime("%Y%m%dT%H%M%SZ")
end

#unitsPreference ⇒ Object

Returns preferred unit system, either ‘IP’ or ‘SI’. New in OS 2.0. */ std::string unitsPreference() const;



78
79
80
81
82
83
84
 
# File 'lib/openstudio/workflow_runner.rb', line 78

def unitsPreference
  if @openstudio_2
    super
  else
    @units_preference
  end
end

#workflow ⇒ Object

Returns the workflow currently being run. New in OS 2.0. WorkflowJSON workflow() const;



68
69
70
71
72
73
74
 
# File 'lib/openstudio/workflow_runner.rb', line 68

def workflow
  if @openstudio_2
    super
  else
    @workflow
  end
end