UpdateSegment Methods |
The UpdateSegment type exposes the following members.
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 SegmentDefinition.) | |
CheckForSameDefinition(SegmentDefinition) |
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 SegmentDefinitionCheckForSameDefinition(SegmentDefinition).) | |
CheckForSameDefinition(UpdateSegment) |
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).
| |
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 SegmentDefinitionComputeCurrentDefinitionHashCode.) | |
ContainsElement |
Checks to see if there is a StateElementAdapterDefinition for the provided
element.
(Inherited from SegmentDefinition.) | |
CreateSegmentPropagator |
Creates, configures, and returns the SegmentPropagator for this
segment. This method should check that all of the required properties on the
concrete instance are configured properly before constructing the
SegmentPropagator to be returned.
(Overrides SegmentDefinitionCreateSegmentPropagator(EvaluatorGroup, SegmentDefinition).) | |
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.) | |
GetDefinedIn |
Gets the object (for example, a ReferenceFrame, an Axes, etc.)
in which the specified element is defined in. This can return if there
is no such object. When overriding this method, you generally should not call the base method,
instead the derived segment should keep track of the elements and defined in objects itself.
(Inherited from SegmentDefinition.) | |
GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) | |
GetElementAdapter |
Returns the adapter for the given state element. The
StateElementAdapters handle the various
transformations of the propagated elements between segments (for example, if
the integration frame of a point being propagated changes
from one segment to another, the
adapter is what handles that transformation between
segment). All elements propagated by this segment must have
an adapter returned by this method (even if that adapter
simply returns the original state).
If multiple segments are being propagated by this segment (as a SegmentList would), this
must return the adapter of the StateElementAdapter of the element for the final
known segment getting propagated.
(Overrides SegmentDefinitionGetElementAdapter(String).) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetSegmentPropagator |
Creates, configures, and returns the SegmentPropagator for this
segment. This method assumes that no previous segment is needed to configure
this segment's propagator.
(Inherited from SegmentDefinition.) | |
GetSegmentPropagator(EvaluatorGroup) |
Creates, configures, and returns the SegmentPropagator for this
segment. This method assumes that no previous segment is needed to configure
this segment's propagator.
(Inherited from SegmentDefinition.) | |
GetSegmentPropagator(SegmentDefinition) |
Creates, configures, and returns the SegmentPropagator for this
segment.
(Inherited from SegmentDefinition.) | |
GetSegmentPropagator(EvaluatorGroup, SegmentDefinition) |
Creates, configures, and returns the SegmentPropagator for this
segment.
(Inherited from SegmentDefinition.) | |
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.) | |
RemoveElement |
Removes the StateElementAdapterDefinition for the specified element.
(Inherited from SegmentDefinition.) | |
SetElementAndAdapter | Add or sets an adapter for an element in this segment. Note that many types of derived segments will automatically handle their adapters by interrogating properties specific to the derived segment. Also some segments whose PassAllElementsToNextSegment property is do not require adapters or elements to be set. These adapters have the responsibility of processing the initial state that the propagator will start propagating from. They will modify the initial state passed to this segment so that the state is in a form that the propagator can process. | |
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 SegmentDefinition.) |