ffData Struct Reference
[Frame utilities]

#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)
	ffData (const char *File, const Time &time, Interval Dt=Interval(1.0), bool DataOK=true)
	ffData (const char *Prefix, const char *Suffix, const Time &time, Interval Dt=Interval(1.0))
Interval	getDt (void) const
const char *	getPrefix (void) const
const char *	getSuffix (void) const
std::string	getFile (count_t N=0) const
bool	advance (int N)
Time	getStartTime (void) const
Time	getEndTime (void) const
bool	isFollowed (void) const
bool	isValid (void) const
gps_t	getStartGPS (void) const
gps_t	getEndGPS (void) const
Protected Attributes
std::string	mFilePrefix
std::string	mFileSuffix
Time	mStartGPS
Interval	mDt
bool	mNamingOK
bool	mDataOK

---

Detailed Description

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. brief Frame file data.

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. brief Default constructor.

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

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

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]

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

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]

Get the length of time covered by the file. brief Length of time covered by file.

Returns:

Interval covered by file.

const char * ffData::getPrefix

(

void

)

const [inline]

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

Returns:

Pointer to the file prefix.

const char * ffData::getSuffix

(

void

)

const [inline]

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

Returns:

Pointer to the file suffix.

std::string ffData::getFile

(

count_t

N = 0

)

const

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. brief File name.

Parameters:

N

frame file number (0 for current).

Returns:

File name.

bool ffData::advance

(

int

N

)

[inline]

Advance the starting GPS by N frames. brief advance the start time

Parameters:

N

number of frames to increment the time.

Returns:

True if successful.

Time ffData::getStartTime

(

void

)

const [inline]

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

Returns:

Start time for the first frame in the file.

Time ffData::getEndTime

(

void

)

const [inline]

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

Returns:

End time for the last frame in the file.

Reimplemented in ffDataSeries.

bool ffData::isFollowed

(

void

)

const [inline]

Test whether the file name follows the convention. brief Test naming convention.

Returns:

true if naming convention is followed.

bool ffData::isValid

(

void

)

const [inline]

Test whether the information has been gathered by reading the file or inferred from default values or other files in the directory. brief Test data quality.

Returns:

true if data have been gathered from the file.

ffData::gps_t ffData::getStartGPS

(

void

)

const [inline]

Get the starting GPS second. brief GPS start time.

Returns:

Start time in GPS seconds of the first frame.

ffData::gps_t ffData::getEndGPS

(

void

)

const [inline]

Get the end GPS second. brief GPS end time.

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

---