﻿fdtdx.OnOffSwitch
=================

.. currentmodule:: fdtdx

.. autoclass:: OnOffSwitch
   :show-inheritance:

Quick Reference
---------------



.. rubric:: Attributes





* :attr:`~OnOffSwitch.end_after_periods`



* :attr:`~OnOffSwitch.end_time`



* :attr:`~OnOffSwitch.fixed_on_time_steps`



* :attr:`~OnOffSwitch.interval`



* :attr:`~OnOffSwitch.is_always_off`



* :attr:`~OnOffSwitch.on_for_periods`



* :attr:`~OnOffSwitch.on_for_time`



* :attr:`~OnOffSwitch.period`



* :attr:`~OnOffSwitch.start_after_periods`



* :attr:`~OnOffSwitch.start_time`






.. rubric:: Methods





* :attr:`~OnOffSwitch.aset`



* :attr:`~OnOffSwitch.calculate_on_list`



* :attr:`~OnOffSwitch.calculate_time_step_to_on_arr_idx`



* :attr:`~OnOffSwitch.get_class_fields`



* :attr:`~OnOffSwitch.get_public_fields`



* :attr:`~OnOffSwitch.is_on_at_time_step`







Attributes
==========





.. autoattribute:: OnOffSwitch.end_after_periods



.. autoattribute:: OnOffSwitch.end_time



.. autoattribute:: OnOffSwitch.fixed_on_time_steps



.. autoattribute:: OnOffSwitch.interval



.. autoattribute:: OnOffSwitch.is_always_off



.. autoattribute:: OnOffSwitch.on_for_periods



.. autoattribute:: OnOffSwitch.on_for_time



.. autoattribute:: OnOffSwitch.period



.. autoattribute:: OnOffSwitch.start_after_periods



.. autoattribute:: OnOffSwitch.start_time








Methods
==========








.. automethod:: OnOffSwitch.aset





.. automethod:: OnOffSwitch.calculate_on_list





.. automethod:: OnOffSwitch.calculate_time_step_to_on_arr_idx





.. automethod:: OnOffSwitch.get_class_fields





.. automethod:: OnOffSwitch.get_public_fields





.. automethod:: OnOffSwitch.is_on_at_time_step






If you find any errors in the documentation, please report them in the `Github Issues <https://github.com/ymahlau/fdtdx/issues>`_!