Source code for diamondback.interfaces.ITimeOut

""" **Description**

        Time out interface.

    **Example**

        ::

            from diamondback import ITimeOut


            class Test( ITimeOut ) :

                def __init__( self ) -> None :

                    super( ).__init__( )

                    self.timeout = ( 10.0, 60.0 )

            test = Test( )

            test.timeout = ( 15.0, 120.0 )

    **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-10-09.

    **Definition**

"""

from diamondback.interfaces.IEqual import IEqual
import typing


[docs]class ITimeOut( IEqual ) : """ Time out interface. """ @property def timeout( self ) : """ timeout : typing.Any. """ return self._timeout @timeout.setter def timeout( self, timeout : typing.Any ) : self._timeout = timeout
[docs] def __eq__( self, other : typing.Any ) -> bool : """ Equal. Arguments : other : typing.Any. Returns : equal : bool. """ return ( ( super( ).__eq__( other ) ) and ( self.timeout == other.timeout ) )
def __init__( self ) -> None : """ Initialize. """ super( ).__init__( ) self._timeout = None