Click or drag to resize

DelegateBasedVariableT Class

A SegmentPropagatorVariable that uses a delegate to get and set the relevant values in a segment's configuration.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.NumericalMethodsSegmentPropagatorVariable
      AGI.Foundation.NumericalMethodsDelegateBasedVariableT

Namespace:  AGI.Foundation.NumericalMethods
Assembly:  AGI.Foundation.SegmentPropagation (in AGI.Foundation.SegmentPropagation.dll) Version: 20.2.404.0 (20.2.404.0)
Syntax
public class DelegateBasedVariable<T> : SegmentPropagatorVariable
where T : SegmentConfiguration

Type Parameters

T
The segment configuration that matches the SegmentDefinition being propagated.

The DelegateBasedVariableT type exposes the following members.

Constructors
  NameDescription
Public methodDelegateBasedVariableT
Initializes a new instance. The MaximumStep, PerturbationValue and Setter all must be set before GetEvaluator(EvaluatorGroup) can be successfully called.
Protected methodDelegateBasedVariableT(DelegateBasedVariableT, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodDelegateBasedVariableT(Double, Double, SegmentDefinition, SetVariableCallbackT)
Initializes a new instance.
Public methodDelegateBasedVariableT(Double, Double, SegmentDefinition, SetVariableCallbackT, SolverVariableScaling)
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyMaximumStep Obsolete.
Gets or sets the maximum step that the solver may take in a single iteration.
(Inherited from SegmentPropagatorVariable.)
Public propertyName
Gets or sets an optional name for this variable.
(Inherited from SegmentPropagatorVariable.)
Public propertyPerturbationValue
Gets or sets the perturbation value to use when computing a numerical derivative relative to this variable of a SolvableMultivariableFunction that uses SegmentPropagators.
(Inherited from SegmentPropagatorVariable.)
Public propertyScaling Obsolete.
Gets or sets the Scaling of the variable. By default this is NoScalingOnVariable. It is important to note that the actual scale factor is only available through the evaluator.
(Inherited from SegmentPropagatorVariable.)
Public propertySegment
Gets or sets the segment that this variable will act on.
(Inherited from SegmentPropagatorVariable.)
Public propertySetter
Gets or sets the delegate that will alter the relevant value in the segment's configuration.
Public propertySettings
Gets or sets the settings for the MultivariableFunctionSolver associated with this variable.
(Inherited from SegmentPropagatorVariable.)
Public propertyVariableTolerance Obsolete.
Gets or sets the variable tolerance. If all the variables are asked to change by less than their variable tolerance, then the solver running a function with this variable will not converge.
(Inherited from SegmentPropagatorVariable.)
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from SegmentPropagatorVariable.)
Protected methodCheckForSameDefinition(DelegateBasedVariableT)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Protected methodCheckForSameDefinition(SegmentPropagatorVariable)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides SegmentPropagatorVariableCheckForSameDefinition(SegmentPropagatorVariable).)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.
(Overrides SegmentPropagatorVariableComputeCurrentDefinitionHashCode.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
(Overrides SegmentPropagatorVariableEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from SegmentPropagatorVariable.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEvaluator
Gets a SegmentPropagatorVariableEvaluator for this variable.
(Overrides SegmentPropagatorVariableGetEvaluator(EvaluatorGroup).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateProperties
Validates that required properties are configured correctly in order to get an evaluator for this instance. Derived classes should call this method when implementing GetEvaluator(EvaluatorGroup), as well as validate their own properties.
(Inherited from SegmentPropagatorVariable.)
Top
See Also