TSLab API Docs  1
TSLab.Script.Optimization.NumericOptimProperty< TValue, TOptimData > Class Template Reference
Inheritance diagram for TSLab.Script.Optimization.NumericOptimProperty< TValue, TOptimData >:
TSLab.Script.Optimization.OptimPropertyBase< TValue, TOptimData > TSLab.Script.Optimization.OptimBase TSLab.Script.Optimization.IOptimPropertyBase< TValue > TSLab.Script.Optimization.IOptimBase

Protected Member Functions

 NumericOptimProperty (TValue value, TValue minValue, TValue maxValue, TValue step)
 
 NumericOptimProperty (TValue value, bool isCalculable, TValue minValue, TValue maxValue, TValue step)
 
override void UpdateFromData ()
 Update (restore) members from OptimData instance More...
 
override IOptimDataBase MakeData ()
 Make OptimData instance (to store) More...
 
- Protected Member Functions inherited from TSLab.Script.Optimization.OptimPropertyBase< TValue, TOptimData >
 OptimPropertyBase (TValue value)
 
 OptimPropertyBase (TValue value, bool isCalculable)
 
virtual void ValidateValue (TValue value)
 
abstract TValue InternalGetValue (long iteration)
 
override IOptimDataBase MakeData ()
 Make OptimData instance (to store) More...
 
override void UpdateFromData ()
 Update (restore) members from OptimData instance More...
 
override void UpdateData ()
 
void OnPropertyChanged ([CallerMemberName] string propertyName=null)
 
- Protected Member Functions inherited from TSLab.Script.Optimization.OptimBase
abstract long InternalCalculateIterations (CancellationToken cancellationToken)
 

Properties

TValue OptimMinValue [get]
 
TValue OptimMaxValue [get]
 
TValue OptimStep [get]
 
TValue ControlMinValue [get]
 
TValue ControlMaxValue [get]
 
TValue ControlStep [get]
 
bool IsUpdated [get, set]
 
- Properties inherited from TSLab.Script.Optimization.OptimPropertyBase< TValue, TOptimData >
bool IsCalculable [get, set]
 
TValue Value [get, set]
 
- Properties inherited from TSLab.Script.Optimization.OptimBase
string Name [get, protected set]
 The name of property
 
IOptimDataBase Data [get, set]
 Get / set optimization property data
 
- Properties inherited from TSLab.Script.Optimization.IOptimBase
string Name [get]
 The name of property
 
long Iterations [get]
 Property max iterations count
 
bool HasData [get]
 
IOptimDataBase Data [get, set]
 Get / set optimization property data
 

Additional Inherited Members

- Public Member Functions inherited from TSLab.Script.Optimization.OptimPropertyBase< TValue, TOptimData >
override object Clone ()
 
override string ToString ()
 
TValue GetValue (long iteration)
 
override void UpdateForIteration (long iteration)
 Calculate iteration properties values and updated objects properties current iteration value
 
- Public Member Functions inherited from TSLab.Script.Optimization.OptimBase
long CalculateIterations (CancellationToken cancellationToken)
 
IOptimDataBase GetUpdatedData ()
 
- Public Attributes inherited from TSLab.Script.Optimization.OptimBase
long Iterations => m_iterations ?? CalculateIterations(CancellationToken.None)
 Property max iterations count
 
bool HasData => m_data != null
 
- Protected Attributes inherited from TSLab.Script.Optimization.OptimBase
IOptimDataBase m_data
 
- Events inherited from TSLab.Script.Optimization.OptimPropertyBase< TValue, TOptimData >
PropertyChangedEventHandler PropertyChanged
 

Member Function Documentation

override IOptimDataBase TSLab.Script.Optimization.NumericOptimProperty< TValue, TOptimData >.MakeData ( )
protectedvirtual

Make OptimData instance (to store)

Returns

Implements TSLab.Script.Optimization.OptimBase.

override void TSLab.Script.Optimization.NumericOptimProperty< TValue, TOptimData >.UpdateFromData ( )
protectedvirtual

Update (restore) members from OptimData instance

Reimplemented from TSLab.Script.Optimization.OptimBase.