Class: Chemicalml::Model::Module

Inherits:
Node
  • Object
show all
Defined in:
lib/chemicalml/model/cml_module.rb

Overview

A generic grouping container (CML <module>). The dict_ref attribute identifies the module's role (e.g. compchem:jobList, compchem:initialization).

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Node

#==, #accept, #hash, short_name

Constructor Details

#initialize(id: nil, title: nil, dict_ref: nil, convention: nil, molecules: [], modules: [], parameter_lists: [], property_lists: [], metadata_lists: [], lists: []) ⇒ Module

Returns a new instance of Module.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/chemicalml/model/cml_module.rb', line 13

def initialize(id: nil, title: nil, dict_ref: nil, convention: nil,
               molecules: [], modules: [],
               parameter_lists: [], property_lists: [],
               metadata_lists: [], lists: [])
  @id = id
  @title = title
  @dict_ref = dict_ref
  @convention = convention
  @molecules = molecules
  @modules = modules
  @parameter_lists = parameter_lists
  @property_lists = property_lists
  @metadata_lists = metadata_lists
  @lists = lists
end

Instance Attribute Details

#convention ⇒ Object

Returns the value of attribute convention.



9
10
11
 
# File 'lib/chemicalml/model/cml_module.rb', line 9

def convention
  @convention
end

#dict_ref ⇒ Object

Returns the value of attribute dict_ref.



9
10
11
 
# File 'lib/chemicalml/model/cml_module.rb', line 9

def dict_ref
  @dict_ref
end

#id ⇒ Object

Returns the value of attribute id.



9
10
11
 
# File 'lib/chemicalml/model/cml_module.rb', line 9

def id
  @id
end

#lists ⇒ Object

Returns the value of attribute lists.



9
10
11
 
# File 'lib/chemicalml/model/cml_module.rb', line 9

def lists
  @lists
end

#metadata_lists ⇒ Object

Returns the value of attribute metadata_lists.



9
10
11
 
# File 'lib/chemicalml/model/cml_module.rb', line 9

def metadata_lists
  @metadata_lists
end

#modules ⇒ Object

Returns the value of attribute modules.



9
10
11
 
# File 'lib/chemicalml/model/cml_module.rb', line 9

def modules
  @modules
end

#molecules ⇒ Object

Returns the value of attribute molecules.



9
10
11
 
# File 'lib/chemicalml/model/cml_module.rb', line 9

def molecules
  @molecules
end

#parameter_lists ⇒ Object

Returns the value of attribute parameter_lists.



9
10
11
 
# File 'lib/chemicalml/model/cml_module.rb', line 9

def parameter_lists
  @parameter_lists
end

#property_lists ⇒ Object

Returns the value of attribute property_lists.



9
10
11
 
# File 'lib/chemicalml/model/cml_module.rb', line 9

def property_lists
  @property_lists
end

#title ⇒ Object

Returns the value of attribute title.



9
10
11
 
# File 'lib/chemicalml/model/cml_module.rb', line 9

def title
  @title
end

Instance Method Details

#children ⇒ Object 



29
30
31
 
# File 'lib/chemicalml/model/cml_module.rb', line 29

def children
  molecules + modules + parameter_lists + property_lists + metadata_lists + lists
end

#value_attributes ⇒ Object 



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/chemicalml/model/cml_module.rb', line 33

def value_attributes
  {
    id: id, title: title, dict_ref: dict_ref, convention: convention,
    molecules: molecules, modules: modules,
    parameter_lists: parameter_lists,
    property_lists: property_lists,
    metadata_lists: metadata_lists,
    lists: lists
  }
end