netsse.base.Platform
====================

.. toctree::
   :hidden:

   /api/netsse/base/Platform.add_operation
   /api/netsse/base/Platform.remove_operation
   /api/netsse/base/Platform.add_seastatecollec
   /api/netsse/base/Platform.remove_seastatecollec

.. py:class:: netsse.base.Platform(name: str = None, owner: str = 'undefined', operations: list = [], seastate_collections: list = [])

   Initialises the platform.

   :param name: Name of the platform. By default, the name string is generated randomly
                in the format ``PlatformXXXXX``.
   :type name: str, optional
   :param owner: Platform owner.
   :type owner: str, default 'undefined'
   :param operations: List of operations.
   :type operations: list, default []
   :param seastate_collections: List of sea state collections (as `SeaStateCollec` instances).
   :type seastate_collections: list, default []

   .. seealso:: :obj:`Network`, :obj:`Operation`, :obj:`SeaStateCollec`, :obj:`Vessel`, :obj:`Buoy`, :obj:`WaveRadar`

   .. rubric:: Example

   >>> operation1 = netsse.base.Operation()
   >>> seastatecollec1 = netsse.base.SeaStateCollec()
   >>> platform1 = netsse.base.Platform(name='MyPlatform',owner='SomeCompany',        ...                                  operations=[operation1],        ...                                  seastate_collections=[seastatecollec1])

Methods
-------

.. autoapisummary::

   netsse.base.Platform.add_operation
   netsse.base.Platform.remove_operation
   netsse.base.Platform.add_seastatecollec
   netsse.base.Platform.remove_seastatecollec