makArchives::DtVideoStreamRecord Class Reference

Record of a collection of sensor definitions. More...

Public Types
typedef std::vector < DtImageTaskRecord >	ImageTaskRecords
	List of image task records.

Public Member Functions
	DtVideoStreamRecord ()
	CTOR.
	DtVideoStreamRecord (const DtVideoStreamRecord &obj)
	Copy CTOR.
DtVideoStreamRecord &	operator= (const DtVideoStreamRecord &rhs)
	Assignment operator.
	~DtVideoStreamRecord ()
	Virtual DTOR.
const std::string &	windowName () const
	Get the window name that the streamed channel belongs to.
void	setWindowName (const std::string &windowName)
	Set the window name that the streamed channel belongs to.
const std::string &	channelName () const
	Get the name of the channel to be streamed to video.
void	setChannelName (const std::string &channelName)
	Set the name of the channel to be streamed to video.
bool	autoStart () const
void	setAutoStart (bool autoStart)
int	frameRate () const
	Get the frame rate the video should be streamed at.
void	setFrameRate (int frameRate)
	Set the frame rate the video should be streamed at.
const std::string &	dataType () const
	Get the datatype to use.
void	setDataType (const std::string &dataType)
	Set the datatype, e.g. "ubyte".
const std::string &	pixelFormat () const
	Get the pixel format.
void	setPixelFormat (const std::string &pixelFormat)
	Set the pixel format, e.g. "BGRA".
int	numBuffers () const
	Get the number of buffers to use.
void	setNumBuffers (int numBuffers)
	Set the number of buffers to use.
const std::string &	readBuffer () const
	Get the type of read buffer to use.
void	setReadBuffer (const std::string &readBuffer)
	Set the type of read buffer to use, e.g. "back".
const DtMetadataPublisherRecord &	metadataPublisher () const
	Get the metadata publisher record.
void	setMetadataPublisher (const DtMetadataPublisherRecord &metadataPublisher)
	Set the metadata publisher record.
void	setImageTasks (const ImageTaskRecords &recs)
	Set the image task records in the collection.
void	addImageTask (const DtImageTaskRecord &imageTask)
	Add an image task to the end of the task chain.
void	removeImageTask (const DtImageTaskRecord &imageTask)
	Remove an image task from the task chain.
void	clearImageTasks ()
	Clear the image task chain.
const ImageTaskRecords &	imageTasks () const
	Get the image task records in the collection.
ImageTaskRecords &	imageTasks ()
	Get the (non-const) image task records in the collection.

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Protected Attributes
std::string	myWindowName
std::string	myChannelName
int	myFrameRate
std::string	myDataType
std::string	myPixelFormat
int	myNumBuffers
std::string	myReadBuffer
DtMetadataPublisherRecord	myMetadataPublisherRecord
ImageTaskRecords	myImageTaskRecords
bool	myAutoStart

Friends
class	boost::serialization::access

Detailed Description

Record of a collection of sensor definitions.

Member Typedef Documentation

typedef std::vector<DtImageTaskRecord> makArchives::DtVideoStreamRecord::ImageTaskRecords

List of image task records.

Constructor & Destructor Documentation

makArchives::DtVideoStreamRecord::DtVideoStreamRecord

(

)

CTOR.

makArchives::DtVideoStreamRecord::DtVideoStreamRecord

(

const DtVideoStreamRecord &

obj

)

Copy CTOR.

makArchives::DtVideoStreamRecord::~DtVideoStreamRecord

(

)

Virtual DTOR.

Member Function Documentation

DtVideoStreamRecord& makArchives::DtVideoStreamRecord::operator=

(

const DtVideoStreamRecord &

rhs

)

Assignment operator.

const std::string& makArchives::DtVideoStreamRecord::windowName

(

)

const

Get the window name that the streamed channel belongs to.

void makArchives::DtVideoStreamRecord::setWindowName

(

const std::string &

windowName

)

Set the window name that the streamed channel belongs to.

const std::string& makArchives::DtVideoStreamRecord::channelName

(

)

const

Get the name of the channel to be streamed to video.

void makArchives::DtVideoStreamRecord::setChannelName

(

const std::string &

channelName

)

Set the name of the channel to be streamed to video.

bool makArchives::DtVideoStreamRecord::autoStart

(

)

const

void makArchives::DtVideoStreamRecord::setAutoStart

(

bool

autoStart

)

int makArchives::DtVideoStreamRecord::frameRate

(

)

const

Get the frame rate the video should be streamed at.

void makArchives::DtVideoStreamRecord::setFrameRate

(

int

frameRate

)

Set the frame rate the video should be streamed at.

const std::string& makArchives::DtVideoStreamRecord::dataType

(

)

const

Get the datatype to use.

void makArchives::DtVideoStreamRecord::setDataType

(

const std::string &

dataType

)

Set the datatype, e.g. "ubyte".

const std::string& makArchives::DtVideoStreamRecord::pixelFormat

(

)

const

Get the pixel format.

void makArchives::DtVideoStreamRecord::setPixelFormat

(

const std::string &

pixelFormat

)

Set the pixel format, e.g. "BGRA".

int makArchives::DtVideoStreamRecord::numBuffers

(

)

const

Get the number of buffers to use.

void makArchives::DtVideoStreamRecord::setNumBuffers

(

int

numBuffers

)

Set the number of buffers to use.

const std::string& makArchives::DtVideoStreamRecord::readBuffer

(

)

const

Get the type of read buffer to use.

void makArchives::DtVideoStreamRecord::setReadBuffer

(

const std::string &

readBuffer

)

Set the type of read buffer to use, e.g. "back".

const DtMetadataPublisherRecord& makArchives::DtVideoStreamRecord::metadataPublisher

(

)

const

Get the metadata publisher record.

void makArchives::DtVideoStreamRecord::setMetadataPublisher

(

const DtMetadataPublisherRecord &

metadataPublisher

)

Set the metadata publisher record.

void makArchives::DtVideoStreamRecord::setImageTasks

(

const ImageTaskRecords &

recs

)

Set the image task records in the collection.

void makArchives::DtVideoStreamRecord::addImageTask

(

const DtImageTaskRecord &

imageTask

)

Add an image task to the end of the task chain.

void makArchives::DtVideoStreamRecord::removeImageTask

(

const DtImageTaskRecord &

imageTask

)

Remove an image task from the task chain.

void makArchives::DtVideoStreamRecord::clearImageTasks

(

)

Clear the image task chain.

const ImageTaskRecords& makArchives::DtVideoStreamRecord::imageTasks

(

)

const

Get the image task records in the collection.

ImageTaskRecords& makArchives::DtVideoStreamRecord::imageTasks

(

)

Get the (non-const) image task records in the collection.

template<class Archive >

void makArchives::DtVideoStreamRecord::serialize ( Archive &  ar, const unsigned int  version  )

inlineprotected

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Member Data Documentation

std::string makArchives::DtVideoStreamRecord::myWindowName

protected

std::string makArchives::DtVideoStreamRecord::myChannelName

protected

int makArchives::DtVideoStreamRecord::myFrameRate

protected

std::string makArchives::DtVideoStreamRecord::myDataType

protected

std::string makArchives::DtVideoStreamRecord::myPixelFormat

protected

int makArchives::DtVideoStreamRecord::myNumBuffers

protected

std::string makArchives::DtVideoStreamRecord::myReadBuffer

protected

DtMetadataPublisherRecord makArchives::DtVideoStreamRecord::myMetadataPublisherRecord

protected

ImageTaskRecords makArchives::DtVideoStreamRecord::myImageTaskRecords

protected

bool makArchives::DtVideoStreamRecord::myAutoStart

protected

---

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

• include/makArchives/DtVideoStreamRecord.h