Class: CtdDocumentation::CodeSections

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

Overview

CodeSections Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(type = SKIP, filename = SKIP, rid = SKIP) ⇒ CodeSections

Returns a new instance of CodeSections.



47
48
49
50
51
52
53
 
# File 'lib/ctd_documentation/models/code_sections.rb', line 47

def initialize(type = SKIP,
               filename = SKIP,
               rid = SKIP)
  @type = type unless type == SKIP
  @filename = filename unless filename == SKIP
  @rid = rid unless rid == SKIP
end

Instance Attribute Details

#filename ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def filename
  @filename
end

#rid ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def rid
  @rid
end

#type ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/ctd_documentation/models/code_sections.rb', line 56

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  type = hash.key?('type') ? hash['type'] : SKIP
  filename = hash.key?('filename') ? hash['filename'] : SKIP
  rid = hash.key?('rid') ? hash['rid'] : SKIP

  # Create object from extracted values.

  CodeSections.new(type,
                   filename,
                   rid)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/ctd_documentation/models/code_sections.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['type'] = 'type'
  @_hash['filename'] = 'filename'
  @_hash['rid'] = 'rid'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/ctd_documentation/models/code_sections.rb', line 43

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    type
    filename
    rid
  ]
end