struct ffData

Frame file data.

ffData(void)
Default constructor.
ffData(const char* File, const Time& time, count_t nFrames=1, Interval Dt=Interval(1.0), bool DataOK=false)
Data constructor.
ffData(const ffData& x)
Copy contructor.
ffData& operator=(const ffData& x)
Asignment operator.
Interval getDt(void) const
Length of time covered by a frame.
const char* getFile(void) const
File name.
count_t getNFrames(void) const
Number of frames.
Time getStartTime(void) const
Start time.
Time getEndTime(void) const
End time.
bool isValid(void) const
Test data quality.
gps_t getStartGPS(void) const
GPS start time.
gps_t getEndGPS(void) const
GPS end time.
std::string mFile
File name including directory name
Time mStartGPS
Starting GPS time of first frame in file
count_t mNFrames
Number of frames in the file
Interval mDt
Length of each frame in the file
bool mDataOK
Data comes from reading frame

Documentation

The frame file data structure contains information about the frames in a specified frame file. A flag in the ffData object specifies whether the information has been gathered by reading the file or by inference.
ffData(void)
Default constructor.

ffData(const char* File, const Time& time, count_t nFrames=1, Interval Dt=Interval(1.0), bool DataOK=false)
Construct a table entry for a specified file.
Parameters:
File - Name of frame file
time - Start time of first frame
nFrames - Number of frames in the file.
Dt - Length of time spanned by each frame.
DataOK - True if measured data are supplied.

ffData(const ffData& x)
Copy an ffData object.

ffData& operator=(const ffData& x)
Copy an ffData object.
Returns:
reference to the modified ffData.
Parameters:
x - ffData object to be copied.

Interval getDt(void) const
Get the length of time covered by a single frame in the file.
Returns:
Interval covered by a frame.

const char* getFile(void) const
Get the name of the filed described by thsi object.
Returns:
Pointer to the file name.

count_t getNFrames(void) const
Get the number of frames in the file.
Returns:
Number of frames in the file.

Time getStartTime(void) const
Get the absolute starting time of the data in the file.
Returns:
Start time for the first frame in the file.

Time getEndTime(void) const
Get the absolute end time of the data in the file.
Returns:
End time for the last frame in the file.

bool isValid(void) const
Test whether the information has been gathered by reading the file or inferred from default values or other files in the directory.
Returns:
true if data have been gathered from the file.

gps_t getStartGPS(void) const
Get the starting GPS second.
Returns:
Start time in GPS seconds of the first frame.

gps_t getEndGPS(void) const
Get the end GPS second.
Returns:
End time of the first frame in GPS seconds.

Author:
J. Zweizig
Version:
V1.0; Modified February 3, 2000

alphabetic index hierarchy of classes


generated by doc++