fprime_gds.common.pipeline.dictionaries

dictionaries.py:

Helps the standard pipeline wrangle dictionaries by encapsulating the functionality of dictionary loading into a single class called “Dictionaries”.

@author mstarch

Module Contents

Classes

Dictionaries()

Dictionaries class to encapsulate the many different dictionaries used in the system. This includes the following
class fprime_gds.common.pipeline.dictionaries.Dictionaries[source]

Dictionaries class to encapsulate the many different dictionaries used in the system. This includes the following dictionary types:

  1. Command IDs to Commands

  2. Command names to Commands

  3. Channel IDs to Channels

  4. Channel names to Channels

  5. Event IDs to Events

  6. Event names to Events

  7. Packet IDs to Packets

load_dictionaries(self, dictionary, packet_spec)[source]

Loads the dictionaries based on the dictionary path supplied. Optional packet_spec is allowed to specify the definitions of packets.

Parameters

  • dictionary – dictionary path used for loading dictionaries

  • packet_spec – specification for packets, or None, for packetized telemetry

property command_id(self)[source]

Command dictionary by ID

property event_id(self)[source]

Event dictionary by ID

property channel_id(self)[source]

Channel dictionary by ID

property command_name(self)[source]

Command dictionary by name

property event_name(self)[source]

Event dictionary by name

property channel_name(self)[source]

Channel dictionary by name

property packet(self)[source]

Packet dictionary

Build: 1.4.1