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

Documentation Standard: Script Class
====================================

This document extends the :doc:`afsim_documentation_standard`.


The **\.. class::** directive is used to document script classes. This directive creates an entry in the class index and a link target, referenceable with the **:class:** role.

Documenting Classes
-------------------

.. list-table::
   :class: example-rst
   :header-rows: 1

   * - **Example**
     - **Markup**

   * - .. parsed-literal::

         :class:`WsfGeoPoint` newGeoPoint();

     - ::

         .. class:: WsfGeoPoint

   * - ::

         <class-name> <class-instance-name>

     - ::

         .. class:: <class-name> [inherits <base-class>]

Cross-Referencing Classes
"""""""""""""""""""""""""

.. list-table::
   :class: example-rst
   :header-rows: 1

   * - **Markup**
     - **Result**

   * - .. code-block:: rest

         Script Class Cross-Reference

         See :class:`WsfGeoPoint`

     -   Script Class Cross-Reference

         See :class:`WsfGeoPoint`

Script Class Methods
--------------------

The **\.. method::** directive is used to document script class methods. This directive creates a link target that can be referenced by the **:method:** role.

.. list-table::
   :class: example-rst
   :header-rows: 1

   * - **Example**
     - **Markup**

   * - .. parsed-literal::

         double alt = WsfGeoPoint.Altitude();

     - ::

         .. method:: double Altitude()

   * - ::

         <return-type> <variable> = <class-name>.<method-name>( [<arg-list>] );

     - ::

         .. method:: <return-type> <method-name>( [<arg-list>] )

Cross-Referencing Class Methods
"""""""""""""""""""""""""""""""

.. list-table::
   :class: example-rst
   :header-rows: 1

   * - **Markup**
     - **Result**

   * - .. code-block:: rest

         Method Cross-Reference

         See :method:`WsfGeoPoint.Altitude`

     -   Method Cross-Reference

         See :method:`WsfGeoPoint.Altitude`

Script Class Page Structure
---------------------------

Script classes and their methods are available from within the AFSIM script context. Each defined script class is documented in its own page,
containing a full list of that script class's methods. These pages are targeted toward more advanced users and focus primarily on available methods.

.. topic:: Example Pages

   .. hlist::
      :columns: 4

      * :doc:`../script/wsfplatform`
      * :doc:`../script/sun`
      * :doc:`../script/wsfsensor`

.. topic:: Page Template

   File: <script-class-name>.rst

   .. code-block:: rest

      <script-class-name>
      ===================

      .. class:: <script-class-name> [inherits <inherited-class-name>]

      Static Methods
      --------------

      .. method:: <return-type> <script-class-static-method-1>( [arg-list] )

      ...

      Methods
      -------

      ...

      Other Methods
      -------------

      ...