""" **Description**
Frequency interface.
**Example**
::
from diamondback import IFrequency
class Test( IFrequency ) :
def __init__( self ) -> None :
super( ).__init__( )
self.frequency = 1.0
test = Test( )
test.frequency = 0.5
**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-01-31.
**Definition**
"""
from diamondback.interfaces.IEqual import IEqual
import numpy
import typing
[docs]class IFrequency( IEqual ) :
""" Frequency interface.
"""
@property
def frequency( self ) :
""" frequency : float - relative to Nyquist in [ -1.0, 1.0 ].
"""
return self._frequency
@frequency.setter
def frequency( self, frequency : float ) :
if ( ( frequency < -1.0 ) or ( frequency > 1.0 ) ) :
raise ValueError( f'Frequency = {frequency}' )
self._frequency = frequency
[docs] def __eq__( self, other : typing.Any ) -> bool :
""" Equal.
Arguments :
other : typing.Any.
Returns :
equal : bool.
"""
return ( ( super( ).__eq__( other ) ) and ( numpy.isclose( self.frequency, other.frequency ) ) )
def __init__( self ) -> None :
""" Initialize.
"""
super( ).__init__( )
self._frequency = 0.0