space_packet_parser.xtce.parameters
===================================

.. py:module:: space_packet_parser.xtce.parameters

.. autoapi-nested-parse::

   ParameterType definitions



Classes
-------

.. autoapisummary::

   space_packet_parser.xtce.parameters.Parameter


Module Contents
---------------

.. py:class:: Parameter

   Bases: :py:obj:`space_packet_parser.common.Parseable`, :py:obj:`space_packet_parser.common.XmlObject`


   <xtce:Parameter>

   :param name: Parameter name. Typically something like MSN__PARAMNAME
   :type name: str
   :param parameter_type: Parameter type object that describes how the parameter is stored.
   :type parameter_type: parameter_types.ParameterType
   :param short_description: Short description of parameter as parsed from XTCE
   :type short_description: str
   :param long_description: Long description of parameter as parsed from XTCE
   :type long_description: str


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: parameter_type
      :type:  space_packet_parser.xtce.parameter_types.ParameterType


   .. py:attribute:: short_description
      :type:  str | None
      :value: None



   .. py:attribute:: long_description
      :type:  str | None
      :value: None



   .. py:method:: parse(packet: space_packet_parser.SpacePacket) -> None

      Parse this parameter from the packet data.

      Parse the parameter and add it to the packet dictionary.



   .. py:method:: 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
      :classmethod:


      Create a Parameter object from an XML element.

      :param element: XML element
      :type element: ElementTree.Element
      :param tree: Ignored
      :type tree: Optional[ElementTree.Element]
      :param parameter_lookup: Ignored
      :type parameter_lookup: Optional[dict]
      :param parameter_type_lookup: Ignored
      :type parameter_type_lookup: dict[str, ParameterType]
      :param container_lookup: Ignored
      :type container_lookup: Optional[dict[str, SequenceContainer]]

      :rtype: Parameter



   .. py:method:: to_xml(*, elmaker: lxml.builder.ElementMaker) -> lxml.etree.Element

      Create a Parameter XML element

      :param elmaker: Element factory with predefined namespace
      :type elmaker: ElementMaker

      :rtype: ElementTree.Element