===========================
``topology.platforms.node``
===========================

.. automodule:: topology.platforms.node

   .. contents::
      :local:

.. currentmodule:: topology.platforms.node


Classes
=======

- :py:class:`HighLevelShellAPI`:
  API used to interact with node shells.

- :py:class:`LowLevelShellAPI`:
  API used to interact with low level shell objects.

- :py:class:`ServicesAPI`:
  API to gather information and connection parameters to a node services.

- :py:class:`StateAPI`:
  API to control the enable/disabled state of a node.

- :py:class:`BaseNode`:
  Base engine node class.

- :py:class:`CommonNode`:
  Base engine node class with a common base implementation.


.. autoclass:: HighLevelShellAPI
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: HighLevelShellAPI
      :parts: 1

.. autoclass:: LowLevelShellAPI
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: LowLevelShellAPI
      :parts: 1

.. autoclass:: ServicesAPI
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ServicesAPI
      :parts: 1

.. autoclass:: StateAPI
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StateAPI
      :parts: 1

.. autoclass:: BaseNode
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: BaseNode
      :parts: 1

.. autoclass:: CommonNode
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CommonNode
      :parts: 1