Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvDeviceU3V Class Reference

Connect, configure and control a USB3 Vision device. More...

Public Member Functions

 PvDeviceU3V ()
 Constructor.
 
virtual ~PvDeviceU3V ()
 Destructor.
 
PvResult Connect (const PvString &aInfo)
 Connect to a USB3 Vision device. More...
 
PvResult Connect (const PvDeviceInfo *aDeviceInfo)
 Connect to a USB3 Vision device. More...
 
PvString GetGUID () const
 Returns the GUID of the connected device. More...
 
- Public Member Functions inherited from PvDevice
virtual ~PvDevice ()
 Destructor.
 
PvDeviceType GetType () const
 Returns the type of the instantiated device. More...
 
PvResult Disconnect ()
 Disconnect the PvDevice object from the GigE Vision or USB3 Vision device to which it is currently connected. More...
 
PvResult StreamEnable (uint32_t aChannel=0)
 Enables streaming on the device. More...
 
PvResult StreamDisable (uint32_t aChannel=0)
 Disables streaming on the device. More...
 
bool IsConnected () const
 Test if this PvDevice is currently connected to a GigE Vision or USB3 Vision device. More...
 
bool IsPleoraPowered () const
 Test if this PvDevice is currently connected to a Pleora powered GigE Vision or USB3 Vision device. More...
 
PvResult DumpGenICamXML (const PvString &aFilename)
 Save the GigE Vision or USB3 Visio device's GenICam XML file to disk. More...
 
PvResult GetDefaultGenICamXMLFilename (PvString &aFilename)
 Returns a good default filename to use with DumpGenICamXML. More...
 
PvGenParameterArrayGetParameters ()
 Get the parameters used to control the GigE Vision or USB3 Vision device to which you are connected. More...
 
PvGenParameterArrayGetCommunicationParameters ()
 Get the parameters used to define how PvDevice connects to and communicates with the device. More...
 
PvResult ReadMemory (int64_t aAddress, unsigned char *aDestination, int64_t aByteCount)
 Reads bytes starting at a specific register address on the GigE Vision or USB3 Vision device. More...
 
PvResult WriteMemory (int64_t aAddress, const unsigned char *aSource, int64_t aByteCount)
 Writes bytes starting at a specific register address on the GigE Vision or USB3 Vision device. More...
 
PvResult WaitForMessagingChannelIdle (uint32_t aTimeout)
 Waits for the messaging channel to become idle. More...
 
PvResult RegisterEventSink (PvDeviceEventSink *aEventSink)
 Register an event sink used for callbacks. More...
 
PvResult UnregisterEventSink (PvDeviceEventSink *aEventSink)
 Unregister an event sink. More...
 
uint32_t GetHeartbeatThreadPriority () const
 Get the priority of the heartbeat thread. More...
 
PvResult SetHeartbeatThreadPriority (uint32_t aPriority)
 Set the priority of the heartbeat thread. More...
 
uint32_t GetInterruptLinkThreadPriority () const
 Get the priority of the interrupt link thread. More...
 
PvResult SetInterruptLinkThreadPriority (uint32_t aPriority)
 Set the priority of the interrupt link thread. More...
 
uint32_t GetInterruptQueueThreadPriority () const
 Get the priority of the interrupt queue thread. More...
 
PvResult SetInterruptQueueThreadPriority (uint32_t aPriority)
 Set the priority of the interrupt queue thread. More...
 
uint32_t GetPayloadSize ()
 Returns the payload size the device is currently configured to stream with. More...
 
PvResult GetUniqueID (PvString &aID)
 Returns a unique string identifier for the device. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from PvDevice
static PvDeviceCreateAndConnect (const PvDeviceInfo *aDeviceInfo, PvResult *aResult)
 Dynamically allocates a PvDevice of the right type. More...
 
static PvDeviceCreateAndConnect (const PvString &aInfo, PvResult *aResult)
 Dynamically allocates a PvDevice of the right type. More...
 
static void Free (PvDevice *aDevice)
 Frees an object allocated with CreateAndConnect. More...
 
- Protected Member Functions inherited from PvDevice
 PvDevice ()
 Constructor.
 

Detailed Description

Connect, configure and control a USB3 Vision device.

Member Function Documentation

◆ Connect() [1/2]

PvResult PvDeviceU3V::Connect ( const PvDeviceInfo aDeviceInfo)
virtual

Connect to a USB3 Vision device.

The Connect method connects to a USB3 Vision device found using a PvSystem or device finder dialog object. Only one device can be connected to at a time.

Parameters
[in]aDeviceInfoThe USB3 Vision device's connectivity information; a PvDeviceInfo object.
Returns
Includes:

Reimplemented from PvDevice.

◆ Connect() [2/2]

PvResult PvDeviceU3V::Connect ( const PvString aInfo)
virtual

Connect to a USB3 Vision device.

The Connect method connects to a USB3 Vision device found using a PvSystem or device finder dialog object. Only one device can be connected to at a time.

Parameters
[in]aInfoThe USB3 Vision device's 12 hex digit GUID.
Returns
Includes:

Reimplemented from PvDevice.

◆ GetGUID()

PvString PvDeviceU3V::GetGUID ( ) const

Returns the GUID of the connected device.

If no device is connected, an empty string is returned.

Returns
GUID of the device.

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

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