Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



IPvDeviceEventSink Class Referenceabstract

Interface used by a class implementing IPvDeviceAdapter to forward notifications to PvDeviceSerialPort. More...

Public Member Functions

virtual void NotifyEvent (uint16_t aEventID, uint16_t aChannel, uint64_t aBlockID, uint64_t aTimestamp, const void *aData, uint32_t aDataLength)=0
 Forwards a controller event (GigE Vision or USB3 Vision) to a registered interface. More...
 
virtual void NotifyInvalidatedGenParameter (const PvString &aParameterName)=0
 Forwards a GenICam parameter invalidation event to a registered interface. More...
 

Detailed Description

Interface used by a class implementing IPvDeviceAdapter to forward notifications to PvDeviceSerialPort.

This interface is implemented classes internal to PvDeviceSerialPort.

You need to forward GenICam invalidation events for all IPvDeviceEventSink interfaces registered using RegisterEventSink up until UnregisterEventSink is called.

Use IPvDeviceEventSink::NotifyInvalidatedGenParameter for parameters that RegisterGenInvalidator was called for. You also need to forward all messaging channel events to the PvDeviceSerialPort using IPvDeviceEventSink::NotifyEvent.

Member Function Documentation

void IPvDeviceEventSink::NotifyEvent ( uint16_t  aEventID,
uint16_t  aChannel,
uint64_t  aBlockID,
uint64_t  aTimestamp,
const void *  aData,
uint32_t  aDataLength 
)
pure virtual

Forwards a controller event (GigE Vision or USB3 Vision) to a registered interface.

Parameters
[in]aEventIDEvent ID. Some standard event IDs are defined but usually device dependent.
[in]aChannelStreaming channel associated with the event, if any. 0xFFFF is used if the event is not associated to a streaming channel.
[in]aBlockIDStreaming block ID associated with the event, if any. Can be used to pair one or more than one event with a block received from a device. 0 is used if the event is not associated to a block.
[in]aTimestampTimestamp of the event on the time domain of the device. Time unit is defined by the device. 0 if timestamps are not supported by the device that generated the event.
[in]aDataPointer to Event Data, if applicable. NULL otherwise.
[in]aDataLengthData length, in bytes.
void IPvDeviceEventSink::NotifyInvalidatedGenParameter ( const PvString aParameterName)
pure virtual

Forwards a GenICam parameter invalidation event to a registered interface.

Parameters
[in]aParameterNameName of the invalidated parameter.

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

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com