StoppableNumericalPropagator Class |
Namespace: AGI.Foundation.Propagators
The StoppableNumericalPropagator type exposes the following members.
Name | Description | |
---|---|---|
StoppableNumericalPropagator | Initializes a new instance. | |
StoppableNumericalPropagator(NumericalPropagatorDefinition) |
Initializes a new instance.
| |
StoppableNumericalPropagator(StoppableNumericalPropagator, CopyContext) | Initializes a new instance as a copy of an existing instance. |
Name | Description | |
---|---|---|
Direction |
Gets a value that will, at run time, report the current direction of propagation of the StoppablePropagator.
(Inherited from StoppablePropagatorDefinition.) | |
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.) | |
PropagatorDefinition |
Gets or sets the NumericalPropagatorDefinition that this
StoppablePropagator will propagate.
| |
StoppingConditions |
Gets the list of StoppingConditions that will
find events and dictate when propagation should end.
(Inherited from StoppablePropagatorDefinition.) | |
TimeTolerance |
Gets or sets the tolerance in seconds that the StoppablePropagator will use to
say that a StoppingCondition converged on time. When the propagator
is trying to find the exact event, if the time between dates is equal to or less than this span,
it will say that the StoppingCondition has converged even if the
FunctionTolerance has not been satisfied. This value is optional,
with a default of Zero. The value must be positive. If the value is
specified, then stopping conditions can converge to events if
either the function tolerance or this time tolerance is satisfied.
(Inherited from StoppablePropagatorDefinition.) |
Name | Description | |
---|---|---|
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 StoppablePropagatorDefinition.) | |
CheckForSameDefinition(StoppableNumericalPropagator) |
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(StoppablePropagatorDefinition) |
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 StoppablePropagatorDefinitionCheckForSameDefinition(StoppablePropagatorDefinition).) | |
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 StoppablePropagatorDefinitionComputeCurrentDefinitionHashCode.) | |
ContainsAdapter |
Checks if there is a StateElementAdapter stored in this definition for elementIdentification.
(Inherited from StoppablePropagatorDefinition.) | |
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 StoppablePropagatorDefinitionEnumerateDependencies(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.
(Overrides StoppablePropagatorDefinitionFreezeAggregatedObjects.) | |
GetAdapter |
Gets the StateElementAdapter stored in this definition for elementIdentification.
(Inherited from StoppablePropagatorDefinition.) | |
GetAllAdapters |
Gets all of the StateElementAdapters that have
been registered with this propagator.
(Inherited from StoppablePropagatorDefinition.) | |
GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetStoppablePropagator |
Creates and initialize the actual StoppablePropagator.
It is assume that the Adapters
are either not needed or are fully configured with any current and previous
objects set.
(Inherited from StoppablePropagatorDefinition.) | |
GetStoppablePropagator(EvaluatorGroup) |
Creates and initialize the actual StoppablePropagator.
It is assume that the Adapters
are either not needed or are fully configured with any current and previous
objects set.
(Inherited from StoppablePropagatorDefinition.) | |
GetStoppablePropagator(EvaluatorGroup, IListStateElementAdapterDefinition) |
Creates and initialize the actual StoppablePropagator.
(Overrides StoppablePropagatorDefinitionGetStoppablePropagator(EvaluatorGroup, IListStateElementAdapterDefinition).) | |
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.) | |
OnAnyConditionSatisfied |
Called when any of the StoppingConditions are satisfied.
(Inherited from StoppablePropagatorDefinition.) | |
RemoveAdapter |
Removes the StateElementAdapter stored in this definition for elementIdentification.
(Inherited from StoppablePropagatorDefinition.) | |
SetAdapter |
Adds a StateElementAdapter to this propagator.
(Inherited from StoppablePropagatorDefinition.) | |
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.) |
Name | Description | |
---|---|---|
AnyConditionSatisfied |
Raised when any of the StoppingConditions are satisfied.
(Inherited from StoppablePropagatorDefinition.) |