EoOrbAttAdapter

Class EoOrbAttAdapter

java.lang.Object

EoOrbAttAdapter.EoOrbAttAdapter

public class EoOrbAttAdapter
extends java.lang.Object

This class is the main Adapter Interface. It provides methods to set the configuration, parse files, retrieve orbit/attitude data, write orbit/attitude files.

Constructor Summary

Constructors

Constructor and Description
EoOrbAttAdapter() Empty class Constructor

Method Summary

Modifier and Type	Method and Description
void	clearAttitudeData() Clear internal attitude data.
void	clearOrbitData() Clear internal orbit data.
void	disableAttitudeParser() Disable the attitude parser.
void	disableOrbitParser() Disable the orbit parser.
void	enableAttitudeParser() Enable the attitude parser.
void	enableOrbitParser() Enable the orbit parser.
AttFile	getAttitudeData() Return parsed Attitude data as an EOCFI AttFile object
AdpMainConfiguration	getMainConfiguration() Return the currently set configuration as an AdpMainConfiguration object.
long	getNofItems() Get Number of items (packets) contained in the data file.
long	getNofProcessedItems() Get Number of processed items (packets).
OrbitFile	getOrbitData() Return parsed Orbit data as an EOCFI OrbitFile object
java.lang.String	getVersion() Return Adapter tool version
java.util.logging.Logger	initLogger() Init and returns the Logger, Log messages are sent to standard output.
java.util.logging.Logger	initLogger(java.lang.String logFile) Init and returns the Logger, Log messages are sent to standard output and logFile.
void	parse() Parse the input data file defined in the main configuration file.
void	parse(java.lang.String dataFile) Execute the parser for the input data file.
void	setMainConfiguration(AdpMainConfiguration inputConfig) Set the Adapter main configuration using an AdpMainConfiguration object.
void	setMainConfiguration(java.lang.String configurationFile) Set the Adapter main configuration using the input configurationFile.
void	setParser(AdpDefaultParser inputParser) Set a user defined (custom) parser
java.lang.String	writeAttitudeDataToFile() Write attitude data to Attitude File and return the filename.
java.lang.String	writeAttitudeDataToFile(java.lang.String OutputAttFile) Write attitude data to Orbit File and return the filename
java.lang.String	writeOrbitDataToFile() Write orbit data to Orbit File and return the filename.
java.lang.String	writeOrbitDataToFile(java.lang.String OutputOrbitFile) Write orbit data to Orbit File and return the filename

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EoOrbAttAdapter

public EoOrbAttAdapter()

Empty class Constructor

Method Detail

getNofItems

public long getNofItems()

Get Number of items (packets) contained in the data file. This method returns a valid value only during the execution of the parse method.

Returns:

Number of items (packets) contained in the data file.

getNofProcessedItems

public long getNofProcessedItems()

Get Number of processed items (packets). This method returns a valid value only during the execution of the parse method.

Returns:

Number of items (packets) contained in the data file.

getVersion

public java.lang.String getVersion()

Return Adapter tool version

Returns:

Adapter tool version

initLogger

public java.util.logging.Logger initLogger()

Init and returns the Logger, Log messages are sent to standard output.

Returns:

the Logger object

initLogger

public java.util.logging.Logger initLogger(java.lang.String logFile)
                                    throws EoAdapterError

Init and returns the Logger, Log messages are sent to standard output and logFile.

Parameters:

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

Throws:

EoAdapterError - if log file does not exists

setMainConfiguration

public void setMainConfiguration(java.lang.String configurationFile)
                          throws EoAdapterError

Set the Adapter main configuration using the input configurationFile.

Parameters:

configurationFile - configuration file (path+name)

Throws:

EoAdapterError - if configuration was already set

setMainConfiguration

public void setMainConfiguration(AdpMainConfiguration inputConfig)
                          throws EoAdapterError

Set the Adapter main configuration using an AdpMainConfiguration object.

Parameters:

inputConfig - configuration data

Throws:

EoAdapterError - if configuration was already set

getMainConfiguration

public AdpMainConfiguration getMainConfiguration()
                                          throws EoAdapterError

Return the currently set configuration as an AdpMainConfiguration object.

Returns:

output configuration data

Throws:

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

enableOrbitParser

public void enableOrbitParser()
                       throws EoAdapterError

Enable the orbit parser.

This method overrides the status attribute enabled/disabled in the main configuration.

Throws:

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

disableOrbitParser

public void disableOrbitParser()
                        throws EoAdapterError

Disable the orbit parser.

This method overrides the status attribute enabled/disabled in the main configuration.

Throws:

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

enableAttitudeParser

public void enableAttitudeParser()
                          throws EoAdapterError

Enable the attitude parser.

This method overrides the status attribute enabled/disabled in the main configuration.

Throws:

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

disableAttitudeParser

public void disableAttitudeParser()
                           throws EoAdapterError

Disable the attitude parser.

This method overrides the status attribute enabled/disabled in the main configuration.

Throws:

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

setParser

public void setParser(AdpDefaultParser inputParser)

Set a user defined (custom) parser

The inputParser will be used by the next calls to the parse method if the parser type is CUSTOM.

Parameters:

inputParser - parser to be used by the adapter

parse

public void parse(java.lang.String dataFile)
           throws EoAdapterError

Execute the parser for the input data file.

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

Parameters:

dataFile - input data file to parser.

Throws:

EoAdapterError - if the data file could not be parsed

parse

public void parse()
           throws EoAdapterError

Parse the input data file defined in the main configuration file.

The file to be parsed will be taken from the main configuration file:

<Input_Configuration>
<Default_Values>
<Input_Data_Filename>... </Input_Data_Filename>
</Default_Values>

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.

Throws:

EoAdapterError - if the data file could not be parsed

clearOrbitData

public void clearOrbitData()

Clear internal orbit data.

When the parse method is called, an internal memory structure is filled.

The following calls to the parse method will add data to the structure.

Calling the clearOrbitData method will clear such memory structure.

clearAttitudeData

public void clearAttitudeData()

Clear internal attitude data.

When the parse method is called, an internal memory structure is filled.

The following calls to the parse method will add data to the structure.

Calling the clearAttitudeData method will clear such memory structure.

writeOrbitDataToFile

public java.lang.String writeOrbitDataToFile()
                                      throws EoAdapterError

Write orbit data to Orbit File and return the filename.

Filename will be taken from Main Configuration File:

<Output_Configuration>
<Orbit type="EO_FILE">
<Default_Filename>...</Default_Filename>
If empty the filename will be generated according to File Format Standard.

Returns:

the written orbit file name

Throws:

EoAdapterError - if file could not be written

writeOrbitDataToFile

public java.lang.String writeOrbitDataToFile(java.lang.String OutputOrbitFile)
                                      throws EoAdapterError

Write orbit data to Orbit File and return the filename

Parameters:

OutputOrbitFile - the output file name

Returns:

the written orbit file name

Throws:

EoAdapterError - if file could not be written

getOrbitData

public OrbitFile getOrbitData()
                       throws EoAdapterError

Return parsed Orbit data as an EOCFI OrbitFile object

Returns:

EOCFI object with the orbit file data

Throws:

EoAdapterError

writeAttitudeDataToFile

public java.lang.String writeAttitudeDataToFile()
                                         throws EoAdapterError

Write attitude data to Attitude File and return the filename.

Filename will be taken from Main Configuration File:

<Output_Configuration>
<Attitude type="EO_FILE">
<Default_Filename>...</Default_Filename>
If empty the filename will be generated according to File Format Standard.

Returns:

the written attitude file name

Throws:

EoAdapterError - if file could not be written

writeAttitudeDataToFile

public java.lang.String writeAttitudeDataToFile(java.lang.String OutputAttFile)
                                         throws EoAdapterError

Write attitude data to Orbit File and return the filename

Parameters:

OutputAttFile - the output file name

Returns:

the written orbit file name

Throws:

EoAdapterError - if file could not be written

getAttitudeData

public AttFile getAttitudeData()
                        throws EoAdapterError

Return parsed Attitude data as an EOCFI AttFile object

Returns:

EOCFI object with the attitude file data

Throws:

EoAdapterError