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.



44
45
46
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 44

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

Instance Attribute Details

#options ⇒ Object

Returns the value of attribute options.



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

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.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 89

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 



76
77
78
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 76

def communicate_complete
  instance.communicate_complete
end

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



56
57
58
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 56

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

#communicate_failure ⇒ Object 



80
81
82
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 80

def communicate_failure
  instance.communicate_failure
end

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



64
65
66
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 64

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

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



60
61
62
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 60

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

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



68
69
70
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 68

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

#communicate_results(directory, results) ⇒ Object 



72
73
74
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 72

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

#communicate_started ⇒ Object 



48
49
50
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 48

def communicate_started
  instance.communicate_started
end

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



52
53
54
 
# File 'lib/openstudio/workflow/adapters/output_adapter.rb', line 52

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