:py:mod:`rofunc.devices.optitrack.windows_server.NatNetClient`
==============================================================

.. py:module:: rofunc.devices.optitrack.windows_server.NatNetClient

.. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`NatNetClient <rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`trace <rofunc.devices.optitrack.windows_server.NatNetClient.trace>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.trace
          :summary:
   * - :py:obj:`trace_dd <rofunc.devices.optitrack.windows_server.NatNetClient.trace_dd>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.trace_dd
          :summary:
   * - :py:obj:`trace_mf <rofunc.devices.optitrack.windows_server.NatNetClient.trace_mf>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.trace_mf
          :summary:
   * - :py:obj:`get_message_id <rofunc.devices.optitrack.windows_server.NatNetClient.get_message_id>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.get_message_id
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`Vector2 <rofunc.devices.optitrack.windows_server.NatNetClient.Vector2>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.Vector2
          :summary:
   * - :py:obj:`Vector3 <rofunc.devices.optitrack.windows_server.NatNetClient.Vector3>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.Vector3
          :summary:
   * - :py:obj:`Quaternion <rofunc.devices.optitrack.windows_server.NatNetClient.Quaternion>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.Quaternion
          :summary:
   * - :py:obj:`FloatValue <rofunc.devices.optitrack.windows_server.NatNetClient.FloatValue>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.FloatValue
          :summary:
   * - :py:obj:`DoubleValue <rofunc.devices.optitrack.windows_server.NatNetClient.DoubleValue>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.DoubleValue
          :summary:
   * - :py:obj:`NNIntValue <rofunc.devices.optitrack.windows_server.NatNetClient.NNIntValue>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NNIntValue
          :summary:
   * - :py:obj:`FPCalMatrixRow <rofunc.devices.optitrack.windows_server.NatNetClient.FPCalMatrixRow>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.FPCalMatrixRow
          :summary:
   * - :py:obj:`FPCorners <rofunc.devices.optitrack.windows_server.NatNetClient.FPCorners>`
     - .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.FPCorners
          :summary:

API
~~~

.. py:function:: trace(*args)
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.trace

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.trace

.. py:function:: trace_dd(*args)
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.trace_dd

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.trace_dd

.. py:function:: trace_mf(*args)
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.trace_mf

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.trace_mf

.. py:function:: get_message_id(data)
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.get_message_id

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.get_message_id

.. py:data:: Vector2
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.Vector2
   :value: None

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.Vector2

.. py:data:: Vector3
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.Vector3
   :value: None

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.Vector3

.. py:data:: Quaternion
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.Quaternion
   :value: None

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.Quaternion

.. py:data:: FloatValue
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.FloatValue
   :value: None

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.FloatValue

.. py:data:: DoubleValue
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.DoubleValue
   :value: None

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.DoubleValue

.. py:data:: NNIntValue
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NNIntValue
   :value: None

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NNIntValue

.. py:data:: FPCalMatrixRow
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.FPCalMatrixRow
   :value: None

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.FPCalMatrixRow

.. py:data:: FPCorners
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.FPCorners
   :value: None

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.FPCorners

.. py:class:: NatNetClient()
   :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.__init__

   .. py:attribute:: print_level
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.print_level
      :value: 20

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.print_level

   .. py:attribute:: NAT_CONNECT
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_CONNECT
      :value: 0

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_CONNECT

   .. py:attribute:: NAT_SERVERINFO
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_SERVERINFO
      :value: 1

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_SERVERINFO

   .. py:attribute:: NAT_REQUEST
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_REQUEST
      :value: 2

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_REQUEST

   .. py:attribute:: NAT_RESPONSE
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_RESPONSE
      :value: 3

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_RESPONSE

   .. py:attribute:: NAT_REQUEST_MODELDEF
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_REQUEST_MODELDEF
      :value: 4

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_REQUEST_MODELDEF

   .. py:attribute:: NAT_MODELDEF
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_MODELDEF
      :value: 5

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_MODELDEF

   .. py:attribute:: NAT_REQUEST_FRAMEOFDATA
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_REQUEST_FRAMEOFDATA
      :value: 6

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_REQUEST_FRAMEOFDATA

   .. py:attribute:: NAT_FRAMEOFDATA
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_FRAMEOFDATA
      :value: 7

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_FRAMEOFDATA

   .. py:attribute:: NAT_MESSAGESTRING
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_MESSAGESTRING
      :value: 8

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_MESSAGESTRING

   .. py:attribute:: NAT_DISCONNECT
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_DISCONNECT
      :value: 9

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_DISCONNECT

   .. py:attribute:: NAT_KEEPALIVE
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_KEEPALIVE
      :value: 10

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_KEEPALIVE

   .. py:attribute:: NAT_UNRECOGNIZED_REQUEST
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_UNRECOGNIZED_REQUEST
      :value: 100

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_UNRECOGNIZED_REQUEST

   .. py:attribute:: NAT_UNDEFINED
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_UNDEFINED
      :value: 999999.9999

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.NAT_UNDEFINED

   .. py:method:: set_client_address(local_ip_address)
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.set_client_address

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.set_client_address

   .. py:method:: get_client_address()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_client_address

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_client_address

   .. py:method:: set_server_address(server_ip_address)
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.set_server_address

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.set_server_address

   .. py:method:: get_server_address()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_server_address

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_server_address

   .. py:method:: set_use_multicast(use_multicast)
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.set_use_multicast

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.set_use_multicast

   .. py:method:: can_change_bitstream_version()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.can_change_bitstream_version

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.can_change_bitstream_version

   .. py:method:: set_nat_net_version(major, minor)
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.set_nat_net_version

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.set_nat_net_version

   .. py:method:: get_major()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_major

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_major

   .. py:method:: get_minor()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_minor

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_minor

   .. py:method:: set_print_level(print_level=0)
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.set_print_level

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.set_print_level

   .. py:method:: get_print_level()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_print_level

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_print_level

   .. py:method:: connected()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.connected

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.connected

   .. py:method:: send_request(in_socket, command, command_str, address)
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.send_request

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.send_request

   .. py:method:: send_command(command_str)
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.send_command

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.send_command

   .. py:method:: send_commands(tmpCommands, print_results: bool = True)
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.send_commands

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.send_commands

   .. py:method:: send_keep_alive(in_socket, server_ip_address, server_port)
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.send_keep_alive

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.send_keep_alive

   .. py:method:: get_command_port()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_command_port

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_command_port

   .. py:method:: get_application_name()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_application_name

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_application_name

   .. py:method:: get_nat_net_requested_version()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_nat_net_requested_version

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_nat_net_requested_version

   .. py:method:: get_nat_net_version_server()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_nat_net_version_server

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_nat_net_version_server

   .. py:method:: get_server_version()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_server_version

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.get_server_version

   .. py:method:: Creat_data_command_socket()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.Creat_data_command_socket

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.Creat_data_command_socket

   .. py:method:: run()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.run

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.run

   .. py:method:: shutdown()
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.shutdown

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.shutdown

   .. py:method:: unpack_mocap_data(data: bytes, packet_size, major, minor)
      :canonical: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.unpack_mocap_data

      .. autodoc2-docstring:: rofunc.devices.optitrack.windows_server.NatNetClient.NatNetClient.unpack_mocap_data