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

System.Object
  System.Collections.ObjectModel.Collection<CcsdsOrbitEphemerisMessageSegment>
    AGI.Foundation.Infrastructure.DefinitionalObjectCollection<CcsdsOrbitEphemerisMessageSegment>
      AGI.Foundation.Ccsds.CcsdsOrbitEphemerisMessageFile

Namespace: AGI.Foundation.Ccsds
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 25.1.421.0 (25.1.421.0)

Syntax

C++

Copy

public class CcsdsOrbitEphemerisMessageFile : DefinitionalObjectCollection<CcsdsOrbitEphemerisMessageSegment>

Public Class CcsdsOrbitEphemerisMessageFile
	Inherits DefinitionalObjectCollection(Of CcsdsOrbitEphemerisMessageSegment)

public ref class CcsdsOrbitEphemerisMessageFile : public DefinitionalObjectCollection<CcsdsOrbitEphemerisMessageSegment^>

type CcsdsOrbitEphemerisMessageFile =  
    class
        inherit DefinitionalObjectCollection<CcsdsOrbitEphemerisMessageSegment>
    end

The CcsdsOrbitEphemerisMessageFile type exposes the following members.

Constructors

	Name	Description
	CcsdsOrbitEphemerisMessageFile()	Initializes a new instance.
	CcsdsOrbitEphemerisMessageFile(CcsdsOrbitEphemerisMessageFile, CopyContext)	Initializes a new instance as a copy of an existing instance.

Top

Properties

	Name	Description
	Comments	Gets a collection containing comments from the header of a CCSDS OEM file.
	Count	Gets the number of elements actually contained in the Collection<T>. (Inherited from Collection<CcsdsOrbitEphemerisMessageSegment>.)
	CreationDate	Gets or sets the file creation date and time in UTC.
	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 DefinitionalObjectCollection<T>.)
	Item	Gets or sets the element at the specified index. (Inherited from Collection<CcsdsOrbitEphemerisMessageSegment>.)
	Items	Gets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<CcsdsOrbitEphemerisMessageSegment>.)
	Originator	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.
	Version	Gets or sets the ephemeris file version.

Top

Methods

	Name	Description
	Add	Adds an object to the end of the Collection<T>. (Inherited from Collection<CcsdsOrbitEphemerisMessageSegment>.)
	AddRange	Adds the elements of the specified collection to the end of the DefinitionalObjectCollection<T>. (Inherited from DefinitionalObjectCollection<T>.)
	CheckForSameDefinition(CcsdsOrbitEphemerisMessageFile)	Checks to determine if another instance has the same definition as this instance and returns true 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 false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
	CheckForSameDefinition(DefinitionalObjectCollection<CcsdsOrbitEphemerisMessageSegment>)	Checks to determine if another instance has the same definition as this instance and returns true 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 false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object). (Overrides DefinitionalObjectCollection<T>.CheckForSameDefinition(DefinitionalObjectCollection<T>).)
	Clear	Removes all elements from the Collection<T>. (Inherited from Collection<CcsdsOrbitEphemerisMessageSegment>.)
	ClearItems	Removes all elements from the DefinitionalObjectCollection<T> (Inherited from DefinitionalObjectCollection<T>.)
	Clone	Clones this object using the specified context. (Overrides DefinitionalObjectCollection<T>.Clone(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(DefinitionalObjectCollection<T> ) method. (Overrides DefinitionalObjectCollection<T>.ComputeCurrentDefinitionHashCode().)
	Contains	Determines whether an element is in the Collection<T>. (Inherited from Collection<CcsdsOrbitEphemerisMessageSegment>.)
	CopyTo	Copies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<CcsdsOrbitEphemerisMessageSegment>.)
	EnumerateDependencies	Enumerates the dependencies of this object by calling Enumerate<T> (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 DefinitionalObjectCollection<T>.)
	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 DefinitionalObjectCollection<T>.)
	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 DefinitionalObjectCollection<T>.)
	GetDefinitionHashCode	Gets a hash code representing the definition of this object. (Inherited from DefinitionalObjectCollection<T>.)
	GetEnumerator	Returns an enumerator that iterates through the Collection<T>. (Inherited from Collection<CcsdsOrbitEphemerisMessageSegment>.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Searches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<CcsdsOrbitEphemerisMessageSegment>.)
	Insert	Inserts an element into the Collection<T> at the specified index. (Inherited from Collection<CcsdsOrbitEphemerisMessageSegment>.)
	InsertItem	Inserts an element into the DefinitionalObjectCollection<T> at the specified index. (Inherited from DefinitionalObjectCollection<T>.)
	IsSameDefinition	Determines if this object has the same definition as another object. (Inherited from DefinitionalObjectCollection<T>.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReadFrom(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.
	ReadFrom(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.
	Remove	Removes the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<CcsdsOrbitEphemerisMessageSegment>.)
	RemoveAt	Removes the element at the specified index of the Collection<T>. (Inherited from Collection<CcsdsOrbitEphemerisMessageSegment>.)
	RemoveItem	Removes the element at the specified index of the DefinitionalObjectCollection<T>. (Inherited from DefinitionalObjectCollection<T>.)
	SetItem	Replaces the element at the specified index. (Inherited from DefinitionalObjectCollection<T>.)
	ThrowIfFrozen	Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object. (Inherited from DefinitionalObjectCollection<T>.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WriteTo(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.
	WriteTo(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

Reference

AGI.Foundation.Ccsds Namespace