diamondback.interfaces package¶
Submodules¶
diamondback.interfaces.IA module¶
Description
Recursive coefficient interface.
Example
from diamondback import IA import numpy class Test( IA ) : def __init__( self ) -> None : super( ).__init__( ) self.a = numpy.array( [ 0.0, 0.1 ] ) test = Test( ) test.a[ : ] = 0.0
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-01-31.
Definition
-
class
diamondback.interfaces.IA.
IA
[source]¶ Bases:
diamondback.interfaces.IEqual.IEqual
Recursive coefficient interface.
Initialize.
-
property
a
¶ typing.Union[ typing.List, numpy.ndarray ] - recursive coefficient.
- Type
a
-
property
diamondback.interfaces.IB module¶
Description
Forward coefficient interface.
Example
from diamondback import IB import numpy class Test( IB ) : def __init__( self ) -> None : super( ).__init__( ) self.b = numpy.array( [ 0.75, 0.25 ] ) test = Test( ) test.b[ : ] = 0.5
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-01-31.
Definition
-
class
diamondback.interfaces.IB.
IB
[source]¶ Bases:
diamondback.interfaces.IEqual.IEqual
Forward coefficient interface.
Initialize.
-
property
b
¶ typing.Union[ typing.List, numpy.ndarray ] - forward coefficient.
- Type
b
-
property
diamondback.interfaces.IClear module¶
Description
Clear interface.
Example
from diamondback import IClear, IPhase class Test( IClear, IPhase ) : def clear( self ) -> None : self.phase = 0.0 test = Test( ) test.clear( )
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2019-01-25.
Definition
diamondback.interfaces.IConfigure module¶
Description
Configure interface.
Example
from diamondback import IConfigure class Test( IConfigure ) : def __init__( self ) -> None : super( ).__init__( ) self.configure = [ ] test = Test( ) test.configure = { 'a' : 0.0, 'b' : 1.0 }
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2020-10-27.
Definition
diamondback.interfaces.ICount module¶
Description
Count interface.
Example
from diamondback import ICount class Test( ICount ) : def __init__( self ) -> None : super( ).__init__( ) self.count = 0 test = Test( ) test.count = 3
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2021-01-08.
Definition
diamondback.interfaces.IData module¶
Description
Data interface.
Example
from diamondback import IData class Test( IData ) : def __init__( self ) -> None : super( ).__init__( ) self.data = [ ] test = Test( ) test.data = { 'a' : 0.0, 'b' : 1.0 }
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-07-12.
Definition
diamondback.interfaces.IDate module¶
” Description
Date interface.
Example
from diamondback import IDate import datetime class Test( IDate ) : def __init__( self ) -> None : super( ).__init__( ) self.date = datetime.datetime.utcnow( ).replace( microsecond = 0, tzinfo = datetime.timezone.utc ) test = Test( ) test.date += datetime.timedelta( hours = 4 )
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-07-12.
Definition
diamondback.interfaces.IDispose module¶
Description
Dispose interface.
Example
from diamondback import IDispose class Test( IDispose ) : def __init__( self ) -> None : super( ).__init__( ) self.dispose = False test = Test( ) test.dispose = True
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2020-10-22.
Definition
diamondback.interfaces.IDuration module¶
Description
Duration interface.
Example
from diamondback import IDuration class Test( IDuration ) : def __init__( self ) -> None : super( ).__init__( ) self.duration = 0.0 test = Test( ) test.duration = 3600.0
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-07-12.
Definition
-
class
diamondback.interfaces.IDuration.
IDuration
[source]¶ Bases:
diamondback.interfaces.IEqual.IEqual
Duration interface.
Initialize.
-
property
duration
¶ float - in seconds in [ 0.0, inf ).
- Type
duration
-
property
diamondback.interfaces.IEqual module¶
Description
Equal interface.
Example
from diamondback import IEqual, IPhase import typing class Test( IEqual, IPhase ) : def __eq__( self, other : typing.Any ) -> bool : return ( ( super( ).__eq__( other ) ) and ( numpy.isclose( self.phase, other.phase ) ) )
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-01-23.
Definition
diamondback.interfaces.IFrequency module¶
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
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-01-31.
Definition
-
class
diamondback.interfaces.IFrequency.
IFrequency
[source]¶ Bases:
diamondback.interfaces.IEqual.IEqual
Frequency interface.
Initialize.
-
property
frequency
¶ float - relative to Nyquist in [ -1.0, 1.0 ].
- Type
frequency
-
property
diamondback.interfaces.IIdentity module¶
Description
Identity interface.
Example
from diamondback import IIdentity import uuid class Test( IIdentity ) : def __init__( self ) -> None : super( ).__init__( ) self.identity = str( uuid.uuid4( ) ) test = Test( ) test.identity
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2020-09-23.
Definition
diamondback.interfaces.IInterval module¶
Description
Interval interface.
Example
from diamondback import IInterval class Test( IInterval ) : def __init__( self ) -> None : super( ).__init__( ) self.interval = 0.0 test = Test( ) test.interval = 7200.0
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-07-12.
Definition
-
class
diamondback.interfaces.IInterval.
IInterval
[source]¶ Bases:
diamondback.interfaces.IEqual.IEqual
Interval interface.
Initialize.
-
property
interval
¶ float - in seconds in [ 0.0, inf ).
- Type
interval
-
property
diamondback.interfaces.ILabel module¶
Description
Label interface.
Example
from diamondback import ILabel class Test( ILabel ) : def __init__( self ) -> None : super( ).__init__( ) self.label = '' test = Test( ) test.label = 'label'
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2021-03-15.
Definition
diamondback.interfaces.ILatency module¶
Description
Latency interface.
Example
from diamondback import ILatency class Test( ILatency ) : def __init__( self ) -> None : super( ).__init__( ) self.latency = 0.0 test = Test( ) test.latency = 600.0
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-07-12.
Definition
diamondback.interfaces.ILive module¶
Description
Live interface.
Example
from diamondback import ILive class Test( ILive ) : def __init__( self ) -> None : super( ).__init__( ) self.live = False test = Test( ) test.live = True
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2021-01-12.
Definition
diamondback.interfaces.IModel module¶
Description
Model interface.
Example
from diamondback import IModel, Serial class Test( IModel ) : def __init__( self ) -> None : super( ).__init__( ) self.model = [ ] test = Test( ) test.model = Serial.encode( { 'a' : 0.0, 'b' : 1.0 } )
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-07-12.
Definition
diamondback.interfaces.IPath module¶
Description
Path interface.
Example
from diamondback import IPath class Test( IPath ) : def __init__( self ) -> None : super( ).__init__( ) self.path = '' test = Test( ) test.path = '.\data'
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2020-01-09.
Definition
diamondback.interfaces.IPeriod module¶
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
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-07-12.
Definition
diamondback.interfaces.IPhase module¶
Description
Phase interface.
Example
from diamondback import IPhase class Test( IPhase ) : def __init__( self ) -> None : super( ).__init__( ) self.phase = 0.0 test = Test( ) test.phase = 0.5
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-01-31.
Definition
diamondback.interfaces.IProxy module¶
Description
Proxy interface.
Example
from diamondback import IProxy class Test( IProxy ) : def __init__( self ) -> None : super( ).__init__( ) self.proxy = { 'http' : 'http://proxy.net:9480', 'https' : 'https://proxy.net:8080' } test = Test( ) test.proxy[ 'http' ] = 'http://proxy.net:80'
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2020-09-25.
Definition
diamondback.interfaces.IQ module¶
Description
State derivative interface.
Example
from diamondback import IQ import numpy class Test( IQ ) : def __init__( self ) -> None : super( ).__init__( ) self.q = numpy.array( [ 0.0, 0.1 ] ) test = Test( ) test.q[ : ] = 0.1
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-01-31.
Definition
-
class
diamondback.interfaces.IQ.
IQ
[source]¶ Bases:
diamondback.interfaces.IEqual.IEqual
State derivative interface.
Initialize.
-
property
q
¶ typing.Union[ typing.List, numpy.ndarray ] - state derivative.
- Type
q
-
property
diamondback.interfaces.IRate module¶
Description
Rate interface.
Example
from diamondback import IRate class Test( IRate ) : def __init__( self ) -> None : super( ).__init__( ) self.rate = 5.0e-2 test = Test( ) test.rate = 1.0e-3
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-01-31.
Definition
diamondback.interfaces.IReady module¶
Description
Ready interface.
Example
from diamondback import IReady class Test( IReady ) : def __init__( self ) -> None : super( ).__init__( ) self.ready = False test = Test( ) test.ready = True
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2021-01-12.
Definition
diamondback.interfaces.IReset module¶
Description
Reset interface.
Example
from diamondback import IReset, IS import numpy import typing class Test( IReset, IS ) : def reset( self, x : typing.Union[ complex, float ] ) -> None : self.s[ : ] = x test = Test( ) test.s = numpy.array( [ 0.0, 1.0 ] ) test.reset( 0.5 )
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-03-12.
Definition
diamondback.interfaces.IResolution module¶
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
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-07-12.
Definition
diamondback.interfaces.IRotation module¶
Description
Rotation interface.
Example
from diamondback import IRotation class Test( IRotation ) : def __init__( self ) -> None : super( ).__init__( ) self.rotation = 0.0 test = Test( ) test.rotation = 90.0
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2019-10-09.
Definition
diamondback.interfaces.IS module¶
Description
State interface.
Example
from diamondback import IS import numpy class Test( IS ) : def __init__( self ) -> None : super( ).__init__( ) self.s = numpy.array( [ 0.0, 0.1 ] ) test = Test( ) test.s[ : ] = 0.0
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-01-31.
Definition
diamondback.interfaces.IStream module¶
Description
Stream interface.
Example
from diamondback import IStream import sys class Test( IStream ) : def __init__( self ) -> None : super( ).__init__( ) self.stream = sys.stdout test = Test( ) test.stream = sys.stderr
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2020-10-15.
Definition
diamondback.interfaces.ITimeOut module¶
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
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2019-10-09.
Definition
diamondback.interfaces.ITimeZone module¶
” Description
Time zone interface.
Example
from diamondback import ITimeZone import datetime import pytz class Test( ITimeZone ) : def __init__( self ) -> None : super( ).__init__( ) self.timezone = datetime.timezone.utc test = Test( ) test.timezone = pytz.timezone( 'US/Eastern' )
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2018-07-12.
Definition
diamondback.interfaces.IUrl module¶
Description
Url interface.
Example
from diamondback import IUrl class Test( IUrl ) : def __init__( self ) -> None : super( ).__init__( ) self.url = 'http://127.0.0.1:8080/service' test = Test( ) test.url = 'http://10.0.0.1:8080/service'
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2020-09-25.
Definition
diamondback.interfaces.IValid module¶
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
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2020-10-22.
Definition
diamondback.interfaces.IVersion module¶
Description
Version interface.
Example
from diamondback import IVersion class Test( IVersion ) : def __init__( self ) -> None : super( ).__init__( ) self.version = '1.0.1' test = Test( ) test.version = '1.0.2'
License
© 2018 - 2021 Larry Turner, Schneider Electric Industries SAS. All rights reserved.
Author
Larry Turner, Schneider Electric, Analytics & AI, 2020-09-23.
Definition