DEIMOS
Earth Observation Software
Orbit and Attitude Adapater Tool
ESA
EoOrbAttAdapter Class Reference

Interface used to parser the user files to CFI orbit/attitude files. More...

#include <EoOrbAttAdapter.h>

Public Member Functions

 EoOrbAttAdapter ()
 Empty class Constructor.
 
 ~EoOrbAttAdapter ()
 Class Destructor.
 
long getNofItems ()
 Get Number of items to be parsed.
 
long getNofProcessedItems ()
 Get Number of processed items.
 
string getVersion ()
 Get tool version.
 
void setMainConfiguration (string configurationFile) throw (EoAdapterError)
 Set the configuration with the input file name.
 
void setMainConfiguration (const AdpMainConfiguration &inputConfig) throw (EoAdapterError)
 Set the configuration with the input data object.
 
AdpMainConfiguration getMainConfiguration () throw (EoAdapterError)
 Get the configuration with the input file name.
 
void enableOrbitParser () throw (EoAdapterError)
 Enable the orbit parser.
 
void disableOrbitParser () throw (EoAdapterError)
 Disable the orbit parser.
 
void enableAttitudeParser () throw (EoAdapterError)
 Enable the orbit parser.
 
void disableAttitudeParser () throw (EoAdapterError)
 Disable the orbit parser.
 
void setParser (AdpDefaultParser *inputParser)
 Set the parser to be used by the method "parse" in next calls.
 
void parse (const string dataFile) throw (EoAdapterError)
 Execute the parser for the input data file.
 
void parse (const void *data) throw (EoAdapterError)
 Execute the parser for the input data (generic pointer).
 
void parse () throw (EoAdapterError)
 Execute the parser for the data file set in configuration.
 
void clearOrbitData ()
 Clear internal orbit data.
 
void clearAttitudeData ()
 Delete internal attitude data.
 
string writeOrbitDataToFile () throw (EoAdapterError)
 Write OSVs to Orbit File (filename will be taken from Main Configuration File)
 
string writeOrbitDataToFile (const string OutputOrbitFile) throw (EoAdapterError)
 Write OSVs to Orbit File.
 
void getOrbitData (OrbitFile &orbitFileData) throw (EoAdapterError)
 Get Orbit data file.
 
string writeAttitudeDataToFile () throw (EoAdapterError)
 Write attitude data to attitude File (filename will be taken from Main Configuration File)
 
string writeAttitudeDataToFile (const string OutputAttFile) throw (EoAdapterError)
 Write attitude data to attitude File.
 
void getAttitudeData (AttFile &attitudeFileData) throw (EoAdapterError)
 Get Attitude data file.
 
void printValidationReport (const string &reportFile) throw (EoAdapterError)
 Print the validation report to the log.
 

Detailed Description

Interface used to parser the user files to CFI orbit/attitude files.

Constructor & Destructor Documentation

◆ EoOrbAttAdapter()

EoOrbAttAdapter::EoOrbAttAdapter ( )

Empty class Constructor.

◆ ~EoOrbAttAdapter()

EoOrbAttAdapter::~EoOrbAttAdapter ( )

Class Destructor.

Member Function Documentation

◆ clearAttitudeData()

void EoOrbAttAdapter::clearAttitudeData ( )

Delete internal attitude data.

Every time that a file is parsed, the new data is added to the previous parsed files. when calling this method, the stored attitude data is cleaned.

References clearAttitudeData().

Referenced by clearAttitudeData().

◆ clearOrbitData()

void EoOrbAttAdapter::clearOrbitData ( )

Clear internal orbit data.

Every time that a file is parsed, the new data is added to the previous parsed files. when calling this method, the stored orbit data is cleaned.

References clearOrbitData().

Referenced by clearOrbitData().

◆ disableAttitudeParser()

void EoOrbAttAdapter::disableAttitudeParser ( )
throw (EoAdapterError )

Disable the orbit parser.

Exceptions
EoAdapterErrorif configuration was not set. The method "setMainConfiguration" should be called before

References disableAttitudeParser().

Referenced by disableAttitudeParser().

◆ disableOrbitParser()

void EoOrbAttAdapter::disableOrbitParser ( )
throw (EoAdapterError )

Disable the orbit parser.

Exceptions
EoAdapterErrorif configuration was not set. The method "setMainConfiguration" should be called before

References disableOrbitParser().

Referenced by disableOrbitParser().

◆ enableAttitudeParser()

void EoOrbAttAdapter::enableAttitudeParser ( )
throw (EoAdapterError )

Enable the orbit parser.

Exceptions
EoAdapterErrorif configuration was not set. The method "setMainConfiguration" should be called before

References enableAttitudeParser().

Referenced by enableAttitudeParser().

◆ enableOrbitParser()

void EoOrbAttAdapter::enableOrbitParser ( )
throw (EoAdapterError )

Enable the orbit parser.

Exceptions
EoAdapterErrorif configuration was not set. The method "setMainConfiguration" should be called before

References enableOrbitParser().

Referenced by enableOrbitParser().

◆ getAttitudeData()

void EoOrbAttAdapter::getAttitudeData ( AttFile & attitudeFileData)
throw (EoAdapterError )

Get Attitude data file.

Returns
EOCFI object with the attitude file data

References getAttitudeData().

Referenced by getAttitudeData().

◆ getMainConfiguration()

AdpMainConfiguration EoOrbAttAdapter::getMainConfiguration ( )
throw (EoAdapterError )

Get the configuration with the input file name.

Returns
output configuration data
Exceptions
EoAdapterErrorif configuration was not set. The method "setMainConfiguration" should be called before

◆ getNofItems()

long EoOrbAttAdapter::getNofItems ( )
inline

Get Number of items to be parsed.

◆ getNofProcessedItems()

long EoOrbAttAdapter::getNofProcessedItems ( )
inline

Get Number of processed items.

◆ getOrbitData()

void EoOrbAttAdapter::getOrbitData ( OrbitFile & orbitFileData)
throw (EoAdapterError )

Get Orbit data file.

Returns
EOCFI object with the orbit file data

References getOrbitData().

Referenced by getOrbitData().

◆ getVersion()

string EoOrbAttAdapter::getVersion ( )
inline

Get tool version.

Returns
Adapter tool version

◆ parse() [1/3]

void EoOrbAttAdapter::parse ( )
throw (EoAdapterError )

Execute the parser for the data file set in configuration.

The parsed data will be stored internally as CFI data (OrbitFile/AttFile). Note that Orbit/Attitude data will be parsed if the parser is enabled.

Exceptions
EoAdapterErrorif the data file could not be parsed

References parse().

◆ parse() [2/3]

void EoOrbAttAdapter::parse ( const string dataFile)
throw (EoAdapterError )

Execute the parser for the input data file.

The parsed data will be stored internally as CFI data (OrbitFile/AttFile). Note that Orbit/Attitude data will be parsed if the parser is enabled.

Parameters
dataFileinput data file to parser.
Exceptions
EoAdapterErrorif the data file could not be parsed

References parse().

Referenced by parse(), parse(), parse(), and printValidationReport().

◆ parse() [3/3]

void EoOrbAttAdapter::parse ( const void * data)
throw (EoAdapterError )

Execute the parser for the input data (generic pointer).

The parsed data will be stored internally as CFI data (OrbitFile/AttFile). Note that Orbit/Attitude data will be parsed if the parser is enabled.

Parameters
datainput data to parser.
Exceptions
EoAdapterErrorif the data file could not be parsed

References parse().

◆ printValidationReport()

void EoOrbAttAdapter::printValidationReport ( const string & reportFile)
throw (EoAdapterError )

Print the validation report to the log.

References parse(), and printValidationReport().

Referenced by printValidationReport().

◆ setMainConfiguration() [1/2]

void EoOrbAttAdapter::setMainConfiguration ( const AdpMainConfiguration & inputConfig)
throw (EoAdapterError )

Set the configuration with the input data object.

Parameters
inputConfigconfiguration data
Exceptions
EoAdapterErrorif configuration was already set

◆ setMainConfiguration() [2/2]

void EoOrbAttAdapter::setMainConfiguration ( string configurationFile)
throw (EoAdapterError )

Set the configuration with the input file name.

Parameters
configurationFileconfiguration file (path+name)
Exceptions
EoAdapterErrorif configuration was already set

◆ setParser()

void EoOrbAttAdapter::setParser ( AdpDefaultParser * inputParser)

Set the parser to be used by the method "parse" in next calls.

Parameters
inputParserparser to be used by the adapter

References setParser().

Referenced by setParser().

◆ writeAttitudeDataToFile() [1/2]

string EoOrbAttAdapter::writeAttitudeDataToFile ( )
throw (EoAdapterError )

Write attitude data to attitude File (filename will be taken from Main Configuration File)

Exceptions
EoAdapterErrorif file could not be written

References writeAttitudeDataToFile().

Referenced by writeAttitudeDataToFile(), and writeAttitudeDataToFile().

◆ writeAttitudeDataToFile() [2/2]

string EoOrbAttAdapter::writeAttitudeDataToFile ( const string OutputAttFile)
throw (EoAdapterError )

Write attitude data to attitude File.

Parameters
OutputAttFilefilename for the output file
Exceptions
EoAdapterErrorif file could not be written

References writeAttitudeDataToFile().

◆ writeOrbitDataToFile() [1/2]

string EoOrbAttAdapter::writeOrbitDataToFile ( )
throw (EoAdapterError )

Write OSVs to Orbit File (filename will be taken from Main Configuration File)

Exceptions
EoAdapterErrorif file could not be written

References writeOrbitDataToFile().

Referenced by writeOrbitDataToFile(), and writeOrbitDataToFile().

◆ writeOrbitDataToFile() [2/2]

string EoOrbAttAdapter::writeOrbitDataToFile ( const string OutputOrbitFile)
throw (EoAdapterError )

Write OSVs to Orbit File.

Parameters
OutputOrbitFilefilename for the output file
Exceptions
EoAdapterErrorif file could not be written

References writeOrbitDataToFile().


Generated on Tue Apr 15 2025 16:23:51 for My Project by doxygen 1.13.2