Method: OpenC3::Structure#read

Defined in:
lib/openc3/packets/structure.rb

#read(name, value_type = :RAW, buffer = @buffer) ⇒ Object

Read an item in the structure by name

Parameters:

  • name (String)

    Name of an item to read

  • value_type (Symbol) (defaults to: :RAW)

    Not used. Subclasses should overload this parameter to check whether to perform conversions on the item.

  • buffer (String) (defaults to: @buffer)

    The binary buffer to read the item from

Returns:

  • Value based on the item definition. This could be an integer, float, or array of values.



395
396
397
# File 'lib/openc3/packets/structure.rb', line 395

def read(name, value_type = :RAW, buffer = @buffer)
  return read_item(get_item(name), value_type, buffer)
end