GENAPI_NAMESPACE::CChunkAdapter Class Reference

Connects a chunked buffer to a node map. More...

#include <ChunkAdapter.h>

Inheritance diagram for GENAPI_NAMESPACE::CChunkAdapter:

Public Member Functions
virtual void	AttachBuffer (uint8_t *pBuffer, int64_t BufferLength, AttachStatistics_t *pAttachStatistics=NULL)=0
	Attaches a buffer to the matching ChunkPort. More...
void	AttachNodeMap (INodeMap *pNodeMap)
	Attaches to a node map and retrieves the chunk ports. More...
virtual bool	CheckBufferLayout (uint8_t *pBuffer, int64_t BufferLength)=0
	Checks if a buffer contains chunks in a known format. More...
void	ClearCaches ()
	Clears the chunk caches. More...
void	DetachBuffer ()
	Detaches a buffer. More...
void	DetachNodeMap ()
	Detaches from the node map. More...
void	UpdateBuffer (uint8_t *pBaseAddress)
	Updates the base address of the buffer. More...
virtual	~CChunkAdapter ()
	Destructor. More...

Protected Member Functions
	CChunkAdapter (INodeMap *pNodeMap=NULL, int64_t MaxChunkCacheSize=-1)
	Serves as default constructor. More...

Protected Attributes
int64_t	m_MaxChunkCacheSize
	the maximum size of a chunk to be cached More...
std::vector< CChunkPort * > *	m_ppChunkPorts
	An array of attached ChunkPorts. More...

Private Member Functions
	CChunkAdapter (const CChunkAdapter &)
CChunkAdapter &	operator= (const CChunkAdapter &)

Detailed Description

Connects a chunked buffer to a node map.

Definition at line 57 of file ChunkAdapter.h.

Constructor & Destructor Documentation

~CChunkAdapter()

virtual GENAPI_NAMESPACE::CChunkAdapter::~CChunkAdapter ( )

virtual

Destructor.

CChunkAdapter() [1/2]

GENAPI_NAMESPACE::CChunkAdapter::CChunkAdapter ( const CChunkAdapter &  )

private

CChunkAdapter() [2/2]

GENAPI_NAMESPACE::CChunkAdapter::CChunkAdapter ( INodeMap *  pNodeMap = NULL, int64_t  MaxChunkCacheSize = -1  )

protected

Serves as default constructor.

Member Function Documentation

AttachBuffer()

virtual void GENAPI_NAMESPACE::CChunkAdapter::AttachBuffer ( uint8_t *  pBuffer, int64_t  BufferLength, AttachStatistics_t *  pAttachStatistics = NULL  )

pure virtual

Attaches a buffer to the matching ChunkPort.

Implement that for a specific buffer layout

Implemented in GENAPI_NAMESPACE::CChunkAdapterDcam, GENAPI_NAMESPACE::CChunkAdapterGeneric, GENAPI_NAMESPACE::CChunkAdapterGEV, and GENAPI_NAMESPACE::CChunkAdapterU3V.

AttachNodeMap()

void GENAPI_NAMESPACE::CChunkAdapter::AttachNodeMap

(

INodeMap *

pNodeMap

)

Attaches to a node map and retrieves the chunk ports.

CheckBufferLayout()

virtual bool GENAPI_NAMESPACE::CChunkAdapter::CheckBufferLayout ( uint8_t *  pBuffer, int64_t  BufferLength  )

pure virtual

Checks if a buffer contains chunks in a known format.

Implement that for a specific buffer layout

Implemented in GENAPI_NAMESPACE::CChunkAdapterDcam, GENAPI_NAMESPACE::CChunkAdapterGeneric, GENAPI_NAMESPACE::CChunkAdapterGEV, and GENAPI_NAMESPACE::CChunkAdapterU3V.

ClearCaches()

void GENAPI_NAMESPACE::CChunkAdapter::ClearCaches

(

)

Clears the chunk caches.

DetachBuffer()

void GENAPI_NAMESPACE::CChunkAdapter::DetachBuffer

(

)

Detaches a buffer.

DetachNodeMap()

void GENAPI_NAMESPACE::CChunkAdapter::DetachNodeMap

(

)

Detaches from the node map.

operator=()

CChunkAdapter& GENAPI_NAMESPACE::CChunkAdapter::operator= ( const CChunkAdapter &  )

private

UpdateBuffer()

void GENAPI_NAMESPACE::CChunkAdapter::UpdateBuffer

(

uint8_t *

pBaseAddress

)

Updates the base address of the buffer.

Member Data Documentation

m_MaxChunkCacheSize

int64_t GENAPI_NAMESPACE::CChunkAdapter::m_MaxChunkCacheSize

protected

the maximum size of a chunk to be cached

0 : no caching, -1 : all caching

Definition at line 101 of file ChunkAdapter.h.

m_ppChunkPorts

std::vector<CChunkPort*>* GENAPI_NAMESPACE::CChunkAdapter::m_ppChunkPorts

protected

An array of attached ChunkPorts.

Note that this must be a pointer otherwise we'll get into DLL hell (see warning C4251)

Definition at line 97 of file ChunkAdapter.h.

---

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

• ChunkAdapter.h