All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GenApi::CChunkAdapter Class Referenceabstract

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

#include <GenApi/ChunkAdapter.h>

Inheritance diagram for GenApi::CChunkAdapter:
Inheritance graph
[legend]

Public Member Functions

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

Protected Member Functions

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

Protected Attributes

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

Detailed Description

Connects a chunked buffer to a node map.

Member Function Documentation

virtual void GenApi::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::CChunkAdapterGEV.

virtual bool GenApi::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::CChunkAdapterGEV.

Member Data Documentation

int64_t GenApi::CChunkAdapter::m_MaxChunkCacheSize
protected

the maximum size of a chunk to be cached

0 : no caching, -1 : all caching

std::vector<CChunkPort*>* GenApi::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)


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

pylon 5.0.9
Copyright © 2006-2017 Basler AG (Tue May 30 2017 17:24:58)