""" **Description**
Period interface.
**Example**
::
from diamondback import IPeriod
class Test( IPeriod ) :
def __init__( self ) -> None :
super( ).__init__( )
self.period = 0.0
test = Test( )
test.period = 300.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, 2018-07-12.
**Definition**
"""
from diamondback.interfaces.IEqual import IEqual
from typing import Any
import numpy
[docs]class IPeriod( IEqual ) :
""" Period interface.
"""
@property
def period( self ) :
""" period : float - in seconds in [ 0.0, inf ).
"""
return self._period
@period.setter
def period( self, period : float ) :
if ( period < 0.0 ) :
raise ValueError( f'Period = {period}' )
self._period = period
[docs] def __eq__( self, other : Any ) -> bool :
""" Equal.
Arguments :
other : Any.
Returns :
equal : bool.
"""
return ( ( super( ).__eq__( other ) ) and ( numpy.isclose( self.period, other.period ) ) )
def __init__( self ) -> None :
""" Initialize.
"""
super( ).__init__( )
self._period = 0.0