Class: Cosmos::TableConfig

Inherits:
PacketConfig show all
Defined in:
lib/cosmos/tools/table_manager/table_config.rb

Overview

Processes the Table Manager configuration files which define tables. Since this class inherits from PacketConfig it only needs to implement Table Manager specific keywords. All tables are accessed through the table and tables methods.

Constant Summary

Constants inherited from PacketConfig

PacketConfig::COMMAND, PacketConfig::TELEMETRY

Instance Attribute Summary collapse

Attributes inherited from PacketConfig

#cmd_id_value_hash, #commands, #latest_data, #limits_groups, #limits_sets, #name, #telemetry, #tlm_id_value_hash, #warnings

Instance Method Summary collapse

Methods inherited from PacketConfig

#to_config, #to_xtce

Constructor Details

#initialize ⇒ TableConfig

Create the table configuration



27
28
29
30
31
 
# File 'lib/cosmos/tools/table_manager/table_config.rb', line 27

def initialize
  super
  # Override commands with the Table::TARGET name to store tables
  @commands[Table::TARGET] = {}
end

Instance Attribute Details

#filename ⇒ String (readonly)

Returns Table configuration filename.

Returns:

  • (String) —

    Table configuration filename



24
25
26
 
# File 'lib/cosmos/tools/table_manager/table_config.rb', line 24

def filename
  @filename
end

Instance Method Details

#finish_packet ⇒ Object

If the table is TWO_DIMENSIONAL all currently defined items are duplicated until the specified number of rows are created.



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/cosmos/tools/table_manager/table_config.rb', line 173

def finish_packet
  if @current_packet
    warnings = @current_packet.check_bit_offsets
    raise "Overlapping items not allowed in tables.\n#{warnings}" if warnings.length > 0
    if @current_packet.type == :TWO_DIMENSIONAL
      items = @current_packet.sorted_items.clone
      (@current_packet.num_rows - 1).times do |row|
        items.each do |item|
          new_item = item.clone
          new_item.name = "#{new_item.name[0...-1]}#{row + 1}"
          @current_packet.append(new_item)
        end
      end
    end
  end
  super()
end

#process_current_item(parser, keyword, params) ⇒ Object

Overridden method to handle the unique table item parameters: UNEDITABLE and HIDDEN. (see PacketConfig#process_current_item)



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/cosmos/tools/table_manager/table_config.rb', line 151

def process_current_item(parser, keyword, params)
  super(parser, keyword, params)
  case keyword
  when 'UNEDITABLE'
    usage = "#{keyword}"
    parser.verify_num_parameters(0, 0, usage)
    @current_item.editable = false
  when 'HIDDEN'
    usage = "#{keyword}"
    parser.verify_num_parameters(0, 0, usage)
    @current_item.hidden = true
  end
end

#process_current_packet(parser, keyword, params) ⇒ Object 



138
139
140
141
142
143
144
145
146
 
# File 'lib/cosmos/tools/table_manager/table_config.rb', line 138

def process_current_packet(parser, keyword, params)
  super(parser, keyword, params)
rescue => err
  if err.message.include?("not found")
    raise parser.error("#{params[0]} not found in table #{@current_packet.table_name}", "SELECT_PARAMETER <PARAMETER NAME>")
  else
    raise err
  end
end

#process_file(filename) ⇒ Object

Processes a COSMOS table configuration file and uses the keywords to build up knowledge of the tables.

Parameters:

  • filename (String) —

    The name of the configuration file



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/cosmos/tools/table_manager/table_config.rb', line 53

def process_file(filename)
  # Partial files are included into another file and thus aren't directly processed
  return if File.basename(filename)[0] == '_' # Partials start with underscore
  @filename = filename
  @converted_type = nil
  @converted_bit_size = nil
  @proc_text = ''
  @building_generic_conversion = false

  parser = ConfigParser.new("http://cosmosrb.com/docs/tools/#table-manager-configuration-cosmos--39")
  parser.parse_file(filename) do |keyword, params|
    if @building_generic_conversion
      case keyword
      # Complete a generic conversion
      when 'GENERIC_READ_CONVERSION_END', 'GENERIC_WRITE_CONVERSION_END'
        parser.verify_num_parameters(0, 0, keyword)
        @current_item.read_conversion =
          GenericConversion.new(@proc_text,
                                @converted_type,
                                @converted_bit_size) if keyword.include? "READ"
        @current_item.write_conversion =
          GenericConversion.new(@proc_text,
                                @converted_type,
                                @converted_bit_size) if keyword.include? "WRITE"
        @building_generic_conversion = false
      # Add the current config.line to the conversion being built
      else
        @proc_text << parser.line << "\n"
      end # case keyword

    else # not building generic conversion
      case keyword
      when 'TABLEFILE'
        usage = "#{keyword} <File name>"
        parser.verify_num_parameters(1, 1, usage)
        table_filename = File.join(File.dirname(filename), params[0])
        raise parser.error("Table file #{table_filename} not found", usage) unless File.exist?(table_filename)
        process_file(table_filename)

      when 'TABLE'
        finish_packet()
        @current_packet = TableParser.parse_table(parser, @commands, @warnings)
        @current_cmd_or_tlm = COMMAND

      # Select an existing table for editing
      when 'SELECT_TABLE'
        usage = "#{keyword} <TABLE NAME>"
        finish_packet()
        parser.verify_num_parameters(1, 1, usage)
        table_name = params[0].upcase
        @current_packet = table(table_name)
        raise parser.error("Table #{table_name} not found", usage) unless @current_packet

      #######################################################################
      # All the following keywords must have a current packet defined
      #######################################################################
      when 'SELECT_PARAMETER', 'PARAMETER', 'ID_PARAMETER', 'ARRAY_PARAMETER',
        'APPEND_PARAMETER', 'APPEND_ID_PARAMETER', 'APPEND_ARRAY_PARAMETER',
        'ALLOW_SHORT', 'HAZARDOUS', 'PROCESSOR', 'META', 'DISABLE_MESSAGES', 'DISABLED'
        raise parser.error("No current packet for #{keyword}") unless @current_packet
        process_current_packet(parser, keyword, params)

      #######################################################################
      # All the following keywords must have a current item defined
      #######################################################################
      when 'STATE', 'READ_CONVERSION', 'WRITE_CONVERSION', 'POLY_READ_CONVERSION',
        'POLY_WRITE_CONVERSION', 'SEG_POLY_READ_CONVERSION', 'SEG_POLY_WRITE_CONVERSION',
        'GENERIC_READ_CONVERSION_START', 'GENERIC_WRITE_CONVERSION_START', 'REQUIRED',
        'LIMITS', 'LIMITS_RESPONSE', 'UNITS', 'FORMAT_STRING', 'DESCRIPTION', 'HIDDEN',
        'MINIMUM_VALUE', 'MAXIMUM_VALUE', 'DEFAULT_VALUE', 'OVERFLOW', 'UNEDITABLE'
        raise parser.error("No current item for #{keyword}") unless @current_item
        process_current_item(parser, keyword, params)

      else
        # blank config.lines will have a nil keyword and should not raise an exception
        raise parser.error("Unknown keyword '#{keyword}'") if keyword
      end # case keyword
    end
  end

  # Complete the last defined packet
  finish_packet()
end

#start_item(parser) ⇒ Object 



166
167
168
169
 
# File 'lib/cosmos/tools/table_manager/table_config.rb', line 166

def start_item(parser)
  finish_item()
  @current_item = TableItemParser.parse(parser, @current_packet, @warnings)
end

#table(table_name) ⇒ Table

Parameters:

  • table_name (String) —

    Table name to return

Returns:



45
46
47
 
# File 'lib/cosmos/tools/table_manager/table_config.rb', line 45

def table(table_name)
  tables[table_name.upcase]
end

#table_names ⇒ Array<String>

Returns All the table names.

Returns:



39
40
41
 
# File 'lib/cosmos/tools/table_manager/table_config.rb', line 39

def table_names
  tables.keys
end

#tables ⇒ Array<Table>

Returns All tables defined in the configuration file.

Returns:

  • (Array<Table>) —

    All tables defined in the configuration file



34
35
36
 
# File 'lib/cosmos/tools/table_manager/table_config.rb', line 34

def tables
  @commands[Table::TARGET]
end