SDIF::Frame Class Reference

SDIF data is stored in frames, that contain number of matrices. More...

#include <SDIFFrame.hxx>

List of all members.

Public Types
typedef std::list< Matrix * > ::const_iterator	MatrixIterator
Public Member Functions
	Frame (const TypeId &type=TypeId::sDefault, CLAM::TFloat64 time=0., CLAM::TInt32 streamId=0)
	Create a new Frame.
	~Frame ()
void	Add (Matrix *pMatrix)
	Add a SDIFMatrix to the frame.
Matrix *	GetMatrixAt (int i)
MatrixIterator	Begin (void) const
MatrixIterator	End (void) const
CLAM::TFloat64	Time (void)
TypeId	Type (void)
Friends
class	File
class	Collection

---

Detailed Description

SDIF data is stored in frames, that contain number of matrices.

An SDIFFrame can be aware of it's successors and precessors in time (both in the whole list of frames and in the streams)

Definition at line 52 of file SDIFFrame.hxx.

---

Member Typedef Documentation

typedef std::list<Matrix*>::const_iterator SDIF::Frame::MatrixIterator

Definition at line 56 of file SDIFFrame.hxx.

---

Constructor & Destructor Documentation

Frame::Frame	(	const TypeId &	type = TypeId::sDefault,
		CLAM::TFloat64	time = 0.,
		CLAM::TInt32	streamId = 0
	)

Create a new Frame.

Parameters:

	type	Identifier specifying the frame type
	time	Timestamp of the frame
	id	Stream ID

Definition at line 27 of file SDIFFrame.cxx.

Frame::~Frame

(

)

Definition at line 32 of file SDIFFrame.cxx.

---

Member Function Documentation

void Frame::Add

(

Matrix *

pMatrix

)

Add a SDIFMatrix to the frame.

Parameters:

pMatrix

pointer to the SDIFMatrix to add to the frame

Definition at line 46 of file SDIFFrame.cxx.

References SDIF::DataFrameHeader::mnMatrices, SDIF::FrameHeader::mSize, and SDIF::Matrix::SizeInFile().

MatrixIterator SDIF::Frame::Begin

(

void

)

const [inline]

Definition at line 82 of file SDIFFrame.hxx.

MatrixIterator SDIF::Frame::End

(

void

)

const [inline]

Definition at line 83 of file SDIFFrame.hxx.

Matrix* SDIF::Frame::GetMatrixAt

(

int

i

)

[inline]

Definition at line 75 of file SDIFFrame.hxx.

CLAM::TFloat64 SDIF::Frame::Time

(

void

)

[inline]

Definition at line 85 of file SDIFFrame.hxx.

References SDIF::DataFrameHeader::mTime.

Referenced by CLAM::SDIFFileReader::ReadFrame().

TypeId SDIF::Frame::Type

(

void

)

[inline]

Definition at line 86 of file SDIFFrame.hxx.

References SDIF::FrameHeader::mType.

---

Friends And Related Function Documentation

friend class Collection [friend]

Definition at line 54 of file SDIFFrame.hxx.

friend class File [friend]

Definition at line 53 of file SDIFFrame.hxx.

---

The documentation for this class was generated from the following files:

• SDIFFrame.hxx
• SDIFFrame.cxx