All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Pylon::ISelfReliantChunkParser Interface Referenceabstract

Low Level API: Interface for chunk parsers with an own chunk data node map attached. More...

#include <pylon/ChunkParser.h>

Inheritance diagram for Pylon::ISelfReliantChunkParser:
Inheritance graph
[legend]

Public Member Functions

virtual GenApi::INodeMap * GetChunkDataNodeMap ()=0
 Provides access to the chunk data node map that the parser updates. More...
 
virtual void Destroy ()=0
 Makes the object to destroy itself. More...
 
virtual void AttachBuffer (const void *pBuffer, int64_t BufferLength, GenApi::AttachStatistics_t *pAttachStatistics=NULL)=0
 Pass in a buffer and let the chunk parser analyze it. More...
 
virtual void DetachBuffer ()=0
 Detaches a buffer from the chunk parser. The buffer will no longer accessed by the chunk parser. More...
 
virtual void UpdateBuffer (const void *pBaseAddress)=0
 Pass in a buffer and let the chunk parser update the camera object's parameters. More...
 
virtual bool HasCRC () const =0
 Checks if buffer has a CRC attached. More...
 
virtual bool CheckCRC () const =0
 Checks CRC sum of buffer. More...
 

Detailed Description

Low Level API: Interface for chunk parsers with an own chunk data node map attached.

This type of chunk parser updates the an own node map containing only the chunk data nodes instead of updating the devices node map. This is useful for attaching the chunk data to a grab result.

Member Function Documentation

virtual void Pylon::IChunkParser::AttachBuffer ( const void *  pBuffer,
int64_t  BufferLength,
GenApi::AttachStatistics_t pAttachStatistics = NULL 
)
pure virtualinherited

Pass in a buffer and let the chunk parser analyze it.

Corresponding parameters of the camera object reflecting the chunked data will be updated.

Parameters
pBufferPointer to the new buffer
BufferLengthSize of the new buffer in bytes
pAttachStatistics(optional) Pointer to a record taking statistic data of the analyzed buffer

Implemented in Pylon::CChunkParser.

virtual bool Pylon::IChunkParser::CheckCRC ( ) const
pure virtualinherited

Checks CRC sum of buffer.

Returns
true if the contained CRC equals the computed value.
virtual void Pylon::ISelfReliantChunkParser::Destroy ( )
pure virtual

Makes the object to destroy itself.

This is an alternative to destroying it via the IPylonDevice interface. It is used when the device has been destroyed already.

Implemented in Pylon::CChunkParser.

virtual void Pylon::IChunkParser::DetachBuffer ( )
pure virtualinherited

Detaches a buffer from the chunk parser. The buffer will no longer accessed by the chunk parser.

An attached buffer must be detached before freeing it. When attaching a new buffer, the previous one gets detached automatically.

Implemented in Pylon::CChunkParser.

virtual GenApi::INodeMap* Pylon::ISelfReliantChunkParser::GetChunkDataNodeMap ( )
pure virtual

Provides access to the chunk data node map that the parser updates.

Returns
The chunk data node map of the parser

Implemented in Pylon::CChunkParser.

virtual bool Pylon::IChunkParser::HasCRC ( ) const
pure virtualinherited

Checks if buffer has a CRC attached.

Returns
true if the buffer contains CRC value.
virtual void Pylon::IChunkParser::UpdateBuffer ( const void *  pBaseAddress)
pure virtualinherited

Pass in a buffer and let the chunk parser update the camera object's parameters.

This method can be used when the layout of the chunk data hasn't changed since a previous buffer has been attached to the chunk parser. In this case UpdateBuffer is slightly faster then AttachBuffer, because the buffer's layout is remembered.

Parameters
pBaseAddressPointer to the new buffer

Implemented in Pylon::CChunkParser.


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

pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:28)