makVrv::DtSharedMemoryTaskElement Class Reference

A DtSharedMemoryTaskElement instance will create a pipeline element that can output the image being streamed to a shared memory object that it creates. More...

Inheritance diagram for makVrv::DtSharedMemoryTaskElement:

Classes
struct	DtSharedMemoryHeader
	Define the header used for the shared memory segment. More...

Public Member Functions
virtual	~DtSharedMemoryTaskElement ()
	DTOR.
virtual DtUnicode	sharedMemoryName () const
	Get the shared memory name.
virtual void	setSharedMemoryName (const DtUnicode &name)
	Set the shared memory name.
virtual int	bufferSize () const
	Get the shared memory buffer size.
virtual void	setBufferSize (int bufferSize)
	Set the shared memory buffer size.
virtual void	setFromRecord (const makArchives::DtImageTaskRecord &config)
	Initialize the shared memory task from a DtImageTaskRecord.
virtual bool	configure ()
	Configure the shared memory task (including creating the shard memory object).
Public Member Functions inherited from makVrv::DtImageTaskElement
virtual	~DtImageTaskElement ()
	DTOR.
void	preFrame ()
	Thread of execution before each frame's processing.
void	processFrame (DtVideoFrameBuffer *frame)
	Process the image.
void	postFrame ()
	Thread of execution after each frame's processing.
virtual void	attach (DtImageTaskElement *next)
	Place another Image Task element after this one.

Protected Member Functions
	DtSharedMemoryTaskElement (DtDe &de, DtProcessImageTask *owningTask)
	CTOR (protected)
void	handleProcessFrame (DtVideoFrameBuffer *frame)
	Move the frame buffer to the shared memory segment.
Protected Member Functions inherited from makVrv::DtImageTaskElement
	DtImageTaskElement (DtDe &de, DtProcessImageTask *owningTask)
	CTOR.
virtual void	handlePreFrame ()
	No-op in base class.
virtual void	handlePostFrame ()
	No-op in base class.

Protected Attributes
DtUnicode	mySharedMemoryName
int	myBufferSize
boost::interprocess::shared_memory_object *	mySharedMemoryObj
boost::interprocess::mapped_region *	myMappedRegion
DtSharedMemoryHeader *	myHeader
char *	myOffsets [3]
Protected Attributes inherited from makVrv::DtImageTaskElement
DtDe &	myDe
DtProcessImageTask *	myOwningTask
DtImageTaskElement *	myNextElement

Private Member Functions
	DtSharedMemoryTaskElement ()
	Default CTOR (unimplemented)
	DtSharedMemoryTaskElement (const DtSharedMemoryTaskElement &orig)
	Copy CTOR (unimplemented)
DtSharedMemoryTaskElement &	operator= (const DtSharedMemoryTaskElement &rhs)
	Assignment operator (unimplemented)

Friends
class	DtSharedMemoryTaskElementCreator
	Friend creator class, the only class that can construct an instance of this DtSharedMemoryTaskElement.

Detailed Description

A DtSharedMemoryTaskElement instance will create a pipeline element that can output the image being streamed to a shared memory object that it creates.

Constructor & Destructor Documentation

virtual makVrv::DtSharedMemoryTaskElement::~DtSharedMemoryTaskElement ( )

virtual

DTOR.

makVrv::DtSharedMemoryTaskElement::DtSharedMemoryTaskElement ( DtDe &  de, DtProcessImageTask *  owningTask  )

protected

CTOR (protected)

makVrv::DtSharedMemoryTaskElement::DtSharedMemoryTaskElement ( )

private

Default CTOR (unimplemented)

makVrv::DtSharedMemoryTaskElement::DtSharedMemoryTaskElement ( const DtSharedMemoryTaskElement &  orig )

private

Copy CTOR (unimplemented)

Member Function Documentation

virtual DtUnicode makVrv::DtSharedMemoryTaskElement::sharedMemoryName ( ) const

virtual

Get the shared memory name.

virtual void makVrv::DtSharedMemoryTaskElement::setSharedMemoryName ( const DtUnicode &  name )

virtual

Set the shared memory name.

virtual int makVrv::DtSharedMemoryTaskElement::bufferSize ( ) const

virtual

Get the shared memory buffer size.

virtual void makVrv::DtSharedMemoryTaskElement::setBufferSize ( int  bufferSize )

virtual

Set the shared memory buffer size.

virtual void makVrv::DtSharedMemoryTaskElement::setFromRecord ( const makArchives::DtImageTaskRecord &  config )

virtual

Initialize the shared memory task from a DtImageTaskRecord.

Reimplemented from makVrv::DtImageTaskElement.

virtual bool makVrv::DtSharedMemoryTaskElement::configure ( )

virtual

Configure the shared memory task (including creating the shard memory object).

Reimplemented from makVrv::DtImageTaskElement.

void makVrv::DtSharedMemoryTaskElement::handleProcessFrame ( DtVideoFrameBuffer *  frame )

protectedvirtual

Move the frame buffer to the shared memory segment.

Implements makVrv::DtImageTaskElement.

DtSharedMemoryTaskElement& makVrv::DtSharedMemoryTaskElement::operator= ( const DtSharedMemoryTaskElement &  rhs )

private

Assignment operator (unimplemented)

Friends And Related Function Documentation

friend class DtSharedMemoryTaskElementCreator

friend

Friend creator class, the only class that can construct an instance of this DtSharedMemoryTaskElement.

Member Data Documentation

DtUnicode makVrv::DtSharedMemoryTaskElement::mySharedMemoryName

protected

int makVrv::DtSharedMemoryTaskElement::myBufferSize

protected

boost::interprocess::shared_memory_object* makVrv::DtSharedMemoryTaskElement::mySharedMemoryObj

protected

boost::interprocess::mapped_region* makVrv::DtSharedMemoryTaskElement::myMappedRegion

protected

DtSharedMemoryHeader* makVrv::DtSharedMemoryTaskElement::myHeader

protected

char* makVrv::DtSharedMemoryTaskElement::myOffsets[3]

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvVideoStream/DtSharedMemoryTaskElement.h