Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvDeviceFinderWnd Class Reference

A user interface that finds all GigE Vision, USB3 Vision and Pleora Protocol devices on a network and lets the user select one. More...

Public Member Functions

 PvDeviceFinderWnd ()
 Constructor.
 
virtual ~PvDeviceFinderWnd ()
 Destructor.
 
const PvDeviceInfoGetSelected ()
 Get information identifying the device (PvDeviceInfo object) More...
 
virtual bool OnFound (const PvDeviceInfo *aDI)
 Override to filter-out devices from the dialog. 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...
 
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

- Protected Member Functions inherited from PvWnd
 PvWnd ()
 Constructor.
 
virtual ~PvWnd ()
 Destructor.
 

Detailed Description

A user interface that finds all GigE Vision, USB3 Vision and Pleora Protocol devices on a network and lets the user select one.

To find a device (GUI):

  1. Create a GUI-based device finder (PvDeviceFinderWnd object).
  2. Display the window. Use PvWnd::ShowModal or PvWnd::ShowModeless.
  3. Retrieve the user's selection (information about the chosen device). Use PvDeviceFinderWnd::GetSelected to retrieve a PvDeviceInfo
  4. Connect to the device with PvDevice::Connect using the PvDeviceInfo Not possible with Pleora Protocol devices, which can only be detected.

Member Function Documentation

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.
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.
const PvDeviceInfo * PvDeviceFinderWnd::GetSelected ( )

Get information identifying the device (PvDeviceInfo object)

Returns
The device's connectivity information; the device selected by the user.
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.
bool PvDeviceFinderWnd::OnFound ( const PvDeviceInfo aDI)
virtual

Override to filter-out devices from the dialog.

When the PvDeviceFinderWnd object finds a device, it 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, you can use OnFound to filter the list of devices by returning false in some cases such as if PvDeviceGEV::GetAccessType isn't a useful value, or not from the right vendor, etc.

Parameters
[in]aDIThe device that was found.
Returns
By default, OnFound always returns true. When overriding, return true if the device should be displayed; otherwise, false.
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.
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.
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-2021 Pleora Technologies Inc.
www.pleora.com