ffDataSeries Struct Reference
[Frame utilities]

Series of frame file data. More...

#include <framedir.hh>

Inheritance diagram for ffDataSeries:

List of all members.

Public Member Functions
	ffDataSeries (void)
	Default constructor.
	ffDataSeries (const char *File, const Time &time, Interval Dt=Interval(1.0), bool DataOK=true)
	Data constructor.
	ffDataSeries (const char *Prefix, const char *Suffix, const Time &time, Interval Dt=Interval(1.0), count_t N=1)
	Data constructor.
	ffDataSeries (const ffData &data)
	Data constructor.
bool	joinable (const ffDataSeries &series) const
	Joinable.
bool	join (const ffDataSeries &series)
	Join.
bool	join (const char *Prefix, const char *Suffix, const Time &time, Interval Dt)
	Join.
Time	getEndTime (void) const
	End time.
gps_t	getEndGPS (void) const
	GPS end time.
Time	getTime (count_t n) const
	Time.
gps_t	getGPS (count_t n) const
	Time.
Interval	getLength (void) const
	Length of time covered by series.
count_t	getNFiles (void) const
	Number of frames.
void	setNFiles (count_t N)
	Number of frames.

---

Detailed Description

Series of frame file data.

The frame file data series structure contains information about frame files covering a continuous time and having identical file name prefix and suffix.

Author:

D. Sigg

---

Constructor & Destructor Documentation

ffDataSeries::ffDataSeries

(

void

)

[inline]

Default constructor.

Default constructor.

ffDataSeries::ffDataSeries	(	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 that does not follow the naming convention.

Parameters:

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

ffDataSeries::ffDataSeries	(	const char *	Prefix,
		const char *	Suffix,
		const Time &	time,
		Interval	Dt = Interval(1.0),
		count_t	N = 1
	)			[inline]

Data constructor.

Construct a table entry for a specified file series that follows the naming convention.

Parameters:

	Prefix	Prefix of name of frame file(s)
	Suffix	Suffix of name of frame file(s)
	time	Start time of first frame file
	N	Number of frames file in series.
	Dt	Length of time spanned by each file.

ffDataSeries::ffDataSeries

(

const ffData &

data

)

[inline]

Data constructor.

Construct a series from a data object

---

Member Function Documentation

bool ffDataSeries::joinable

(

const ffDataSeries &

series

)

const

Joinable.

Returns true if the two files series are joinable.

Parameters:

series

File series.

Returns:

True if joinable series

bool ffDataSeries::join

(

const ffDataSeries &

series

)

Join.

Joins with another frame file series.

Parameters:

series

File series.

Returns:

True if series could be joined

bool ffDataSeries::join	(	const char *	Prefix,
		const char *	Suffix,
		const Time &	time,
		Interval	Dt
	)

Join.

Tries to join a frame file to the series' end.

Parameters:

	Prefix	Prefix of name of frame file(s)
	Suffix	Suffix of name of frame file(s)
	time	Start time of first frame file
	Dt	Length of time spanned by each file.

Returns:

True if file could be joined

Time ffDataSeries::getEndTime

(

void

)

const [inline]

End time.

Get the absolute end time of the data series.

Returns:

End time for the last frame series.

Reimplemented from ffData.

gps_t ffDataSeries::getEndGPS

(

void

)

const [inline]

GPS end time.

Get the end GPS second.

Returns:

End time of the first frame in GPS seconds.

Reimplemented from ffData.

Time ffDataSeries::getTime

(

count_t

n

)

const [inline]

Time.

Get the starting time of the nth data object.

Returns:

Start time for the nth data object.

gps_t ffDataSeries::getGPS

(

count_t

n

)

const [inline]

Time.

Get the GPS time of the nth data object.

Returns:

Start time for the nth data object.

Interval ffDataSeries::getLength

(

void

)

const [inline]

Length of time covered by series.

Get the length of time covered by the series.

Returns:

Interval covered by series.

count_t ffDataSeries::getNFiles

(

void

)

const [inline]

Number of frames.

Get the number of frames in the file.

Returns:

Number of frames in the file.

void ffDataSeries::setNFiles

(

count_t

N

)

[inline]

Number of frames.

Set the number of frames in the file.

Returns:

Number of frames in the file.

---

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

• frameutils/framedir.hh

---