: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.
.. ****************************************************************************

WsfXIO_PublishKey
-----------------

.. class:: WsfXIO_PublishKey

A WsfXIO_PublishKey represents a unique identifier for a publication sent/received over XIO.  See :class:`WsfXIO` for methods to publish and subscribe.

Static Methods
==============

.. method:: WsfXIO_PublishKey Construct(Object aField1)
.. method:: WsfXIO_PublishKey Construct(Object aField1, Object aField2)
.. method:: WsfXIO_PublishKey Construct(Object aField1, Object aField2, Object aField3)
.. method:: WsfXIO_PublishKey Construct(Object aField1, Object aField2, Object aField3, Object aField4)

   Parameters aField2, aField3, aField4 are all optional (A key can have 1-4 fields).  Returns a key with the specified
   fields.  Each parameter can be a basic script type, which is converted to a string.

   .. note::

      In cases where a key is used to subscribe, a field with value "*" is a wildcard and matches any value.


Methods
=======

.. method:: string ToString()

   Return a string representation of the key.  This is mainly useful for printing the key with **writeln**.

.. method:: string Field(int aFieldIndex)

   Return the indexed field.  aFieldIndex should be in the range [0, 3].

.. method:: bool Match(WsfXIO_PublishKey aKey)

   Returns true if this key matches aKey.  Wildcard fields in this key will be matched to any value in aKey.