Class: CtdDocumentation::IndicatorInfo

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/ctd_documentation/models/indicator_info.rb

Overview

IndicatorInfo Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(id = SKIP, points = SKIP, site_id = SKIP, type = SKIP, description = SKIP) ⇒ IndicatorInfo

Returns a new instance of IndicatorInfo.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/ctd_documentation/models/indicator_info.rb', line 59

def initialize(id = SKIP,
               points = SKIP,
               site_id = SKIP,
               type = SKIP,
               description = SKIP)
  @id = id unless id == SKIP
  @points = points unless points == SKIP
  @site_id = site_id unless site_id == SKIP
  @type = type unless type == SKIP
  @description = description unless description == SKIP
end

Instance Attribute Details

#description ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


30
31
32
 
# File 'lib/ctd_documentation/models/indicator_info.rb', line 30

def description
  @description
end

#id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/ctd_documentation/models/indicator_info.rb', line 14

def id
  @id
end

#points ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/ctd_documentation/models/indicator_info.rb', line 18

def points
  @points
end

#site_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/ctd_documentation/models/indicator_info.rb', line 22

def site_id
  @site_id
end

#type ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/ctd_documentation/models/indicator_info.rb', line 26

def type
  @type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ctd_documentation/models/indicator_info.rb', line 72

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  id = hash.key?('id') ? hash['id'] : SKIP
  points = hash.key?('points') ? hash['points'] : SKIP
  site_id = hash.key?('site_id') ? hash['site_id'] : SKIP
  type = hash.key?('type') ? hash['type'] : SKIP
  description = hash.key?('description') ? hash['description'] : SKIP

  # Create object from extracted values.

  IndicatorInfo.new(id,
                    points,
                    site_id,
                    type,
                    description)
end

.names ⇒ Object

A mapping from model property names to API property names.



33
34
35
36
37
38
39
40
41
 
# File 'lib/ctd_documentation/models/indicator_info.rb', line 33

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['points'] = 'points'
  @_hash['site_id'] = 'site_id'
  @_hash['type'] = 'type'
  @_hash['description'] = 'description'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



55
56
57
 
# File 'lib/ctd_documentation/models/indicator_info.rb', line 55

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



44
45
46
47
48
49
50
51
52
 
# File 'lib/ctd_documentation/models/indicator_info.rb', line 44

def self.optionals
  %w[
    id
    points
    site_id
    type
    description
  ]
end