AuxiliaryStateVector Class |
Namespace: AGI.Foundation.Propagators
The AuxiliaryStateVector type exposes the following members.
Name | Description | |
---|---|---|
AuxiliaryStateVector | Initializes a new instance. | |
AuxiliaryStateVector(Vector) |
Initializes a new instance based on the given Vector.
| |
AuxiliaryStateVector(AuxiliaryStateVector, CopyContext) | Initializes a new instance as a copy of an existing instance. |
Name | Description | |
---|---|---|
AuxiliaryVector |
Gets or sets the vector to include as an auxiliary state in the propagation output.
| |
DefinedInAxes |
Gets or sets the Axes that this vector is defined in. If this is null then the
AuxiliaryStateVector will retain the same Axes as that of the AuxiliaryVector property.
| |
Dimension |
Gets the dimension, which is three for a Vector (Overrides AuxiliaryStateElementDimension.) | |
Identification |
Gets or sets the string identifying this instance in the overall output.
(Inherited from AuxiliaryStateElement.) | |
IsFrozen |
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.) | |
Order |
Gets or sets the highest order of the Vector to produce for the output.
Zero will produce the vector's value, one will produce its value and its first derivative,
and higher orders will produce vectors up to and including the given order.
(Overrides AuxiliaryStateElementOrder.) |
Name | Description | |
---|---|---|
CheckForSameDefinition(AuxiliaryStateElement) |
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 AuxiliaryStateElementCheckForSameDefinition(AuxiliaryStateElement).) | |
CheckForSameDefinition(AuxiliaryStateVector) |
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).
| |
CheckForSameDefinition(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 AuxiliaryStateElement.) | |
Clone |
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).) | |
ComputeCurrentDefinitionHashCode |
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 AuxiliaryStateElementComputeCurrentDefinitionHashCode.) | |
EnumerateDependencies |
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 DefinitionalObjectEnumerateDependencies(DependencyEnumerator).) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
Freeze |
Freezes this object. Further attempts to modify it will result
in an ObjectFrozenException.
(Inherited from DefinitionalObject.) | |
FreezeAggregatedObjects |
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 DefinitionalObject.) | |
GetConverter |
Gets an instance of an output type which can convert the output of propagation
back into the native type of this auxiliary state element.
(Overrides AuxiliaryStateElementGetConverter(Int32).) | |
GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) | |
GetEvaluator |
Gets an evaluator which can compute the auxiliary variables based on the current time and any
"integrated" definitional objects taken from PropagationStateElements
which are updated during integration.
(Overrides AuxiliaryStateElementGetEvaluator(EvaluatorGroup, Int32).) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IsSameDefinition |
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ThrowIfFrozen |
Throws ObjectFrozenException if this object IsFrozen.
This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |