Class: OpenC3::Accessor

Inherits:
Object show all
Defined in:
lib/openc3/accessors/accessor.rb,
ext/openc3/ext/structure/structure.c

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(packet = nil) ⇒ Accessor

Returns a new instance of Accessor.



26
27
28
29
 
# File 'lib/openc3/accessors/accessor.rb', line 26

def initialize(packet = nil)
  @packet = packet
  @args = []
end

Instance Attribute Details

#packet ⇒ Object

Returns the value of attribute packet.



24
25
26
 
# File 'lib/openc3/accessors/accessor.rb', line 24

def packet
  @packet
end

Class Method Details

.convert_to_type(value, item) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/openc3/accessors/accessor.rb', line 122

def self.convert_to_type(value, item)
  return value if value.nil?
  case item.data_type
  when :ANY
    begin
      value = JSON.parse(value) if value.is_a? String
    rescue Exception
      # Just leave value as is
    end
  when :BOOL
    value = ConfigParser.handle_true_false(value) if value.is_a? String
  when :OBJECT, :ARRAY
    value = JSON.parse(value) if value.is_a? String
  when :STRING, :BLOCK
    if item.array_size
      value = JSON.parse(value) if value.is_a? String
      value =  value.map { |v| v.to_s }
    else
      value = value.to_s
    end
  when :UINT, :INT
    if item.array_size
      value = JSON.parse(value) if value.is_a? String
      value = value.map { |v| Integer(v) }
    else
      value = Integer(value)
    end
  when :FLOAT
    if item.array_size
      value = JSON.parse(value) if value.is_a? String
      value = value.map { |v| Float(v) }
    else
      value = Float(value)
    end
  else
    raise(ArgumentError, "data_type #{item.data_type} is not recognized")
  end
  return value
end

.read_item(_item, _buffer) ⇒ Object 



99
100
101
 
# File 'lib/openc3/accessors/accessor.rb', line 99

def self.read_item(_item, _buffer)
  raise "Must be defined by subclass if needed"
end

.read_items(items, buffer) ⇒ Object 



107
108
109
110
111
112
113
 
# File 'lib/openc3/accessors/accessor.rb', line 107

def self.read_items(items, buffer)
  result = {}
  items.each do |item|
    result[item.name] = read_item(item, buffer)
  end
  return result
end

.write_item(_item, _value, _buffer) ⇒ Object 



103
104
105
 
# File 'lib/openc3/accessors/accessor.rb', line 103

def self.write_item(_item, _value, _buffer)
  raise "Must be defined by subclass if needed"
end

.write_items(items, values, buffer) ⇒ Object 



115
116
117
118
119
120
 
# File 'lib/openc3/accessors/accessor.rb', line 115

def self.write_items(items, values, buffer)
  items.each_with_index do |item, index|
    write_item(item, values[index], buffer)
  end
  return values
end

Instance Method Details

#args ⇒ Object 



69
70
71
 
# File 'lib/openc3/accessors/accessor.rb', line 69

def args
  return @args
end

#enforce_derived_write_conversion(_item) ⇒ Object

If this is true it will enforce that COSMOS DERIVED items must have a write_conversion to be written



95
96
97
 
# File 'lib/openc3/accessors/accessor.rb', line 95

def enforce_derived_write_conversion(_item)
  return true
end

#enforce_encoding ⇒ Object

If this is set it will enforce that buffer data is encoded in a specific encoding



75
76
77
 
# File 'lib/openc3/accessors/accessor.rb', line 75

def enforce_encoding
  return 'ASCII-8BIT'.freeze
end

#enforce_length ⇒ Object

This affects whether the Packet class enforces the buffer length at all. Set to false to remove any correlation between buffer length and defined sizes of items in COSMOS



82
83
84
 
# File 'lib/openc3/accessors/accessor.rb', line 82

def enforce_length
  return true
end

#enforce_short_buffer_allowed ⇒ Object

This sets the short_buffer_allowed flag in the Packet class which allows packets that have a buffer shorter than the defined size. Note that the buffer is still resized to the defined length



89
90
91
 
# File 'lib/openc3/accessors/accessor.rb', line 89

def enforce_short_buffer_allowed
  return false
end

#read_item(item, buffer) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/openc3/accessors/accessor.rb', line 31

def read_item(item, buffer)
  if item.parent_item
    # Structure is used to read items with parent, not accessor
    structure_buffer = read_item(item.parent_item, buffer)
    structure = item.parent_item.structure
    structure.read(item.key, :RAW, structure_buffer)
  else
    self.class.read_item(item, buffer)
  end
end

#read_items(items, buffer) ⇒ Object 



54
55
56
57
58
59
60
 
# File 'lib/openc3/accessors/accessor.rb', line 54

def read_items(items, buffer)
  result = {}
  items.each do |item|
    result[item.name] = read_item(item, buffer)
  end
  return result
end

#write_item(item, value, buffer) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/openc3/accessors/accessor.rb', line 42

def write_item(item, value, buffer)
  if item.parent_item
    # Structure is used to write items with parent, not accessor
    structure_buffer = read_item(item.parent_item, buffer)
    structure = item.parent_item.structure
    structure.write(item.key, value, :RAW, structure_buffer)
    self.class.write_item(item.parent_item, structure_buffer, buffer)
  else
    self.class.write_item(item, value, buffer)
  end
end

#write_items(items, values, buffer) ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/openc3/accessors/accessor.rb', line 62

def write_items(items, values, buffer)
  items.each_with_index do |item, index|
    write_item(item, values[index], buffer)
  end
  return values
end