Click or drag to resize

CcsdsOrbitEphemerisMessageFile Class

Reads from and writes to Orbit Ephemeris Message (OEM) files determined by the specifications of The Consultative Committee for Space Data Systems (CCSDS). CCSDS OEM files can express position, velocity, acceleration, and covariance information.

The CCSDS specifications can be found on the CCSDS website. The two supported formats for OEM files are Key-value notation (KVN) and extensible markup language (XML). The official recommended standards for KVN OEM files can be found in "Orbit Data Messages", Document CCSDS 502.0-B-2 on the above website. The official recommended standards for XML OEM files can be found in "XML Specifications for Navigation Data Messages", Document CCSDS 505.0-B-2 on the website. Both documents also contain a few useful examples of correctly formatted OEM files for their respective formats.

Each OEM file can contain several segments of ephemeris data, so this class mostly serves as a container for CcsdsOrbitEphemerisMessageSegment objects and as an interface for reading and writing those objects. The actual ephemeris and covariance data is stored in the segments.

Inheritance Hierarchy
SystemObject
  System.Collections.ObjectModelCollectionCcsdsOrbitEphemerisMessageSegment
    AGI.Foundation.InfrastructureDefinitionalObjectCollectionCcsdsOrbitEphemerisMessageSegment
      AGI.Foundation.CcsdsCcsdsOrbitEphemerisMessageFile

Namespace:  AGI.Foundation.Ccsds
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
public class CcsdsOrbitEphemerisMessageFile : DefinitionalObjectCollection<CcsdsOrbitEphemerisMessageSegment>

The CcsdsOrbitEphemerisMessageFile type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyComments
Gets a collection containing comments from the header of a CCSDS OEM file.
Public propertyCount (Inherited from CollectionCcsdsOrbitEphemerisMessageSegment.)
Public propertyCreationDate
Gets or sets the file creation date and time in UTC.
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 DefinitionalObjectCollectionT.)
Public propertyItem
Gets or sets the element at the specified index.
(Inherited from CollectionCcsdsOrbitEphemerisMessageSegment.)
Protected propertyItems (Inherited from CollectionCcsdsOrbitEphemerisMessageSegment.)
Public propertyOriginator
Gets or sets the creating agency or operator. The country of origin should also be provided where the originator is not a national space agency.
Public propertyVersion
Gets or sets the ephemeris file version.
Top
Methods
  NameDescription
Public methodAdd (Inherited from CollectionCcsdsOrbitEphemerisMessageSegment.)
Public methodAddRange (Inherited from DefinitionalObjectCollectionT.)
Protected methodCheckForSameDefinition(CcsdsOrbitEphemerisMessageFile)
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(DefinitionalObjectCollectionCcsdsOrbitEphemerisMessageSegment)
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 DefinitionalObjectCollectionTCheckForSameDefinition(DefinitionalObjectCollectionT).)
Public methodClear (Inherited from CollectionCcsdsOrbitEphemerisMessageSegment.)
Protected methodClearItems (Inherited from DefinitionalObjectCollectionT.)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectCollectionTClone(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(DefinitionalObjectCollectionT) method.
(Overrides DefinitionalObjectCollectionTComputeCurrentDefinitionHashCode.)
Public methodContains (Inherited from CollectionCcsdsOrbitEphemerisMessageSegment.)
Public methodCopyTo (Inherited from CollectionCcsdsOrbitEphemerisMessageSegment.)
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.
(Inherited from DefinitionalObjectCollectionT.)
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 DefinitionalObjectCollectionT.)
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 DefinitionalObjectCollectionT.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObjectCollectionT.)
Public methodGetEnumerator (Inherited from CollectionCcsdsOrbitEphemerisMessageSegment.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf (Inherited from CollectionCcsdsOrbitEphemerisMessageSegment.)
Public methodInsert (Inherited from CollectionCcsdsOrbitEphemerisMessageSegment.)
Protected methodInsertItem (Inherited from DefinitionalObjectCollectionT.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObjectCollectionT.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberReadFrom(String)
Reads the CCSDS OEM file. If it can be parsed as a valid XML document, it will be. Otherwise, it will be parsed as a key-value notation (KVN) OEM file.
Public methodStatic memberReadFrom(TextReader)
Reads the CCSDS OEM file. If it has a valid XML header, it will be parsed as an XML OEM file. Otherwise, it will be parsed as a key-value notation (KVN) OEM file.
Public methodRemove (Inherited from CollectionCcsdsOrbitEphemerisMessageSegment.)
Public methodRemoveAt (Inherited from CollectionCcsdsOrbitEphemerisMessageSegment.)
Protected methodRemoveItem (Inherited from DefinitionalObjectCollectionT.)
Protected methodSetItem
Replaces the element at the specified index.
(Inherited from DefinitionalObjectCollectionT.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObjectCollectionT.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWriteTo(TextWriter)

Writes this instance to a TextWriter in the CCSDS orbit ephemeris message OEM format.

This overload uses the DefaultOptions of the CcsdsOemFileWritingOptions, which means that the CreationDate is overridden by the current date and time and that the OEM will be written in the Key-Value Notation (KVN) format.

The TextWriter can be a StreamWriter for writing to a file, a StringWriter for writing to a string, or any number of other types.

If acceleration information is contained in the EphemerisData of any of the segments contained by this instance, or if the CovarianceData of any of the segments is not empty, then the Version needs to be set to 2.0 or this method will throw.

Public methodWriteTo(TextWriter, CcsdsOemFileWritingOptions)

Writes this instance to a TextWriter in the CCSDS orbit ephemeris message OEM format.

The TextWriter can be a StreamWriter for writing to a file, a StringWriter for writing to a string, or any number of other types.

If acceleration information is contained in the EphemerisData of any of the segments contained by this instance, or if the CovarianceData of any of the segments is not empty, then the Version needs to be set to 2.0 or this method will throw.

Top
See Also