Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



Public Member Functions | List of all members
PvDeviceFinderWnd Class Reference

GUI-based Vision Device (GigE Vision and USB3 Vision) finder. More...

Public Member Functions

 PvDeviceFinderWnd ()
 Constructor.
 
const PvDeviceInfo * GetSelected ()
 Get the device's connectivity information (PvDeviceInfo object) More...
 
virtual bool OnFound (const PvDeviceInfo *aDI)
 Define the behavior of a user prompt (PvDeviceFinderWnd object) when it finds an device. More...
 
void GetGEVEnabled (bool &aSelectable, bool &aVisible) const
 Returns whether or not devices are selectable and/or visible. More...
 
void SetGEVEnabled (bool aSelectable, bool aVisible)
 Configures whether or not GigE Vision devices are selectable and/or visible. More...
 
void GetU3VEnabled (bool &aSelectable, bool &aVisible) const
 Returns whether or not USB3 Vision devices are selectable and/or visible. More...
 
void SetU3VEnabled (bool aSelectable, bool aVisible)
 Configures whether or not USB3 Vision devices are selectable and/or visible. More...
 
void GetPleoraProtocolEnabled (bool &aSelectable, bool &aVisible) const
 Returns whether or not Pleora Protocol devices are selectable and/or visible. More...
 
void SetPleoraProtocolEnabled (bool aSelectable, bool aVisible)
 Configures whether or not Pleora Protocol devices are selectable and/or visible. More...
 
- Public Member Functions inherited from PvWnd
void SetPosition (int32_t aPosX, int32_t aPosY, int32_t aSizeX, int32_t aSizeY)
 Set the window's position and size. More...
 
void GetPosition (int32_t &aPosX, int32_t &aPosY, int32_t &aSizeX, int32_t &aSizeY)
 Get the window's position and size. More...
 
PvResult ShowModal ()
 Display the window (modal). More...
 
PvResult ShowModal (QWidget *aParentHwnd)
 Display the window (modal). More...
 
PvResult Create (QWidget *aHwnd)
 Display the window (embedded in your program's window). More...
 
PvResult ShowModeless ()
 Display the window (non-modal). More...
 
PvResult ShowModeless (QWidget *aParentHwnd)
 Display the window (non-modal). More...
 
QWidget * GetQWidget ()
 Get the display controller's (PvWnd object) handle. More...
 
PvString GetTitle () const
 Get the window's title. More...
 
void SetTitle (const PvString &aTitle)
 Set the window's title. More...
 
PvResult Close ()
 Close the window. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from PvWnd
static void DoEvents ()
 Processes all pending events for the calling thread. More...
 
- Protected Member Functions inherited from PvWnd
 PvWnd ()
 Constructor.
 
virtual ~PvWnd ()
 Destructor.
 

Detailed Description

GUI-based Vision Device (GigE Vision and USB3 Vision) finder.

PvDeviceFinderWnd is a GUI-based object that finds all Vision Devices (GigE Vision and USB3 Vision) connected and lets the user select one.

To find a Vision Device (GigE Vision and USB3 Vision) (GUI):

  1. Create a GUI-based Vision Device (GigE Vision and USB3 Vision) finder (PvDeviceFinderWnd object).
  2. Set the window's properties. Use SetPosition and other PvWnd Set* methods.
  3. Display the window. Use ShowModalor ShowModeless.
  4. Retrieve the user's selection (information about the chosen device). Use PvDeviceFinderWnd::GetSelected.

To connect to the Vision Device (GigE Vision and USB3 Vision), see PvDevice.

Member Function Documentation

◆ GetGEVEnabled()

void PvDeviceFinderWnd::GetGEVEnabled ( bool &  aSelectable,
bool &  aVisible 
) const

Returns whether or not devices are selectable and/or visible.

Parameters
[out]aSelectableIf GigE Vision devices are selectable.
[out]aVisibleIf GigE Vision devices are visible.

◆ GetPleoraProtocolEnabled()

void PvDeviceFinderWnd::GetPleoraProtocolEnabled ( bool &  aSelectable,
bool &  aVisible 
) const

Returns whether or not Pleora Protocol devices are selectable and/or visible.

Parameters
[out]aSelectableIf Pleora Protocol devices are selectable.
[out]aVisibleIf Pleora Protocol devices are visible.

◆ GetSelected()

const PvDeviceInfo * PvDeviceFinderWnd::GetSelected ( )

Get the device's connectivity information (PvDeviceInfo object)

Return values
Thedevice's connectivity information; the device selected by the user using ShowModal.

◆ GetU3VEnabled()

void PvDeviceFinderWnd::GetU3VEnabled ( bool &  aSelectable,
bool &  aVisible 
) const

Returns whether or not USB3 Vision devices are selectable and/or visible.

Parameters
[out]aSelectableIf USB3 Vision devices are selectable.
[out]aVisibleIf USB3 Vision devices are visible.

◆ OnFound()

bool PvDeviceFinderWnd::OnFound ( const PvDeviceInfo *  aDI)
virtual

Define the behavior of a user prompt (PvDeviceFinderWnd object) when it finds an device.

When the PvDeviceFinderWnd object finds a device, it automatically calls the OnFound method. If OnFound returns true, the PvDeviceFinderWnd object adds the device to the list. The default version of OnFound method does nothing and always returns true.

However, you can override the OnFound method so that it does something or returns a value other than true. For example, when PvDeviceFinderWnd finds your desired device, you can use OnFound to connect to it immediately (using PvDevice::Connect(const PvString&,PvAccessType), without waiting for the search to complete. Similarly, you can use OnFound to filter the list of devices by returning false in some cases.

Parameters
[in]aDIThe device that was found.
Return values
True.(True if the PvDeviceFinderWnd should include the device in the list of found devices; false if the device should be omitted from the list.)

◆ SetGEVEnabled()

void PvDeviceFinderWnd::SetGEVEnabled ( bool  aSelectable,
bool  aVisible 
)

Configures whether or not GigE Vision devices are selectable and/or visible.

Must be configured before displaying the dialog.

Parameters
[in]aSelectableIf GigE Vision devices are selectable.
[in]aVisibleIf GigE Vision devices are visible.

◆ SetPleoraProtocolEnabled()

void PvDeviceFinderWnd::SetPleoraProtocolEnabled ( bool  aSelectable,
bool  aVisible 
)

Configures whether or not Pleora Protocol devices are selectable and/or visible.

Must be configured before displaying the dialog.

Parameters
[in]aSelectableIf Pleora Protocol devices are selectable.
[in]aVisibleIf Pleora Protocol devices are visible.

◆ SetU3VEnabled()

void PvDeviceFinderWnd::SetU3VEnabled ( bool  aSelectable,
bool  aVisible 
)

Configures whether or not USB3 Vision devices are selectable and/or visible.

Must be configured before displaying the dialog.

Parameters
[in]aSelectableIf USB3 Vision devices are selectable.
[in]aVisibleIf USB3 Vision devices are visible.
The documentation for this class was generated from the following files:

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