Source code for diamondback.interfaces.IValid

""" **Description**

        Valid interface.

    **Example**

        ::

            from diamondback import IValid

            class Test( IValid ) :

                def __init__( self ) -> None :

                    super( ).__init__( )

                    self.valid = False

            test = Test( )

            test.valid = True

    **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, 2020-10-22.

    **Definition**

"""

from diamondback.interfaces.IEqual import IEqual
import typing

[docs]class IValid( IEqual ) : """ Valid interface. """ @property def valid( self ) : """ valid : bool. """ return self._valid @valid.setter def valid( self, valid : bool ) : self._valid = valid
[docs] def __eq__( self, other : typing.Any ) -> bool : """ Equal. Arguments : other : typing.Any. Returns : equal : bool. """ return ( ( super( ).__eq__( other ) ) and ( self.valid == other.valid ) )
def __init__( self ) -> None : """ Initialize. """ super( ).__init__( ) self._valid = None