Class: OpenStudio::Workflow::OutputAdapters

Inherits:
Object
  • Object
show all
Defined in:
lib/openstudio/workflow/adapters/output_adapter.rb

Overview

Base class for all output adapters. These methods define the expected return behavior of the adapter instance

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ OutputAdapters

Returns a new instance of OutputAdapters.



26
27
28
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 26

def initialize(options = {})
  @options = options
end

Instance Attribute Details

#options ⇒ Object

Returns the value of attribute options.



24
25
26
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 24

def options
  @options
end

Instance Method Details

#add_directory_to_zip(zip_file, local_directory, root_directory) ⇒ Object

Submethod for adding the directory to the zip folder.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 71

def add_directory_to_zip(zip_file, local_directory, root_directory)
  Dir[File.join(local_directory.to_s, '**', '**')].each do |file|
    # remove the base directory from the zip file
    rel_dir = local_directory.sub("#{root_directory}/", '')
    zip_file_to_add = file.gsub(local_directory.to_s, rel_dir.to_s)
    if File.directory?(file)
      zip_file.addDirectory(file, zip_file_to_add)
    else
      zip_file.addFile(file, zip_file_to_add)
    end
  end

  zip_file
end

#communicate_complete ⇒ Object 



58
59
60
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 58

def communicate_complete
  instance.communicate_complete
end

#communicate_energyplus_stdout(line, options = {}) ⇒ Object 



38
39
40
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 38

def communicate_energyplus_stdout(line, options = {})
  instance.communicate_energyplus_stdout line, options
end

#communicate_failure ⇒ Object 



62
63
64
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 62

def communicate_failure
  instance.communicate_failure
end

#communicate_measure_attributes(measure_attributes, options = {}) ⇒ Object 



46
47
48
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 46

def communicate_measure_attributes(measure_attributes, options = {})
  instance.communicate_measure_attributes measure_attributes, options
end

#communicate_measure_result(result, options = {}) ⇒ Object 



42
43
44
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 42

def communicate_measure_result(result, options = {})
  instance.communicate_measure_result result, options
end

#communicate_objective_function(objectives, options = {}) ⇒ Object 



50
51
52
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 50

def communicate_objective_function(objectives, options = {})
  instance.communicate_objective_function objectives, options
end

#communicate_results(directory, results) ⇒ Object 



54
55
56
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 54

def communicate_results(directory, results)
  instance.communicate_results directory, results
end

#communicate_started ⇒ Object 



30
31
32
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 30

def communicate_started
  instance.communicate_started
end

#communicate_transition(message, type, options = {}) ⇒ Object 



34
35
36
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 34

def communicate_transition(message, type, options = {})
  instance.communicate_transition message, type, options
end