TReK Python  5.3.2
Telemetry/Command API
PacketItem Class Reference

PacketItem is the base abstraction for data that can be added to a Packet. More...

Inherits NamedItem.

Inherited by FormatCollection, Packet, ParameterCollection, and RandomPacketCollection.

Public Member Functions

Parameters

Functions handling Parameters.

def find_parameter (name: str) -> Parameter 
 Finds the specified parameter 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 get_length_in_bits () -> int 
 Returns the length of the PacketItem in bits. More...
 
def get_length_in_bytes () -> int 
 Returns the length of the PacketItem in bytes. More...
 
def get_maximum_length_in_bits () -> int 
 Returns the maximum length of the PacketItem in bits. More...
 
def has_modifiable_data (data_zone_only: bool=True) -> bool 
 Determines if any parameter in the PacketItem is modifiable. More...
 
def has_variable_length_data () -> bool 
 Determines if the PacketItem 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...
 
- Public Member Functions inherited from NamedItem
def PacketItem ( Optional[NamedItem] named_item=None) -> None 
 Class initializer. More...
 
def __eq__ (named_item: object) -> bool 
 Equality operator "==". More...
 
def copy (copy_from: object) -> None 
 Copies the contents of the provided 'copy_from' NamedItem into this NamedItem. More...
 
def initialize () -> None 
 Initializes the object. 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

PacketItem is the base abstraction for data that can be added to a Packet.

Use derived classes.

Member Function Documentation

◆ find_parameter()

find_parameter (name : str