:orphan:

.. ****************************************************************************
.. CUI
..
.. The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
..
.. The use, dissemination or disclosure of data in this file is subject to
.. limitation or restriction. See accompanying README and LICENSE for details.
.. ****************************************************************************

WsfTrackId
----------

.. class:: WsfTrackId 
   :cloneable:

WsfTrackId objects are used to identify tracks as defined by :class:`WsfTrack` and :class:`WsfLocalTrack`

Methods
=======

.. method:: string Name()
   
   Returns the name of the owning platform as a string.

.. method:: int Number()
   
   Returns the track number of the track on the owning platform.

.. method:: bool IsNull()
   
   Returns 'true' if the owning platform name has not been assigned.  Calling **WsfTrackId()** returns a null track ID.

.. method:: string ToString()
   
   Returns a string representation of the track ID in the form *<name>:<number>*.

.. method:: static WsfTrackId Construct(string aName, int aNumber)
   
   Returns a track ID with the supplied owning platform name and track number.
   
   .. note::

      Use with great caution as
      track Id's are typically generated internally.

.. method:: void Null()
   
   Clears the name and number in the track ID. This is equivalent to calling SetName_("") and SetNumber_(0).

.. method:: void SetName(string aName)
   
   Sets the name of the owning platform.
   
   .. note::

      Use with great caution as track Id's are typically generated internally.

.. method:: void SetNumber(int aNumber)
   
   Sets the track number of the track on the owning platform.
   
   .. note::

      Use with great caution as track Id's are typically generated internally.