Source code for diamondback.interfaces.IResolution

""" **Description**

        Resolution interface.

    **Example**

        ::

            from diamondback import IResolution


            class Test( IResolution ) :

                def __init__( self ) -> None :

                    super( ).__init__( )

                    self.resolution = 0.5

            test = Test( )

            test.resolution = 0.1

    **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, 2018-07-12.

    **Definition**

"""

from diamondback.interfaces.IEqual import IEqual
import numpy
import typing


[docs]class IResolution( IEqual ) : """ Resolution interface. """ @property def resolution( self ) : """ resolution : float - in ( 0.0, inf ). """ return self._resolution @resolution.setter def resolution( self, resolution : float ) : if ( resolution <= 0.0 ) : raise ValueError( f'Resolution = {resolution}' ) self._resolution = resolution
[docs] def __eq__( self, other : typing.Any ) -> bool : """ Equal. Arguments : other : typing.Any. Returns : equal : bool. """ return ( ( super( ).__eq__( other ) ) and ( numpy.isclose( self.resolution, other.resolution ) ) )
def __init__( self ) -> None : """ Initialize. """ super( ).__init__( ) self._resolution = 1.0