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

WSF_COMM_NETWORK_STAR
---------------------

.. model:: network WSF_COMM_NETWORK_STAR

Script Class: :class:`WsfNetworkStar`

.. parsed-literal::

   network <name> :model:`WSF_COMM_NETWORK_STAR`
      ... :ref:`network Commands <network.Commands>` ...
      
      comm_list_
         member <string-value> <string-value>
         ...
      end_comm_list
      
      address_list_
         member <address-value>
         ...
      end_address_list
      
      hub_named_ <string-value> <string-value>
      
      hub_address_ <address-value>
      
   end_network
   
Overview
========

:model:`WSF_COMM_NETWORK_STAR` provides a generic network that enforces a star topology. One comm object in
this network is designated as a "hub", and all other members of the network only have bi-directional linkage
with the "hub" comm object. This guarantees no more than two hops between any members of this network. Note
that if a hub is not designated in this network, no linkage is created.

Commands
========

.. command:: comm_list ... end_comm_list

   Members of this network may be specified by identifying a comm object by its owning platform name and 
   the name of the comm. Each entry in this list is prefixed by the "member" command.

.. command:: address_list ... end_address_list

   Members of this network may be specified by identifying a comm object by its address. Each entry in this
   list is prefixed by the "member" command. This list is only available to comm objects that have specified
   addresses in input, as comms without specified addresses will be dynamically allocated at runtime.

.. command:: hub_named <string-value> <string-value>

   Specifies the star network hub comm object by its owning platform name, and the comm name. This hub
   must be a member of the network.
   
.. command:: hub_address <address-value>

   Specifies the star network hub comm object by its address. This hub must be a member of the network.