A user interface that finds all GigE Vision, USB3 Vision and Pleora Protocol devices on a network and lets the user select one.
More...
|
| PvDeviceFinderWnd () |
| Constructor.
|
|
virtual | ~PvDeviceFinderWnd () |
| Destructor.
|
|
const PvDeviceInfo * | GetSelected () |
| 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...
|
|
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...
|
|
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):
- Create a GUI-based device finder (PvDeviceFinderWnd object).
- Display the window. Use PvWnd::ShowModal or PvWnd::ShowModeless.
- Retrieve the user's selection (information about the chosen device). Use PvDeviceFinderWnd::GetSelected to retrieve a PvDeviceInfo
- Connect to the device with PvDevice::Connect using the PvDeviceInfo Not possible with Pleora Protocol devices, which can only be detected.
void PvDeviceFinderWnd::GetGEVEnabled |
( |
bool & |
aSelectable, |
|
|
bool & |
aVisible |
|
) |
| const |
Returns whether or not devices are selectable and/or visible.
- Parameters
-
[out] | aSelectable | If GigE Vision devices are selectable. |
[out] | aVisible | If 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] | aSelectable | If Pleora Protocol devices are selectable. |
[out] | aVisible | If Pleora Protocol devices are visible. |
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] | aSelectable | If USB3 Vision devices are selectable. |
[out] | aVisible | If USB3 Vision devices are visible. |
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] | aDI | The 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] | aSelectable | If GigE Vision devices are selectable. |
[in] | aVisible | If 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] | aSelectable | If Pleora Protocol devices are selectable. |
[in] | aVisible | If 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] | aSelectable | If USB3 Vision devices are selectable. |
[in] | aVisible | If USB3 Vision devices are visible. |
The documentation for this class was generated from the following files: