Low Level API#

Please use the Instant Camera classes whenever possible instead of the Low Level API.

Classes#

	Name
class	Pylon::CChunkParser Low Level API: Base class for chunk parsers returned by camera objects.
class	Pylon::GrabResult Low Level API: A grab result that combines the used image buffer and status information.
class	Pylon::EventResult Low Level API: An event result.
class	Pylon::CGrabResultImageT Low Level API: Adapts grab result to Pylon::IImage.
class	Pylon::CSharedByteBuffer Byte buffer with smart pointer semantics. Not thread safe.
class	Pylon::CStreamGrabberProxyT Low Level API: The stream grabber class with parameter access methods.
interface	Pylon::IChunkParser Low Level API: The interface for chunk parsers analyzing a data stream consisting of chunks.
interface	Pylon::ISelfReliantChunkParser Low Level API: Interface for chunk parsers with an own chunk data node map attached.
interface	Pylon::IDevice Low Level API: The interface implemented by all device objects.
interface	Pylon::IPylonDevice Low Level API: Interface for camera objects.
interface	Pylon::IEventAdapter Low Level API: IEventAdapter delivers event messages to ports.
interface	Pylon::IEventGrabber Low Level API: Interface of an object receiving asynchronous events.
interface	Pylon::IStreamGrabber Low Level API: Interface to an (input) data stream.
interface	Pylon::IPylonGigEDevice Low Level API: The interface for Basler GigE camera devices.

Types#

	Name
enum	EGrabStatus { GrabStatus_Undefined = -1, _UndefinedGrabStatus = GrabStatus_Undefined, GrabStatus_Idle, Idle = GrabStatus_Idle, GrabStatus_Queued, Queued = GrabStatus_Queued, GrabStatus_Grabbed, Grabbed = GrabStatus_Grabbed, GrabStatus_Canceled, Canceled = GrabStatus_Canceled, GrabStatus_Failed, Failed = GrabStatus_Failed} Low Level API: Possible grab status values.
typedef CGrabResultImageT< GrabResult >	CGrabResultImage Low Level API: Adapts a copy of a grab result to pylon image.

Functions#

	Name
template <class Function > DeviceCallbackHandle	RegisterRemovalCallback(IPylonDevice * pDevice, Function f) Low Level API: Register a C-function as a removal callback.
template <class Client ,class Member > DeviceCallbackHandle	RegisterRemovalCallback(IPylonDevice * pDevice, Client & c, Member m) Low Level API: Register a C++-member function as removal callback.
	CSharedByteBuffer() default constructer for shared buffer
	CSharedByteBuffer(size_t nBytes) constructer for shared buffer form buffer size
	CSharedByteBuffer(const CSharedByteBuffer & other) copy constructor
	~CSharedByteBuffer() destructor
CSharedByteBuffer &	operator=(const CSharedByteBuffer & rhs) copy assignment operator
	operator bool() const pointer like test if nullptr
void	Release() release the referenz on buffer and memory if last referenzing object.
size_t	GetSize() const return size of buffer in bytes
uint8_t *	GetBuffer() get pointer to buffer memory
const uint8_t *	GetBuffer() const get pointer to buffer memory
bool	IsNull() const test if buffer references memory

Types Documentation#

enum EGrabStatus#

Enumerator	Value	Description
GrabStatus_Undefined	-1
_UndefinedGrabStatus	GrabStatus_Undefined
GrabStatus_Idle		Currently not used.
Idle	GrabStatus_Idle	Currently not used. For backward compatibility only.
GrabStatus_Queued		Grab request is in the input queue.
Queued	GrabStatus_Queued	Grab request is in the input queue. For backward compatibility only. Consider using GrabStatus_Queued instead.
GrabStatus_Grabbed		Grab request terminated successfully. Buffer is filled with data.
Grabbed	GrabStatus_Grabbed	Grab request terminated successfully. Buffer is filled with data. For backward compatibility only. Consider using GrabStatus_Grabbed instead.
GrabStatus_Canceled		Grab request was canceled. Buffer doesn't contain valid data.
Canceled	GrabStatus_Canceled	Grab request was canceled. Buffer doesn't contain valid data. For backward compatibility only. Consider using GrabStatus_Canceled instead.
GrabStatus_Failed		Grab request failed. Buffer doesn't contain valid data.
Failed	GrabStatus_Failed	Grab request failed. Buffer doesn't contain valid data. For backward compatibility only. Consider using GrabStatus_Queued instead.

Low Level API: Possible grab status values.

typedef CGrabResultImage#

typedef CGrabResultImageT<GrabResult> Pylon::CGrabResultImage;

Low Level API: Adapts a copy of a grab result to pylon image.

Attention: The referenced grab result must not be destroyed and the result's buffer must not be queued for grabbing again during the lifetime of this object.

Functions Documentation#

function RegisterRemovalCallback#

template <class Function >
DeviceCallbackHandle RegisterRemovalCallback(
    IPylonDevice * pDevice,
    Function f
)

Low Level API: Register a C-function as a removal callback.

Parameters:

pDevice Pointer to the device that generates callbacks
f The function to be called

See: Pylon::IPylonDevice::RegisterRemovalCallback()

function RegisterRemovalCallback#

template <class Client ,
class Member >
DeviceCallbackHandle RegisterRemovalCallback(
    IPylonDevice * pDevice,
    Client & c,
    Member m
)

Low Level API: Register a C++-member function as removal callback.

Parameters:

pDevice Pointer to the device that generates callbacks
c The client object
m The member function to be called

See: Pylon::IPylonDevice::RegisterRemovalCallback()

function CSharedByteBuffer#

CSharedByteBuffer()

default constructer for shared buffer

function CSharedByteBuffer#

explicit CSharedByteBuffer(
    size_t nBytes
)

constructer for shared buffer form buffer size

function CSharedByteBuffer#

CSharedByteBuffer(
    const CSharedByteBuffer & other
)

copy constructor

function ~CSharedByteBuffer#

~CSharedByteBuffer()

destructor

function operator=#

CSharedByteBuffer & operator=(
    const CSharedByteBuffer & rhs
)

copy assignment operator

function operator bool#

explicit operator bool() const

pointer like test if nullptr

function Release#

void Release()

release the referenz on buffer and memory if last referenzing object.

function GetSize#

size_t GetSize() const

return size of buffer in bytes

function GetBuffer#

uint8_t * GetBuffer()

get pointer to buffer memory

Return: nullptr if buffer references no memory

function GetBuffer#

const uint8_t * GetBuffer() const

get pointer to buffer memory

Return: nullptr if buffer references no memory

function IsNull#

bool IsNull() const

test if buffer references memory