:class:`CfgTerminal`
====================


.. py:class:: pyedb.configuration.cfg_terminals.CfgTerminal(/, **data: Any)

   Bases: :py:obj:`CfgBase`


   
   !!! abstract "Usage Documentation"
       [Models](../concepts/models.md)

   A base class for creating Pydantic models.

   Attributes:
       __class_vars__: The names of the class variables defined on the model.
       __private_attributes__: Metadata about the private attributes of the model.
       __signature__: The synthesized `__init__` [`Signature`][inspect.Signature] of the model.

       __pydantic_complete__: Whether model building is completed, or if there are still undefined fields.
       __pydantic_core_schema__: The core schema of the model.
       __pydantic_custom_init__: Whether the model has a custom `__init__` function.
       __pydantic_decorators__: Metadata containing the decorators defined on the model.
           This replaces `Model.__validators__` and `Model.__root_validators__` from Pydantic V1.
       __pydantic_generic_metadata__: Metadata for generic models; contains data used for a similar purpose to
           __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.
       __pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models.
       __pydantic_post_init__: The name of the post-init method for the model, if defined.
       __pydantic_root_model__: Whether the model is a [`RootModel`][pydantic.root_model.RootModel].
       __pydantic_serializer__: The `pydantic-core` `SchemaSerializer` used to dump instances of the model.
       __pydantic_validator__: The `pydantic-core` `SchemaValidator` used to validate instances of the model.

       __pydantic_fields__: A dictionary of field names and their corresponding [`FieldInfo`][pydantic.fields.FieldInfo] objects.
       __pydantic_computed_fields__: A dictionary of computed field names and their corresponding [`ComputedFieldInfo`][pydantic.fields.ComputedFieldInfo] objects.

       __pydantic_extra__: A dictionary containing extra values, if [`extra`][pydantic.config.ConfigDict.extra]
           is set to `'allow'`.
       __pydantic_fields_set__: The names of fields explicitly set during instantiation.
       __pydantic_private__: Values of private attributes set on the model instance.















   ..
       !! processed by numpydoc !!


.. py:currentmodule:: CfgTerminal

Overview
--------

.. tab-set::





   .. tab-item:: Attributes

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~name`
            - 
          * - :py:attr:`~impedance`
            - 
          * - :py:attr:`~is_circuit_port`
            - 
          * - :py:attr:`~reference_terminal`
            - 
          * - :py:attr:`~amplitude`
            - 
          * - :py:attr:`~phase`
            - 
          * - :py:attr:`~terminal_to_ground`
            - 
          * - :py:attr:`~boundary_type`
            - 
          * - :py:attr:`~hfss_type`
            - 






Import detail
-------------

.. code-block:: python

    from pyedb.configuration.cfg_terminals import CfgTerminal


Attribute detail
----------------

.. py:attribute:: name
   :type:  str

.. py:attribute:: impedance
   :type:  Union[float, int, str]

.. py:attribute:: is_circuit_port
   :type:  bool

.. py:attribute:: reference_terminal
   :type:  Optional[str]
   :value: None


.. py:attribute:: amplitude
   :type:  Optional[Union[float, int, str]]
   :value: 1


.. py:attribute:: phase
   :type:  Optional[Union[float, int, str]]
   :value: 0


.. py:attribute:: terminal_to_ground
   :type:  Optional[Literal['kNoGround', 'kNegative', 'kPositive']]
   :value: 'kNoGround'


.. py:attribute:: boundary_type
   :type:  Literal['PortBoundary', 'PecBoundary', 'RlcBoundary', 'kCurrentSource', 'kVoltageSource', 'kNexximGround', 'kNexximPort', 'kDcTerminal', 'kVoltageProbe', 'InvalidBoundary']

.. py:attribute:: hfss_type
   :type:  Literal['Wave', 'Gap', None]