ffData Struct Reference
[Frame utilities]

Frame file data. More...

#include <framedir.hh>

Inheritance diagram for ffData:

List of all members.

Public Types
typedef Time::ulong_t	gps_t
typedef unsigned long	count_t
Public Member Functions
	ffData (void)
	Default constructor.
	ffData (const char *File, const Time &time, Interval Dt=Interval(1.0), bool DataOK=true)
	Data constructor.
	ffData (const char *Prefix, const char *Suffix, const Time &time, Interval Dt=Interval(1.0))
	Data constructor.
Interval	getDt (void) const
	Length of time covered by file.
const char *	getPrefix (void) const
	File prefix.
const char *	getSuffix (void) const
	File suffix.
std::string	getFile (count_t N=0) const
	File name.
bool	advance (int N)
	advance the start time
Time	getStartTime (void) const
	Start time.
Time	getEndTime (void) const
	End time.
bool	isFollowed (void) const
	Test naming convention.
bool	isValid (void) const
	Test data quality.
gps_t	getStartGPS (void) const
	GPS start time.
gps_t	getEndGPS (void) const
	GPS end time.
Protected Attributes
std::string	mFilePrefix
std::string	mFileSuffix
Time	mStartGPS
Interval	mDt
bool	mNamingOK
bool	mDataOK

---

Detailed Description

Frame file data.

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.

Author:

J. Zweizig

Version:

V1.0; Modified February 3, 2000

---

Member Typedef Documentation

typedef Time::ulong_t ffData::gps_t

GPS time data type.

typedef unsigned long ffData::count_t

Count data type.

---

Constructor & Destructor Documentation

ffData::ffData

(

void

)

[inline]

Default constructor.

Default constructor.

ffData::ffData	(	const char *	File,
		const Time &	time,
		Interval	Dt = Interval(1.0),
		bool	DataOK = true
	)			[inline]

Data constructor.

Construct a table entry for a specified file. This constructor is for files that DO NOT follow the naming convention.

Parameters:

	File	Name of frame file
	time	Start time of first frame
	Dt	Length of time spanned by each frame.
	DataOK	True if measured data are supplied.

ffData::ffData	(	const char *	Prefix,
		const char *	Suffix,
		const Time &	time,
		Interval	Dt = Interval(1.0)
	)			[inline]

Data constructor.

Construct a table entry for a specified file. This constructor is for files that DO follow the naming convention.

Parameters:

	Prefix	Name prefix of frame file
	Suffix	Name suffix of frame file
	time	Start time of first frame
	Dt	Length of time spanned by each frame.

---

Member Function Documentation

Interval ffData::getDt

(

void

)

const [inline]

Length of time covered by file.

Get the length of time covered by the file.

Returns:

Interval covered by file.

const char * ffData::getPrefix

(

void

)

const [inline]

File prefix.

Get the name prefix of the file described by this object.

Returns:

Pointer to the file prefix.

const char * ffData::getSuffix

(

void

)

const [inline]

File suffix.

Get the name suffix of the file described by this object.

Returns:

Pointer to the file suffix.

std::string ffData::getFile

(

count_t

N = 0

)

const

File name.

Get the name of the filed described by this object. The argument N can be used to derive a frame file name later in the series if the naming convention is followed. Setting N to anything than 0 if the naming convention is not followed will return an empty string.

Parameters:

N

frame file number (0 for current).

Returns:

File name.

bool ffData::advance

(

int

N

)

[inline]

advance the start time

Advance the starting GPS by N frames.

Parameters:

N

number of frames to increment the time.

Returns:

True if successful.

Time ffData::getStartTime

(

void

)

const [inline]

Start time.

Get the absolute starting time of the data in the file.

Returns:

Start time for the first frame in the file.

Time ffData::getEndTime

(

void

)

const [inline]

End time.

Get the absolute end time of the data in the file.

Returns:

End time for the last frame in the file.

Reimplemented in ffDataSeries.

bool ffData::isFollowed

(

void

)

const [inline]

Test naming convention.

Test whether the file name follows the convention.

Returns:

true if naming convention is followed.

bool ffData::isValid

(

void

)

const [inline]

Test data quality.

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.

ffData::gps_t ffData::getStartGPS

(

void

)

const [inline]

GPS start time.

Get the starting GPS second.

Returns:

Start time in GPS seconds of the first frame.

ffData::gps_t ffData::getEndGPS

(

void

)

const [inline]

GPS end time.

Get the end GPS second.

Returns:

End time of the first frame in GPS seconds.

Reimplemented in ffDataSeries.

---

Member Data Documentation

std::string ffData::mFilePrefix [protected]

File name including directory name (prefix if mNamingOK).

std::string ffData::mFileSuffix [protected]

File name including directory name (suffix if mNamingOK).

Time ffData::mStartGPS [protected]

Starting GPS time of first frame in file.

Interval ffData::mDt [protected]

Duration of frame file.

bool ffData::mNamingOK [protected]

File name follows naming convention

bool ffData::mDataOK [protected]

Data comes from reading frame, is inferred from file name or is inferred from other files in directory

---

The documentation for this struct was generated from the following file:

• frameutils/framedir.hh

---