Click or drag to resize

SegmentListResults Methods

The SegmentListResults type exposes the following members.

Methods
  NameDescription
Public methodAddEphemerisPoint
Adds the state to the EntireComputedEphemeris and EphemerisForOverallTrajectory and checks that all of the elements in the state are included in the Identifiers. This will add the state such that all of the states are in time ascending order.
(Inherited from SegmentResults.)
Public methodClone
Clones this object using the specified context.
(Overrides SegmentResultsClone(CopyContext).)
Public methodCropEphemerisForOverallTrajectory
This method will clear the EphemerisForOverallTrajectory and fill it in with the ephemeris from the EntireComputedEphemeris that is in the interval. SegmentPropagators that propagate multiple segments may need to override this to properly crop its child segments (and it is likely that some segments will have an empty EphemerisForOverallTrajectory). This should not need to perform any adaptation of the states involved; simply adjust the states in the EphemerisForOverallTrajectory. For SegmentResults that are made up of multiple segments, this must be called on each individual segment before being called on the overall results.
(Overrides SegmentResultsCropEphemerisForOverallTrajectory(IntegrationSense, TimeInterval).)
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 methodStatic memberGenerateOverallTrajectory
Clears the current ephemeris for this results and regenerates it based on the overall ephemeris of all of this result's child segments. This should be called right before this is returned to the parent segment or user, or when a segment had to change the results of previous segment's EphemerisForOverallTrajectory. This method will properly adapt all of the child SegmentResults to the proper defined in objects of the SegmentListPropagator that made these results.
Public methodGetAdapter
Gets the adapter for the specified element.
(Inherited from SegmentResults.)
Public methodGetDateMotionCollectionOfOverallTrajectory(String, ReferenceFrame)
Gets a DateMotionCollectionT of the element in the specified ReferenceFrame from the EphemerisForOverallTrajectory. This method assumes that you are asking for an entry that is of type Cartesian and that the element in the state is of that type. The state type stored must be ITimeBasedState.
(Overrides SegmentResultsGetDateMotionCollectionOfOverallTrajectory(String, ReferenceFrame).)
Public methodGetDateMotionCollectionOfOverallTrajectoryT(String)
Gets a DateMotionCollectionT of the element from the EphemerisForOverallTrajectory. Note that this will return the ephemeris from the EphemerisForOverallTrajectory of every stored SegmentResults making no attempt at transforming them into the same ReferenceFrame or Axes. If the element happened to be propagated in different defined in objects, you must either call GetDateMotionCollectionOfOverallTrajectory(String, ReferenceFrame) if a Point was propagated, or handle the transformations yourself.
(Overrides SegmentResultsGetDateMotionCollectionOfOverallTrajectoryT(String).)
Public methodGetElementDefinedIn
Gets the Object that the element was defined in. Generally this is an Axes or ReferenceFrame. If this returns then either the element has no defined-in object, or the element was not propagated by the segment that made the results.
(Overrides SegmentResultsGetElementDefinedIn(String).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetMotionCollectionT(String) (Inherited from SegmentResults.)
Public methodGetResultsOfSegment
This method will do a recursive search through the SegmentResults and return the first results that correspond with the segment, or if the requested segment's results are not found.
(Inherited from SegmentResults.)
Public methodGetSegmentBoundaryTimes
Returns the intervals of propagation of each segment. Segments that are instantaneous will have their start and stop times be equal to each other.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOfStateWithDateFromEntireComputedEphemeris
Gets the indexes of states within EntireComputedEphemeris at the specified date.
(Inherited from SegmentResults.)
Public methodIsSegmentContainedInThisList
Returns if the segment was propagated by the SegmentPropagator that produced this list of SegmentResults. Be aware that it will return once it finds the first SegmentPropagator made with the matching segment.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPropagateToAssumingTimeBasedStates
When a SegmentPropagator needs to go back and start at a point before the end of the previous segment, this method can be used to get that exact state to start at. This will adapt the state such that it is in the defined-ins of the segment right before the current segment. This method will take care of setting all of the nested segments overall ephemeris lists properly.
Public methodRegenerateEphemerisForOverallTrajectory
Regenerates the ephemeris for this. The EphemerisForOverallTrajectory will get rebuilt for this and all child segments. The states in this SegmentList will be adapted to the final stored segment in this.
Public methodSetElementDefinedIn
Sets the defined-in object (ReferenceFrame, Axes...), for the specified element.
(Inherited from SegmentResults.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also