Trace Settings
==============

.. py:module:: Nets
    :noindex:

.. py:class:: TraceSettings

    Control how a net's trace on an oscilloscope is viewed.
    These methods are exclusive to nets of type :py:class:`Analog`.

    .. py:method:: set_volt_offset(offset)

        Method for setting the scope trace voltage offset.

        .. code-block:: python
            :emphasize-lines: 8

            from lager import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            v33_net.trace_settings.set_volt_offset(0.5) #sets voltage offset to 0.5V

        :param float offset: Voltage offset of trace signal in Volts

    .. py:method:: get_volt_offset()

        Get the scope trace voltage offset

        .. code-block:: python
            :emphasize-lines: 9

            from lager import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            v33_net.trace_settings.set_volt_offset(0.5)
            offset = v33_net.trace_settings.get_volt_offset()
            print(offset)

        :return: voltage offset
        :rtype: float

    .. py:method:: set_volts_per_div(volts)

        Set the trace signal's volts per division

        .. code-block:: python
            :emphasize-lines: 8

            from lager.pcb.net import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            v33_net.trace_settings.set_volts_per_div(1) #sets 1V/div

        :param float volts: Volts per division to set in Volts
       
    .. py:method:: get_volts_per_div()

        Get the trace signal's volts per division

        .. code-block:: python
            :emphasize-lines: 9

            from lager import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            v33_net.trace_settings.set_volts_per_div(1) #sets 1V/div
            volts_div = v33_net.trace_settings.get_volts_per_div()
            print(volts_div)

        :return: volts per division
        :rtype: float

    .. py:method:: set_time_per_div(time)

        Set the trace signal's volts per division

        .. code-block:: python
            :emphasize-lines: 8

            from lager import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            v33_net.trace_settings.set_time_per_div(.001) #sets 1ms/div

        :param float time: Time per division to set in Seconds

    .. py:method:: get_time_per_div()

        Get the trace signal's time per division

        .. code-block:: python
            :emphasize-lines: 9

            from lager import Net, NetType

            v33_net = Net.get('+3.3V',
                        type=NetType.Analog,
                        setup_function=setup_net,
                        teardown_function=teardown_net)
            v33_net.enable()
            v33_net.trace_settings.set_time_per_div(.001) #sets 1ms/div
            time = v33_net.trace_settings.get_time_per_div()
            print(time)

        :return: time per division
        :rtype: float