Class: CtdDocumentation::RiskVector

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

Overview

RiskVector Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(details = SKIP, name = SKIP, scale = SKIP, score = SKIP) ⇒ RiskVector

Returns a new instance of RiskVector.



53
54
55
56
57
58
59
60
61
 
# File 'lib/ctd_documentation/models/risk_vector.rb', line 53

def initialize(details = SKIP,
               name = SKIP,
               scale = SKIP,
               score = SKIP)
  @details = details unless details == SKIP
  @name = name unless name == SKIP
  @scale = scale unless scale == SKIP
  @score = score unless score == SKIP
end

Instance Attribute Details

#details ⇒ List of Detail

TODO: Write general description for this method

Returns:



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

def details
  @details
end

#name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def name
  @name
end

#scale ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


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

def scale
  @scale
end

#score ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


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

def score
  @score
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/ctd_documentation/models/risk_vector.rb', line 64

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  details = nil
  unless hash['details'].nil?
    details = []
    hash['details'].each do |structure|
      details << (Detail.from_hash(structure) if structure)
    end
  end

  details = SKIP unless hash.key?('details')
  name = hash.key?('name') ? hash['name'] : SKIP
  scale = hash.key?('scale') ? hash['scale'] : SKIP
  score = hash.key?('score') ? hash['score'] : SKIP

  # Create object from extracted values.
  RiskVector.new(details,
                 name,
                 scale,
                 score)
end

.names ⇒ Object

A mapping from model property names to API property names.



29
30
31
32
33
34
35
36
 
# File 'lib/ctd_documentation/models/risk_vector.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['details'] = 'details'
  @_hash['name'] = 'name'
  @_hash['scale'] = 'scale'
  @_hash['score'] = 'score'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/ctd_documentation/models/risk_vector.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
45
46
 
# File 'lib/ctd_documentation/models/risk_vector.rb', line 39

def self.optionals
  %w[
    details
    name
    scale
    score
  ]
end