Package org.orekit.files.spice.binary.daf.generic

Class DAFFileRecord

java.lang.Object

org.orekit.files.spice.binary.daf.generic.DAFFileRecord

public class DAFFileRecord
extends Object

Represents the first, global file record of a DAF file, containing generic metadata.

Since:

14.0

Author:

Rafael Ayala

Constructor Summary

Constructors

Constructor	Description
DAFFileRecord(String fileType, int numDoublesSummary, int numIntsSummary, int numCharsName, int singleSummarySizeDoubles, String description, int firstSummaryRecNum, int lastSummaryRecNum, long firstFreeAddress, String endianString, String ftpString)	Constructor initializing all metadata fields.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get the internal name of the DAF file.
String	getEndianString()	Get the endianness string of the file.
String	getFileType()	Get the file type string.
long	getFirstFreeAddress()	Get the first free byte address in the DAF file.
int	getFirstSummaryRecNum()	Get the record number of the first summary record in the DAF file.
String	getFtpString()	Get the integrity-check (FTP) string.
int	getLastSummaryRecNum()	Get the record number of the last summary record in the DAF file.
int	getNumCharsName()	Get the number of characters used to store each array name.
int	getNumDoublesSummary()	Get the number of doubles stored in each array summary.
int	getNumIntsSummary()	Get the number of integers stored in each array summary.
int	getSingleSummarySizeDoubles()	Get the size of a single array summary in doubles.

Methods inherited from class java.lang.Object

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

Constructor Details

DAFFileRecord

public DAFFileRecord(String fileType,
 int numDoublesSummary,
 int numIntsSummary,
 int numCharsName,
 int singleSummarySizeDoubles,
 String description,
 int firstSummaryRecNum,
 int lastSummaryRecNum,
 long firstFreeAddress,
 String endianString,
 String ftpString)

Constructor initializing all metadata fields.

Parameters:

fileType - string of the format DAF/XXXX, i.e., "DAF/" followed by 4 or less characters

numDoublesSummary - number of doubles in each array summary

numIntsSummary - number of integers in each array summary

numCharsName - number of characters used to store each array name

singleSummarySizeDoubles - size of a single array summary in doubles

description - internal name or description of the DAF file

firstSummaryRecNum - index of the first summary record in the DAF file

lastSummaryRecNum - index of the last summary record in the DAF file

firstFreeAddress - the first free byte address in the DAF file

endianString - the file endianness string (either "LTL-IEEE" or "BIG-IEEE")

ftpString - integrity-check string (should match "FTPSTR:\r:\n:\r\n:\r::Î:ENDFTP";)

Method Details

getFileType

public String getFileType()

Get the file type string.

Returns:

the file type string

getNumDoublesSummary

public int getNumDoublesSummary()

Get the number of doubles stored in each array summary.

Returns:

the number of doubles stored in each array summary

getNumIntsSummary

public int getNumIntsSummary()

Get the number of integers stored in each array summary.

Returns:

the number of integers stored in each array summary

getNumCharsName

public int getNumCharsName()

Get the number of characters used to store each array name.

Returns:

the number of characters used to store each array name

getSingleSummarySizeDoubles

public int getSingleSummarySizeDoubles()

Get the size of a single array summary in doubles.

Returns:

the size of a single array summary in doubles

getDescription

public String getDescription()

Get the internal name of the DAF file.

Returns:

the internal name of the DAF file

getFirstSummaryRecNum

public int getFirstSummaryRecNum()

Get the record number of the first summary record in the DAF file.

Returns:

the record number of the first summary record in the DAF file

getLastSummaryRecNum

public int getLastSummaryRecNum()

Get the record number of the last summary record in the DAF file.

Returns:

the record number of the last summary record in the DAF file

getFirstFreeAddress

public long getFirstFreeAddress()

Get the first free byte address in the DAF file.

Returns:

the first free byte address in the DAF file

getEndianString

public String getEndianString()

Get the endianness string of the file.

Returns:

the endianness string of the file

getFtpString

public String getFtpString()

Get the integrity-check (FTP) string.

Returns:

the integrity-check (FTP) string