ffDataSeries Struct Reference
[Frame utilities]

#include <framedir.hh>

Inheritance diagram for ffDataSeries:

List of all members.

Public Member Functions
	ffDataSeries (void)
	ffDataSeries (const char *File, const Time &time, Interval Dt=Interval(1.0), bool DataOK=true)
	ffDataSeries (const char *Prefix, const char *Suffix, const Time &time, Interval Dt=Interval(1.0), count_t N=1)
	ffDataSeries (const ffData &data)
bool	joinable (const ffDataSeries &series) const
bool	join (const ffDataSeries &series)
bool	join (const char *Prefix, const char *Suffix, const Time &time, Interval Dt)
Time	getEndTime (void) const
gps_t	getEndGPS (void) const
Time	getTime (count_t n) const
gps_t	getGPS (count_t n) const
Interval	getLength (void) const
count_t	getNFiles (void) const
void	setNFiles (count_t N)

---

Detailed Description

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

Author:

D. Sigg

---

Constructor & Destructor Documentation

ffDataSeries::ffDataSeries

(

void

)

[inline]

Default constructor. brief Default constructor.

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

Construct a table entry for a specified file that does not follow the naming convention. brief Data constructor.

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]

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

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]

Construct a series from a data object brief Data constructor.

---

Member Function Documentation

bool ffDataSeries::joinable

(

const ffDataSeries &

series

)

const

Returns true if the two files series are joinable. brief Joinable.

Parameters:

series

File series.

Returns:

True if joinable series

bool ffDataSeries::join

(

const ffDataSeries &

series

)

Joins with another frame file series. brief Join.

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
	)

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

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]

Get the absolute end time of the data series. brief End time.

Returns:

End time for the last frame series.

Reimplemented from ffData.

gps_t ffDataSeries::getEndGPS

(

void

)

const [inline]

Get the end GPS second. brief GPS end time.

Returns:

End time of the first frame in GPS seconds.

Reimplemented from ffData.

Time ffDataSeries::getTime

(

count_t

n

)

const [inline]

Get the starting time of the nth data object. brief Time.

Returns:

Start time for the nth data object.

gps_t ffDataSeries::getGPS

(

count_t

n

)

const [inline]

Get the GPS time of the nth data object. brief Time.

Returns:

Start time for the nth data object.

Interval ffDataSeries::getLength

(

void

)

const [inline]

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

Returns:

Interval covered by series.

count_t ffDataSeries::getNFiles

(

void

)

const [inline]

Get the number of frames in the file. brief Number of frames.

Returns:

Number of frames in the file.

void ffDataSeries::setNFiles

(

count_t

N

)

[inline]

Set the number of frames in the file. brief Number of frames.

Returns:

Number of frames in the file.

---

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

• frameutils/framedir.hh

---