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
Pylon::CChunkParser Class Referenceabstract

Low Level API: Base class for chunk parsers returned by camera objects. More...

#include <pylon/ChunkParser.h>

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

Public Member Functions

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

Protected Member Functions

 CChunkParser (GenApi::CChunkAdapter *pParser)
 default constructor - make it protected to prevent this class from instantiation
 
virtual ~CChunkParser ()
 destructor
 

Protected Attributes

GenApi::CChunkAdapterm_pParser
 Pointer to the GenApi workhorse.
 

Detailed Description

Low Level API: Base class for chunk parsers returned by camera objects.

Part implementation of chunk parser of common functionality.

Member Function Documentation

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

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

Implements Pylon::IChunkParser.

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

Checks CRC sum of buffer.

Returns
true if the contained CRC equals the computed value.
void Pylon::CChunkParser::Destroy ( )
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.

Implements Pylon::ISelfReliantChunkParser.

void Pylon::CChunkParser::DetachBuffer ( )
virtual

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.

Implements Pylon::IChunkParser.

GenApi::INodeMap* Pylon::CChunkParser::GetChunkDataNodeMap ( )
virtual

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

Returns
The chunk data node map of the parser

Implements Pylon::ISelfReliantChunkParser.

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

Checks if buffer has a CRC attached.

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

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

Implements Pylon::IChunkParser.


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)