Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



IPvMessageChannel Class Referenceabstract

Messaging channel interface of the software-based GigE Vision Device. More...

Public Member Functions

virtual ~IPvMessageChannel ()
 Destructor.
 
virtual PvResult FireEvent (uint16_t aEventID, uint64_t aBlockID=0, uint16_t aChannelIndex=0)=0
 Fires a messaging channel event. More...
 
virtual PvResult FireEvent (uint16_t aEventID, uint8_t *aData, uint32_t aDataLength, uint64_t aBlockID=0, uint16_t aChannelIndex=0)=0
 Fires a messaging channel event. More...
 
virtual bool IsOpened ()=0
 Indicates whether the messaging channel is open. More...
 

Detailed Description

Messaging channel interface of the software-based GigE Vision Device.

Can be retrieved from a properly initialized PvSoftDeviceGEV to monitor the messaging channel state and send events to the GigE Vision controller.

This class cannot be instantiated and there is no use case where you would need to implement this interface.

Member Function Documentation

PvResult IPvMessageChannel::FireEvent ( uint16_t  aEventID,
uint64_t  aBlockID = 0,
uint16_t  aChannelIndex = 0 
)
pure virtual

Fires a messaging channel event.

Sends a messaging channel event to the messaging channel destination that is currently registered. An event ID needs to be provided.

If the event is sent in the context of a streaming event, we recommend that you set the block ID and streaming channel that the event is associated to.

The default value for the block ID and channel index when an event is not associated to a streaming event is zero.

Parameters
[in]aEventIDEvent ID. Use standard event codes or a value between 0x9000 and 0xFFFF for custom events.
[in]aBlockIDBlock ID that the event is related to or zero.
[in]aChannelIndexChannel Index that the event is related to or zero.
Returns
Includes:
PvResult IPvMessageChannel::FireEvent ( uint16_t  aEventID,
uint8_t *  aData,
uint32_t  aDataLength,
uint64_t  aBlockID = 0,
uint16_t  aChannelIndex = 0 
)
pure virtual

Fires a messaging channel event.

Sends a messaging channel event with data to the messaging channel destination that is currently registered. An event ID needs to be provided.

If the event is sent in the context of a streaming event, we recommend that you set the block ID and streaming channel that the event is associated to.

The default value for the block ID and channel index when an event is not associated to a streaming event is zero.

It is possible to map event data to the GenApi interface of the PvSoftDeviceGEV. See IPvGenApiFactory::MapEvent for more information.

Parameters
[in]aEventIDEvent ID. Use standard event codes or a value between 0x9000 and 0xFFFF for custom events.
[in]aDataPointer to the data attached to the event.
[in]aDataLengthLength of the aData buffer. Must be 4 or higher and 536 or lower. Must also be divisible by 4.
[in]aBlockIDBlock ID that the event is related to or zero.
[in]aChannelIndexChannel index that the event is related to or zero.
Returns
Includes:
bool IPvMessageChannel::IsOpened ( )
pure virtual

Indicates whether the messaging channel is open.

For the messaging channel to be opened, a GigE Vision controller must be connected to the PvSoftDeviceGEV and must have set the messaging channel destination on the MCDA (0x0B10) and MCP (0x0B00) registers.

Returns
True if open.

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

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