Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



IPvSoftDeviceGEVStatistics Class Referenceabstract

Interface that is used to retrieve control channel statistics from a software-based GigE Vision Device. More...

Public Member Functions

virtual ~IPvSoftDeviceGEVStatistics ()
 Virtual destructor.
 
virtual void Reset ()=0
 Resets all counters to zero.
 
virtual uint64_t GetReadMemsReceived () const =0
 GVCP read memory (READMEM_CMD) commands received. More...
 
virtual uint64_t GetWriteMemsReceived () const =0
 GVCP write memory (WRITEMEM_CMD) commands received. More...
 
virtual uint64_t GetReadRegsReceived () const =0
 GVCP read register (READREG_CMD) commands received. More...
 
virtual uint64_t GetWriteRegsReceived () const =0
 GVCP write register (WRITEREG_CMD) commands received. More...
 
virtual uint64_t GetDiscoveriesReceived () const =0
 GVCP discovery (DISCOVERY_CMD) commands received. More...
 
virtual uint64_t GetActionCommandsReceived () const =0
 GVCP action command (ACTION_CMD) received. More...
 
virtual uint64_t GetForceIpsReceived () const =0
 GVCP force IP configuration (FORCEIP_CMD) commands received. More...
 
virtual uint64_t GetPacketResendRequestsReceived () const =0
 GVCP packet resend (PACKETRESEND_CMD) commands received. More...
 
virtual uint64_t GetPendingAcksIssued () const =0
 GVCP pending acknowledges (PENDING_ACK) issued. More...
 
virtual uint64_t GetRetriesReceived () const =0
 GVCP command retries received. More...
 
virtual uint64_t GetRetriesReceivedMax () const =0
 GVCP command retries maximum for a single command. More...
 
virtual uint64_t GetEventsIssued () const =0
 GVCP messaging channel event commands (EVENT_CMD) issued. More...
 
virtual uint64_t GetEventDatasIssued () const =0
 GVCP messaging channel event (with data) comands (EVENTDATA_CMD) issued. More...
 
virtual uint64_t GetEventRetriesIssued () const =0
 GVCP retries issued for unacknowledged messaging channel event or event data commands. More...
 
virtual uint64_t GetEventRetriesIssuedMax () const =0
 
virtual uint64_t GetSessionsOpened () const =0
 Returns the device controller session open count. More...
 
virtual uint64_t GetSessionsClosed () const =0
 Returns the device controller session close count. More...
 
virtual uint64_t GetHeartbeatFailedCount () const =0
 Returns the device controller session close on heartbeat failure count. More...
 
virtual uint64_t GetGVSPTestPacketsIssued () const =0
 Returns the number of GVSP test packets issued. More...
 

Detailed Description

Interface that is used to retrieve control channel statistics from a software-based GigE Vision Device.

Can be retrieved from a properly initialized PvSoftDeviceGEV to access the statistics provided by this interface.

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

Member Function Documentation

uint64_t IPvSoftDeviceGEVStatistics::GetActionCommandsReceived ( ) const
pure virtual

GVCP action command (ACTION_CMD) received.

Returns
Action command count.
uint64_t IPvSoftDeviceGEVStatistics::GetDiscoveriesReceived ( ) const
pure virtual

GVCP discovery (DISCOVERY_CMD) commands received.

Returns
Discovery command count.
uint64_t IPvSoftDeviceGEVStatistics::GetEventDatasIssued ( ) const
pure virtual

GVCP messaging channel event (with data) comands (EVENTDATA_CMD) issued.

Returns
Messaging channel event (with data) count.
uint64_t IPvSoftDeviceGEVStatistics::GetEventRetriesIssued ( ) const
pure virtual

GVCP retries issued for unacknowledged messaging channel event or event data commands.

Returns
Messaging channel event retries count.
uint64_t IPvSoftDeviceGEVStatistics::GetEventRetriesIssuedMax ( ) const
pure virtual
Returns
GVCP maximum retries issued for a single unacknowledged messaging channel event or event data command.
Messaging channel event retries maximum count.
uint64_t IPvSoftDeviceGEVStatistics::GetEventsIssued ( ) const
pure virtual

GVCP messaging channel event commands (EVENT_CMD) issued.

Returns
Messaging channel event count.
uint64_t IPvSoftDeviceGEVStatistics::GetForceIpsReceived ( ) const
pure virtual

GVCP force IP configuration (FORCEIP_CMD) commands received.

Returns
Force IP configuration command count.
uint64_t IPvSoftDeviceGEVStatistics::GetGVSPTestPacketsIssued ( ) const
pure virtual

Returns the number of GVSP test packets issued.

Returns
GVSP test packets count.
uint64_t IPvSoftDeviceGEVStatistics::GetHeartbeatFailedCount ( ) const
pure virtual

Returns the device controller session close on heartbeat failure count.

Returns
Session close on heartbeat failure count.
uint64_t IPvSoftDeviceGEVStatistics::GetPacketResendRequestsReceived ( ) const
pure virtual

GVCP packet resend (PACKETRESEND_CMD) commands received.

Returns
Packet resend command count.
uint64_t IPvSoftDeviceGEVStatistics::GetPendingAcksIssued ( ) const
pure virtual

GVCP pending acknowledges (PENDING_ACK) issued.

Returns
Pending acknowledges count.
uint64_t IPvSoftDeviceGEVStatistics::GetReadMemsReceived ( ) const
pure virtual

GVCP read memory (READMEM_CMD) commands received.

Returns
Read memory command count.
uint64_t IPvSoftDeviceGEVStatistics::GetReadRegsReceived ( ) const
pure virtual

GVCP read register (READREG_CMD) commands received.

Returns
Read register command count.
uint64_t IPvSoftDeviceGEVStatistics::GetRetriesReceived ( ) const
pure virtual

GVCP command retries received.

Returns
Command retries count.
uint64_t IPvSoftDeviceGEVStatistics::GetRetriesReceivedMax ( ) const
pure virtual

GVCP command retries maximum for a single command.

Returns
Command retries maximum count.
uint64_t IPvSoftDeviceGEVStatistics::GetSessionsClosed ( ) const
pure virtual

Returns the device controller session close count.

Returns
Session close count.
uint64_t IPvSoftDeviceGEVStatistics::GetSessionsOpened ( ) const
pure virtual

Returns the device controller session open count.

Returns
Session open count.
uint64_t IPvSoftDeviceGEVStatistics::GetWriteMemsReceived ( ) const
pure virtual

GVCP write memory (WRITEMEM_CMD) commands received.

Returns
Write memory command count.
uint64_t IPvSoftDeviceGEVStatistics::GetWriteRegsReceived ( ) const
pure virtual

GVCP write register (WRITEREG_CMD) commands received.

Returns
Write register command count.

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

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