space_packet_parser.xtce.parameters

ParameterType definitions

Classes

Parameter

<xtce:Parameter>

Module Contents

class space_packet_parser.xtce.parameters.Parameter

Bases: space_packet_parser.common.Parseable, space_packet_parser.common.XmlObject

<xtce:Parameter>

Parameters:

  • name (str) – Parameter name. Typically something like MSN__PARAMNAME

  • parameter_type (parameter_types.ParameterType) – Parameter type object that describes how the parameter is stored.

  • short_description (str) – Short description of parameter as parsed from XTCE

  • long_description (str) – Long description of parameter as parsed from XTCE

name: str
parameter_type: space_packet_parser.xtce.parameter_types.ParameterType
short_description: str | None = None
long_description: str | None = None
parse(packet: space_packet_parser.SpacePacket) → None

Parse this parameter from the packet data.

Parse the parameter and add it to the packet dictionary.

classmethod from_xml(element: lxml.etree.Element, *, parameter_type_lookup: dict[str, space_packet_parser.xtce.parameter_types.ParameterType], tree: lxml.etree.ElementTree | None = None, parameter_lookup: dict[str, any] | None = None, container_lookup: dict[str, any] | None = None) → Parameter

Create a Parameter object from an XML element.

Parameters:

  • element (ElementTree.Element) – XML element

  • tree (Optional[ElementTree.Element]) – Ignored

  • parameter_lookup (Optional[dict]) – Ignored

  • parameter_type_lookup (dict[str, ParameterType]) – Ignored

  • container_lookup (Optional[dict[str, SequenceContainer]]) – Ignored

Return type:

Parameter

to_xml(*, elmaker: lxml.builder.ElementMaker) → lxml.etree.Element

Create a Parameter XML element

Parameters:

elmaker (ElementMaker) – Element factory with predefined namespace

Return type:

ElementTree.Element