Source code for diamondback.interfaces.IClear

""" **Description**

        Clear interface.

    **Example**

        ::

            from diamondback import IClear, IPhase

            class Test( IClear, IPhase ) :

                def clear( self ) -> None :

                    self.phase = 0.0

            test = Test( )

            test.clear( )

    **License**

        `BSD-3C.  <https://github.com/larryturner/diamondback/blob/master/license>`_

        © 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.

    **Author**

        Larry Turner, Schneider Electric, Analytics & AI, 2019-01-25.

    **Definition**

"""

from abc import ABC, abstractmethod

[docs]class IClear( ABC ) : """ Clear interface. """ def __init__( self ) -> None : """ Initialize. """ super( ).__init__( )
[docs] @abstractmethod def clear( self ) -> None : """ Clears an instance. """ pass