aboutsummaryrefslogtreecommitdiff
path: root/docs/source/sections/tech_docs/components/component_base.rst
blob: a4194bfc3a8ccd2afc946ff9774ae66709ce8ba7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
==========================
Component Base Class
==========================

.. codeauthor:: Jeremy Ernst

.. autoclass:: artv2.components.base_components.base_component.ART_Component
    :members:

Properties
----------

.. py:attribute:: prefix

        This property holds the component's prefix (optional)

        :return: Returns the component's prefix.
        :rtype: str

.. py:attribute:: suffix

        This property holds the component's suffix (optional)

        :return: Returns the component's suffix.
        :rtype: str

.. py:attribute:: parent

        This property holds the joint name of the parent of this component.

.. py:attribute:: network_node

        This property holds the network node that contains this module's metadata.