EoOrbAttAdapter.EoOrbAttAdapter Class Reference

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

Public Member Functions
	EoOrbAttAdapter ()
	Empty class Constructor.
long	getNofItems ()
	Get Number of items to be parsed.
long	getNofProcessedItems ()
	Get Number of processed items.
String	getVersion ()
	Get tool version.
void	printValidationReport () throws EoAdapterError
	Print the validation report.
Logger	initLogger ()
	Sent the log message to the console By default the messages about the parsing progress are not shown.
Logger	initLogger (String logFile) throws EoAdapterError
	Set the log file.
void	setMainConfiguration (String configurationFile) throws EoAdapterError
	Set the configuration with the input file name.
void	setMainConfiguration (final AdpMainConfiguration inputConfig) throws EoAdapterError
	Set the configuration with the input data object.
AdpMainConfiguration	getMainConfiguration () throws EoAdapterError
	Get the configuration with the input file name.
void	enableOrbitParser () throws EoAdapterError
	Enable the orbit parser.
void	disableOrbitParser () throws EoAdapterError
	Disable the orbit parser.
void	enableAttitudeParser () throws EoAdapterError
	Enable the orbit parser.
void	disableAttitudeParser () throws EoAdapterError
	Disable the orbit parser.
void	setParser (final AdpDefaultParser inputParser)
	Set the parser to be used by the method "parse" in next calls.
void	parse (final String dataFile) throws EoAdapterError
	Execute the parser for the input data file.
void	parse (final byte[] dataArr) throws EoAdapterError
	Execute the parser for the input byte array data.
void	parse () throws EoAdapterError
	Execute the parser for the data file set in configuration.
void	addParsedVectors () throws EoAdapterError
	Move the parsed orbit/attitude data to the EOCFI data structures OrbitFile/AttFile suitable for the file writing.
void	validationChecks () throws EoAdapterError
	Check inconsistencies in the parsed orbit and attitude data.
void	clearOrbitData ()
	Clear internal orbit data.
void	clearAttitudeData ()
	Delete internal attitude data.
String	writeOrbitDataToFile () throws EoAdapterError
	Write OSVs to Orbit File (filename will be taken from Main Configuration File)
String	writeOrbitDataToFile (final String OutputOrbitFile) throws EoAdapterError
	Write OSVs to Orbit File.
OrbitFile	getOrbitData () throws EoAdapterError
	Get Orbit data file.
String	writeAttitudeDataToFile () throws EoAdapterError
	Write attitude data to attitude File (filename will be taken from Main Configuration File)
String	writeAttitudeDataToFile (final String OutputAttFile) throws EoAdapterError
	Write attitude data to attitude File.
AttFile	getAttitudeData () throws EoAdapterError
	Get Attitude data file.

Detailed Description

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

Constructor & Destructor Documentation

EoOrbAttAdapter()

EoOrbAttAdapter.EoOrbAttAdapter.EoOrbAttAdapter

(

)

Empty class Constructor.

Member Function Documentation

addParsedVectors()

void EoOrbAttAdapter.EoOrbAttAdapter.addParsedVectors

(

)

throws EoAdapterError

Move the parsed orbit/attitude data to the EOCFI data structures OrbitFile/AttFile suitable for the file writing.

Exceptions

EoAdapterError

if data is not correct (errors from CFI reference conversions)

References EoOrbAttAdapter.AdpOutputConfiguration.attitudeOutputConfig, EoOrbAttAdapter.AdpOutputConfiguration.orbitOutputConfig, EoOrbAttAdapter.AdpAttitudeOutputConfiguration.refFrame, EoOrbAttAdapter.AdpOrbitOutputConfiguration.refFrame, EoOrbAttAdapter.AdpAttitudeOutputConfiguration.timeRef, and EoOrbAttAdapter.AdpOrbitOutputConfiguration.timeRef.

clearAttitudeData()

void EoOrbAttAdapter.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.

clearOrbitData()

void EoOrbAttAdapter.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.

disableAttitudeParser()

void EoOrbAttAdapter.EoOrbAttAdapter.disableAttitudeParser

(

)

throws EoAdapterError

Disable the orbit parser.

Exceptions

EoAdapterError

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

References EoOrbAttAdapter.EoAdapterError.addError().

disableOrbitParser()

void EoOrbAttAdapter.EoOrbAttAdapter.disableOrbitParser

(

)

throws EoAdapterError

Disable the orbit parser.

Exceptions

EoAdapterError

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

References EoOrbAttAdapter.EoAdapterError.addError().

enableAttitudeParser()

void EoOrbAttAdapter.EoOrbAttAdapter.enableAttitudeParser

(

)

throws EoAdapterError

Enable the orbit parser.

Exceptions

EoAdapterError

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

References EoOrbAttAdapter.EoAdapterError.addError().

enableOrbitParser()

void EoOrbAttAdapter.EoOrbAttAdapter.enableOrbitParser

(

)

throws EoAdapterError

Enable the orbit parser.

Exceptions

EoAdapterError

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

References EoOrbAttAdapter.EoAdapterError.addError().

getAttitudeData()

AttFile EoOrbAttAdapter.EoOrbAttAdapter.getAttitudeData

(

)

throws EoAdapterError

Get Attitude data file.

Returns

EOCFI object with the attitude file data

getMainConfiguration()

AdpMainConfiguration EoOrbAttAdapter.EoOrbAttAdapter.getMainConfiguration

(

)

throws EoAdapterError

Get the configuration with the input file name.

Returns

output configuration data

Exceptions

EoAdapterError

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

References EoOrbAttAdapter.EoAdapterError.addError().

getNofItems()

long EoOrbAttAdapter.EoOrbAttAdapter.getNofItems

(

)

Get Number of items to be parsed.

getNofProcessedItems()

long EoOrbAttAdapter.EoOrbAttAdapter.getNofProcessedItems

(

)

Get Number of processed items.

getOrbitData()

OrbitFile EoOrbAttAdapter.EoOrbAttAdapter.getOrbitData

(

)

throws EoAdapterError

Get Orbit data file.

Returns

EOCFI object with the orbit file data

getVersion()

String EoOrbAttAdapter.EoOrbAttAdapter.getVersion

(

)

Get tool version.

Returns

Adapter tool version

initLogger() [1/2]

Logger EoOrbAttAdapter.EoOrbAttAdapter.initLogger

(

)

Sent the log message to the console By default the messages about the parsing progress are not shown.

To visualize the messages through the standard output, this method has to be called.

initLogger() [2/2]

Logger EoOrbAttAdapter.EoOrbAttAdapter.initLogger

(

String

logFile

)

throws EoAdapterError

Set the log file.

By default the messages about the parsing progress are not shown. To write the the messages to an output file, this method has to be called.

Parameters

logFile

log file name where the log will be written (path+name)

Exceptions

EoAdapterError

if log file does not exists

References EoOrbAttAdapter.EoAdapterError.addError().

parse() [1/3]

void EoOrbAttAdapter.EoOrbAttAdapter.parse

(

)

throws 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

EoAdapterError

if the data file could not be parsed

References EoOrbAttAdapter.EoAdapterError.addError().

parse() [2/3]

void EoOrbAttAdapter.EoOrbAttAdapter.parse

(

final byte[]

dataArr

)

throws EoAdapterError

Execute the parser for the input byte array data.

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

dataArr

input byte array to parser.

Exceptions

EoAdapterError

if the data file could not be parsed

parse() [3/3]

void EoOrbAttAdapter.EoOrbAttAdapter.parse

(

final String

dataFile

)

throws 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

dataFile

input data file to parser.

Exceptions

EoAdapterError

if the data file could not be parsed

References EoOrbAttAdapter.EoAdapterError.addError().

printValidationReport()

void EoOrbAttAdapter.EoOrbAttAdapter.printValidationReport

(

)

throws EoAdapterError

Print the validation report.

References printValidationReport().

Referenced by printValidationReport().

setMainConfiguration() [1/2]

void EoOrbAttAdapter.EoOrbAttAdapter.setMainConfiguration

(

final AdpMainConfiguration

inputConfig

)

throws EoAdapterError

Set the configuration with the input data object.

Parameters

inputConfig

configuration data

Exceptions

EoAdapterError

if configuration was already set

References EoOrbAttAdapter.EoAdapterError.addError(), EoOrbAttAdapter.AdpOutputConfiguration.commonOutputConfig, EoOrbAttAdapter.AdpMainConfiguration.initTimeCorrelations(), and EoOrbAttAdapter.AdpCommonOutputConfiguration.missionId.

setMainConfiguration() [2/2]

void EoOrbAttAdapter.EoOrbAttAdapter.setMainConfiguration

(

String

configurationFile

)

throws EoAdapterError

Set the configuration with the input file name.

Parameters

configurationFile

configuration file (path+name)

Exceptions

EoAdapterError

if configuration was already set

References EoOrbAttAdapter.AdpMainConfiguration.loadMainConfiguration(), and setMainConfiguration().

Referenced by setMainConfiguration().

setParser()

void EoOrbAttAdapter.EoOrbAttAdapter.setParser

(

final AdpDefaultParser

inputParser

)

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

Parameters

inputParser

parser to be used by the adapter

References EoOrbAttAdapter.AdpDefaultParser.getParserConfiguration().

validationChecks()

void EoOrbAttAdapter.EoOrbAttAdapter.validationChecks

(

)

throws EoAdapterError

Check inconsistencies in the parsed orbit and attitude data.

Exceptions

EoAdapterError

if the data could not be parsed

References EoOrbAttAdapter.EoAdapterError.addCfiErrors(), EoOrbAttAdapter.EoAdapterError.addError(), EoOrbAttAdapter.AdpInputConfiguration.attChecks, EoOrbAttAdapter.AttDiagnostic.computeDiagnostics(), EoOrbAttAdapter.AdpOrbitChecksConfiguration.duplicatedOsvThreshold, EoOrbAttAdapter.AdpAttitudeChecksConfiguration.duplicatedThreshold, EoOrbAttAdapter.AdpAttitudeChecksConfiguration.maximumGap, EoOrbAttAdapter.AdpOrbitChecksConfiguration.maximumGap, EoOrbAttAdapter.AdpInputConfiguration.orbitChecks, EoOrbAttAdapter.AdpAttitudeChecksConfiguration.timeStep, EoOrbAttAdapter.AdpOrbitChecksConfiguration.timeStep, EoOrbAttAdapter.AdpAttitudeChecksConfiguration.timeStepThreshold, and EoOrbAttAdapter.AdpOrbitChecksConfiguration.timeStepThreshold.

writeAttitudeDataToFile() [1/2]

String EoOrbAttAdapter.EoOrbAttAdapter.writeAttitudeDataToFile

(

)

throws EoAdapterError

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

Exceptions

EoAdapterError

if file could not be written

References EoOrbAttAdapter.AdpOutputConfiguration.attitudeOutputConfig, EoOrbAttAdapter.AdpAttitudeOutputConfiguration.defaultFile, and writeAttitudeDataToFile().

Referenced by writeAttitudeDataToFile().

writeAttitudeDataToFile() [2/2]

String EoOrbAttAdapter.EoOrbAttAdapter.writeAttitudeDataToFile

(

final String

OutputAttFile

)

throws EoAdapterError

Write attitude data to attitude File.

Parameters

OutputAttFile

filename for the output file

Exceptions

EoAdapterError

if file could not be written

References EoOrbAttAdapter.EoAdapterError.addCfiErrors(), and EoOrbAttAdapter.EoAdapterError.addError().

writeOrbitDataToFile() [1/2]

String EoOrbAttAdapter.EoOrbAttAdapter.writeOrbitDataToFile

(

)

throws EoAdapterError

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

Exceptions

EoAdapterError

if file could not be written

References EoOrbAttAdapter.AdpOrbitOutputConfiguration.defaultFile, EoOrbAttAdapter.AdpOutputConfiguration.orbitOutputConfig, and writeOrbitDataToFile().

Referenced by writeOrbitDataToFile().

writeOrbitDataToFile() [2/2]

String EoOrbAttAdapter.EoOrbAttAdapter.writeOrbitDataToFile

(

final String

OutputOrbitFile

)

throws EoAdapterError

Write OSVs to Orbit File.

Parameters

OutputOrbitFile

filename for the output file

Exceptions

EoAdapterError

if file could not be written

References EoOrbAttAdapter.EoAdapterError.addCfiErrors(), and EoOrbAttAdapter.EoAdapterError.addError().