Connects a chunked buffer to a node map. More...
#include <ChunkAdapter.h>
Public Member Functions | |
| virtual void | AttachBuffer (uint8_t *pBuffer, int64_t BufferLength, AttachStatistics_t *pAttachStatistics=NULL)=0 |
| Attaches a buffer to the matching ChunkPort. | |
| void | AttachNodeMap (INodeMap *pNodeMap) |
| Attaches to a node map and retrieves the chunk ports. | |
| virtual bool | CheckBufferLayout (uint8_t *pBuffer, int64_t BufferLength)=0 |
| Checks if a buffer contains chunks in a known format. | |
| void | ClearCaches () |
| Clears the chunk caches. | |
| void | DetachBuffer () |
| Detaches a buffer. | |
| void | DetachNodeMap () |
| Detaches from the node map. | |
| void | UpdateBuffer (uint8_t *pBaseAddress) |
| Updates the base address of the buffer. | |
| virtual | ~CChunkAdapter () |
| Destructor. | |
Protected Member Functions | |
| CChunkAdapter (INodeMap *pNodeMap=NULL, int64_t MaxChunkCacheSize=-1) | |
| Serves as default constructor. | |
Protected Attributes | |
| int64_t | m_MaxChunkCacheSize |
| the maximum size of a chunk to be cached | |
| std::vector< CChunkPort * > * | m_ppChunkPorts |
| An array of attached ChunkPorts. | |
Detailed Description
Connects a chunked buffer to a node map.
Definition at line 57 of file ChunkAdapter.h.
Constructor & Destructor Documentation
| virtual GENAPI_NAMESPACE::CChunkAdapter::~CChunkAdapter | ( | ) | [virtual] |
Destructor.
| GENAPI_NAMESPACE::CChunkAdapter::CChunkAdapter | ( | INodeMap * | pNodeMap = NULL, |
| int64_t | MaxChunkCacheSize = -1 |
||
| ) | [protected] |
Serves as default constructor.
Member Function Documentation
| 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::CChunkAdapterGeneric, GENAPI_NAMESPACE::CChunkAdapterDcam, GENAPI_NAMESPACE::CChunkAdapterGEV, and GENAPI_NAMESPACE::CChunkAdapterU3V.
| void GENAPI_NAMESPACE::CChunkAdapter::AttachNodeMap | ( | INodeMap * | pNodeMap | ) |
Attaches to a node map and retrieves the chunk ports.
| 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::CChunkAdapterGeneric, GENAPI_NAMESPACE::CChunkAdapterDcam, GENAPI_NAMESPACE::CChunkAdapterGEV, and GENAPI_NAMESPACE::CChunkAdapterU3V.
Clears the chunk caches.
Detaches a buffer.
Detaches from the node map.
| void GENAPI_NAMESPACE::CChunkAdapter::UpdateBuffer | ( | uint8_t * | pBaseAddress | ) |
Updates the base address of the buffer.
Member Data Documentation
the maximum size of a chunk to be cached
0 : no caching, -1 : all caching
Definition at line 98 of file ChunkAdapter.h.
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 94 of file ChunkAdapter.h.
The documentation for this class was generated from the following file: