=============
TLine / Cable
=============

.. py:module:: mhi.xml.pscad.twm
	:synopsis: Travelling Wave Models

.. py:currentmodule:: mhi.xml.pscad.twm

TLines and Cables collectively are known as Travelling Wave Models.
They are built up from specific components which may only be placed
on the Travelling Wave Model's canvas.


---------------------
Travelling Wave Model
---------------------

.. autoclass:: RowDefn

	Instance creation
	=================

	.. automethod:: create_instance

    Option creation
    ===============

    Referencing any of the following properties will automatically create the
    element on the Travelling Wave Model's canvas.
    It can also remove incompatible elements.
    For instance, referencing the ``bergeron_options`` property will automatically
    destroy any frequency dependent elements on the canvas.

	.. autoproperty:: bergeron_options
	.. autoproperty:: freq_phase_options
	.. autoproperty:: additional_options
	.. autoproperty:: ground
	.. autoproperty:: manual_yz

    Towers
    ======

    Towers can be added to a Travelling Wave Model's canvas, to control the
    locations of conductors.

	.. automethod:: towers

    Tower creation
    --------------

    The following methods may be used to create new towers on the Travelling Wave
    Model's canvas.

	.. automethod:: tower_1
	.. automethod:: tower_2_flat
	.. automethod:: tower_3_flat
	.. automethod:: tower_3_delta
	.. automethod:: tower_3_concent
	.. automethod:: tower_3_offset
	.. automethod:: tower_3_vert
	.. automethod:: tower_6_vert1
	.. automethod:: tower_6_concent
	.. automethod:: tower_6_offset
	.. automethod:: tower_6_vert
	.. automethod:: tower_6_flat
	.. automethod:: tower_6_delta
	.. automethod:: tower_12_vert
	.. automethod:: tower_universal


.. py:currentmodule:: mhi.xml.pscad.twm_types

--------
Bergeron
--------

.. autoclass:: BergOptions

	.. autoproperty:: parameters
	.. autoclass:: mhi.xml.pscad.twm_types::BergOptions.Parameters()
		:members:
		:undoc-members:

---------------------------
Frequency Dependent Options
---------------------------

.. autoclass:: FreDepOptions

	.. autoproperty:: parameters
	.. autoclass:: mhi.xml.pscad.twm_types::FreDepOptions.Parameters()
		:members:
		:undoc-members:

.. autoclass:: FrePhaseOptions

	.. autoproperty:: parameters
	.. autoclass:: mhi.xml.pscad.twm_types::FrePhaseOptions.Parameters()
		:members:
		:undoc-members:

-----------------
Grounding Options
-----------------

.. autoclass:: Ground

	.. autoproperty:: parameters
	.. autoclass:: mhi.xml.pscad.twm_types::Ground.Parameters()
		:members:
		:undoc-members:

------------
Manual Entry
------------

.. autoclass:: ManualYZ

	.. autoproperty:: parameters
	.. autoclass:: mhi.xml.pscad.twm_types::ManualYZ.Parameters()
		:members:
		:undoc-members:

---------------
Display Options
---------------

.. autoclass:: OutDisp

	.. autoproperty:: parameters
	.. autoclass:: mhi.xml.pscad.twm_types::OutDisp.Parameters()
		:members:
		:undoc-members:

.. autoclass:: ConstantsDebug

	.. autoproperty:: parameters
	.. autoclass:: mhi.xml.pscad.twm_types::ConstantsDebug.Parameters()
		:members:
		:undoc-members:
