TReK Python  5.3.2
Telemetry/Command API
FormatCollection Class Reference

This class describes a format collection composed of one or more parameter collections. More...

Inherits PacketItem.

Public Member Functions

Initialize / Finalize

Functions handling class initialization and finalization.

def FormatCollection ( Optional[FormatCollection] format_collection=None) -> def 
 Class initializer. More...
 
def clone () -> FormatCollection 
 Creates a new instance of the object with the same contents.
 
def copy (copy_from: object) -> None 
 Copies the contents of the provided 'copy_from' FormatCollection. More...
 
def initialize () -> None 
 Initializes the object. More...
 
def load_file (filename: str) -> None 
 Loads the FormatCollection definition from the specified file. More...
 
def save_file (filename: str) -> None 
 Saves the FormatCollection definition to the specified file. More...
 
Format Collection

Functions handling adding / removing packets.

def add_format ( ParameterCollection param_coll, format_id: int) -> None 
 Adds the packet to the collection. More...
 
def get_format_length () -> int 
 Returns the length of the format. More...
 
def get_format_offset () -> int 
 Returns the offset of the format. More...
 
def get_number_of_formats () -> int 
 Returns the number of formats in the collection. More...
 
def remove_format (format_id: int) -> None 
 Removes the specified format from the format collection. More...
 
def remove_all_formats () -> None 
 Removes all formats from the collection.
 
def set_format_info (offset: int, length: int) -> None 
 Sets the location in the packet buffer where the unsigned format ID can be found. More...
 
Parameters

Functions handling parameters.

def find_parameter (name: str) -> Parameter 
 Finds the specified parameter name in the collection. More...
 
def get_parameter_list (full_name: bool=True, mod_only: bool=False) -> list[str] 
 Returns a list of all parameters within a collection. More...
 
def get_sorted_parameter_list (full_name: bool=True, mod_only: bool=False) -> list[str] 
 Returns a sorted list of all parameters within a collection by their start location. More...
 
Packet

Functions handling Packets.

def build (byte_buffer: bytearray) -> int 
 Builds the parameters in the collection and places it in the specified buffer. More...
 
def extract (buffer: bytearray, input_length: int, start_bit: int) -> int 
 Extracts all of the parameters in the collection from the specified buffer. More...
 
def get_length_in_bits () -> int 
 Gets the length of the parameter collection in bits. More...
 
def get_length_in_bytes () -> int 
 Gets the length of the parameter collection in bytes. More...
 
def get_maximum_length_in_bits () -> int 
 Returns the maximum length of the FormatCollection in bits. More...
 
def has_modifiable_data (data_zone_only: bool=True) -> bool 
 Determines if any of the parameters are modifiable. More...
 
def has_variable_length_data () -> bool 
 Determines if the format collection has any variable length data. More...
 
def is_complete () -> bool 
 Determines if all parameters have a value. More...
 
def is_modifiable (top_level: bool=True) -> bool 
 Determines if any data is modifiable. More...
 
Parameters

Functions handling Parameters.

Packet

Functions handling Packets.

- Public Member Functions inherited from NamedItem
def __eq__ (named_item: object) -> bool 
 Equality operator "==". More...
 
def get_alias () -> str 
 Returns the alias of the item. More...
 
def get_name () -> str 
 Returns the name of the item. More...
 
def get_long_description () -> str 
 Returns the long description of the item. More...
 
def get_short_description () -> str 
 Returns the short description of the item. More...
 
def get_user_description () -> str 
 Returns the user description of the item. More...
 
def get_owner () -> str 
 Returns the owner of the item. More...
 
def set_name (name: str) -> None 
 Sets the name of the item. More...
 
def set_alias (alias: str) -> None 
 Sets the alias of the item. More...
 
def set_short_description (description: str) -> None 
 Sets the short description of the item. More...
 
def set_long_description (description: str) -> None 
 Sets the long description of the item. More...
 
def set_user_description (description: str) -> None 
 Sets the user description of the item. More...
 
def set_owner (owner: str) -> None 
 Sets the owner of the item. More...
 

Detailed Description

This class describes a format collection composed of one or more parameter collections.

The FormatCollection class holds one or more formats that can be processed based on the foramt id.

Constructor & Destructor Documentation

◆ FormatCollection()

FormatCollection (format_collection : Optional[FormatCollection]