RL_SequenceFileHeader Class Reference

List of all members.

Public Member Functions
	RL_SequenceFileHeader (unsigned int nCam, unsigned int *serials)
	RL_SequenceFileHeader: Constructor for writing the header.
	RL_SequenceFileHeader ()
	RL_SequenceFileHeader: Default constructor.
void	SetResolution (int width, int height)
	SetResolution: Set frame size.
void	SetCameras (unsigned int *serials, unsigned int numOfCameras)
	SetCameras: Sets serial numbers of the cameras.
void	SetFPS (FPS fps)
	SetFPS: Sets FPS.
void	SetColor (COLORFORMAT color)
	SetColor: Sets color format.
unsigned int	GetNumberOfCameras ()
	GetNumberOfCameras: returns number of cameras.
unsigned int	GetWidth ()
	GetWidth: returns frame width.
unsigned int	GetHeight ()
	GetHeight: returns frame height.
VERSION	GetVersion ()
	GetVersion: returns file version.
void	GetSerials (unsigned int *serials)
	GetSerials: stores serial numbers to a given pointer.
FPS	GetFPS ()
	GetFPS: returns FPS.
COLORFORMAT	GetColor ()
	GetColor: returns color format.
SEQUENCE_HEADER *	GetHeader ()
	GetHeader: returns file header structure.

---

Constructor & Destructor Documentation

RL_SequenceFileHeader::RL_SequenceFileHeader	(	unsigned int	nCam,
		unsigned int *	serials
	)

RL_SequenceFileHeader: Constructor for writing the header.

Parameters:

unsigned	int nCam - number of cameras
unsigned	int* serials - serial numbers for the cameras

---

Member Function Documentation

COLORFORMAT RL_SequenceFileHeader::GetColor

(

)

GetColor: returns color format.

Returns:

COLORFORMAT - color format

FPS RL_SequenceFileHeader::GetFPS

(

)

GetFPS: returns FPS.

Returns:

FPS - FPS

SEQUENCE_HEADER * RL_SequenceFileHeader::GetHeader

(

)

GetHeader: returns file header structure.

Returns:

SEQUENCE_HEADER* - file header structure

unsigned int RL_SequenceFileHeader::GetHeight

(

)

GetHeight: returns frame height.

Returns:

unsigned int - frame height

unsigned int RL_SequenceFileHeader::GetNumberOfCameras

(

)

GetNumberOfCameras: returns number of cameras.

Returns:

unsigned int - number of cameras

void RL_SequenceFileHeader::GetSerials

(

unsigned int *

serials )

GetSerials: stores serial numbers to a given pointer.

Parameters:

unsigned

int* serials - pointer to store the serial numbers

VERSION RL_SequenceFileHeader::GetVersion

(

)

GetVersion: returns file version.

Returns:

VERSION - file version

unsigned int RL_SequenceFileHeader::GetWidth

(

)

GetWidth: returns frame width.

Returns:

unsigned int - frame width

void RL_SequenceFileHeader::SetCameras	(	unsigned int *	serials,
		unsigned int	numOfCameras
	)

SetCameras: Sets serial numbers of the cameras.

Parameters:

unsigned	int* serials - camera serial numbers
unsigned	int numOfCameras - number of cameras

void RL_SequenceFileHeader::SetColor

(

COLORFORMAT

color )

SetColor: Sets color format.

Parameters:

COLORFORMAT

color - color format

void RL_SequenceFileHeader::SetFPS

(

FPS

fps )

SetFPS: Sets FPS.

Parameters:

FPS	fps - Frames per second

void RL_SequenceFileHeader::SetResolution	(	int	width,
		int	height
	)

SetResolution: Set frame size.

Parameters:

int	width - the width of the frame
int	height - the height of the frame

---

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

• RL_Reader/src/RL_SequenceFileHeader.hpp
• RL_Reader/src/RL_SequenceFileHeader.cpp