icl::io::pylon::ConcGrabberBuffer Class Reference

This is used for concurrent writing and reading of ConvBuffers. More...

#include <PylonUtils.h>

List of all members.

Public Member Functions
ICLIO_API	ConcGrabberBuffer ()
	Constructor creates and initializes resources.
ICLIO_API	~ConcGrabberBuffer ()
	Destructor frees allocated memory.
ICLIO_API ConvBuffers *	getNextReadBuffer ()
	returns a pointer to the most recent actualized ConvBuffers.
ICLIO_API ConvBuffers *	getNextWriteBuffer ()
	returns a pointer to the next write ConvBuffers.
ICLIO_API void	setReset ()
	mark ConvBuffers to be reset on next write-access.
ICLIO_API bool	newAvailable ()
	tells whether a new ConvBuffers is available
Private Attributes
ConvBuffers *	m_Buffers [3]
	current objects which alternately are read and written.
utils::Mutex	m_Mutex
	the Mutex is used for concurrent reading and writing.
int	m_Write
	The object currently written to.
int	m_Next
	The write object currently not written to.
int	m_Read
	The object currently read from.
bool	m_Avail
	tells whether an actualized object was written.

---

Detailed Description

This is used for concurrent writing and reading of ConvBuffers.

This class holds three pointers to ConvBuffers of which one is the currently read and the other two are alternately written to.

---

Constructor & Destructor Documentation

ICLIO_API icl::io::pylon::ConcGrabberBuffer::ConcGrabberBuffer

(

)

Constructor creates and initializes resources.

ICLIO_API icl::io::pylon::ConcGrabberBuffer::~ConcGrabberBuffer

(

)

Destructor frees allocated memory.

---

Member Function Documentation

ICLIO_API ConvBuffers* icl::io::pylon::ConcGrabberBuffer::getNextReadBuffer

(

)

returns a pointer to the most recent actualized ConvBuffers.

ConvBuffers will then be marked and not overwritten till the next call to getNextImage()

ICLIO_API ConvBuffers* icl::io::pylon::ConcGrabberBuffer::getNextWriteBuffer

(

)

returns a pointer to the next write ConvBuffers.

sets the returned ConvBuffers as current writeable and marks the old writeable as new.

ICLIO_API bool icl::io::pylon::ConcGrabberBuffer::newAvailable

(

)

tells whether a new ConvBuffers is available

ICLIO_API void icl::io::pylon::ConcGrabberBuffer::setReset

(

)

mark ConvBuffers to be reset on next write-access.

---

Member Data Documentation

bool icl::io::pylon::ConcGrabberBuffer::m_Avail [private]

tells whether an actualized object was written.

ConvBuffers* icl::io::pylon::ConcGrabberBuffer::m_Buffers[3] [private]

current objects which alternately are read and written.

utils::Mutex icl::io::pylon::ConcGrabberBuffer::m_Mutex [private]

the Mutex is used for concurrent reading and writing.

int icl::io::pylon::ConcGrabberBuffer::m_Next [private]

The write object currently not written to.

int icl::io::pylon::ConcGrabberBuffer::m_Read [private]

The object currently read from.

int icl::io::pylon::ConcGrabberBuffer::m_Write [private]

The object currently written to.

---

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

• /home/jenkins/workspace/icl-manual-trunk/icl-manual/ICLIO/src/ICLIO/PylonUtils.h