Class: Comet::SpannedDestinationLocation

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/spanned_destination_location.rb

Overview

SpannedDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeSpannedDestinationLocation

Returns a new instance of SpannedDestinationLocation.



24
25
26
# File 'lib/comet/models/spanned_destination_location.rb', line 24

def initialize
  clear
end

Instance Attribute Details

#span_targetsObject

Returns the value of attribute span_targets.



16
17
18
# File 'lib/comet/models/spanned_destination_location.rb', line 16

def span_targets
  @span_targets
end

#span_use_static_slotsObject

Returns the value of attribute span_use_static_slots.



19
20
21
# File 'lib/comet/models/spanned_destination_location.rb', line 19

def span_use_static_slots
  @span_use_static_slots
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



22
23
24
# File 'lib/comet/models/spanned_destination_location.rb', line 22

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clearObject



28
29
30
31
# File 'lib/comet/models/spanned_destination_location.rb', line 28

def clear
  @span_targets = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/comet/models/spanned_destination_location.rb', line 41

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'SpanTargets'
      if v.nil?
        @span_targets = []
      else
        @span_targets = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @span_targets[i1] = Comet::DestinationLocation.new
          @span_targets[i1].from_hash(v1)
        end
      end
    when 'SpanUseStaticSlots'
      @span_use_static_slots = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String)

    The complete object in JSON format

Raises:

  • (TypeError)


34
35
36
37
38
# File 'lib/comet/models/spanned_destination_location.rb', line 34

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_hHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



76
77
78
# File 'lib/comet/models/spanned_destination_location.rb', line 76

def to_h
  to_hash
end

#to_hashHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



65
66
67
68
69
70
71
72
73
# File 'lib/comet/models/spanned_destination_location.rb', line 65

def to_hash
  ret = {}
  ret['SpanTargets'] = @span_targets
  ret['SpanUseStaticSlots'] = @span_use_static_slots
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String)

    The complete object as a JSON string



81
82
83
# File 'lib/comet/models/spanned_destination_location.rb', line 81

def to_json(options = {})
  to_hash.to_json(options)
end