Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvGenBrowserWnd Class Reference

User interface for browsing and editing the contents of a PvGenParameterArray object. More...

Public Member Functions

 PvGenBrowserWnd ()
 Constructor.
 
virtual ~PvGenBrowserWnd ()
 Destructor.
 
void SetGenParameterArray (PvGenParameterArray *aArray)
 Assign the feature list to be controlled. More...
 
virtual bool IsParameterDisplayed (PvGenParameter *aParameter)
 Override to control which parameters are displayed, which are not. More...
 
PvResult SetVisibility (PvGenVisibility aVisibility)
 Changes visibility. More...
 
PvGenVisibility GetVisibility ()
 Returns currenty selected visibility. More...
 
PvResult SetRefreshMode (PvGenRefresh aRefreshMode)
 Changes the selected refresh mode. More...
 
PvGenRefresh GetRefreshMode ()
 Returns currenty selected refresh mode. More...
 
PvResult Save (PvPropertyList &aPropertyList)
 Persists the current browser options. More...
 
PvResult Load (PvPropertyList &aPropertyList)
 Restores a browser options. More...
 
void Refresh ()
 Refreshes the content of the browser. 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

User interface for browsing and editing the contents of a PvGenParameterArray object.

To browser a GenICam interface using a GUI:

  1. Create a PvGenBrowserWnd object.
  2. Assign the feature list to be browsed. Use SetGenParameterArray.
  3. Optionally, set the window's position and titlebar name. Use SetPosition and SetTitle.

Member Function Documentation

PvGenRefresh PvGenBrowserWnd::GetRefreshMode ( )

Returns currenty selected refresh mode.

Returns
The refresh mode currently in effect.
PvGenVisibility PvGenBrowserWnd::GetVisibility ( )

Returns currenty selected visibility.

Returns
The visibility currently in effect.
bool PvGenBrowserWnd::IsParameterDisplayed ( PvGenParameter aParameter)
virtual

Override to control which parameters are displayed, which are not.

Override the IsParameterDisplayed method to test if a parameter should be displayed or not. By default, IsParameterDisplayed always returns true.

Parameters
[in]aParameterThe parameter's ID.
Returns
By default, IsParameterDisplayed always returns true. When overriding, return true if the parameter should be displayed; otherwise, false.
PvResult PvGenBrowserWnd::Load ( PvPropertyList aPropertyList)

Restores a browser options.

The load works on a best effort basis. Whatever can be restored will be restored.

The order to properties in the aPropertyList is not important.

Parameters
[in]aPropertyListA list of pairs of names/values.
Returns
Includes:
void PvGenBrowserWnd::Refresh ( )

Refreshes the content of the browser.

When in automatic or polling time mode, the browser refreshes itself autonomously. When in manual mode, refresh operations are triggered by the refresh button of the browser or they can be triggered with this method.

This method refreshes the parameters of the browser but it is possible (and likely) that some parameter values are stored in the register cache of the parameter array.

To refresh (invalidate) the register cache, call PvGenParameterArray::InvalidateCache. This should in turn cause all the parameters of the browser to be updated.

This operation is performed in the the context of the user interface.

PvResult PvGenBrowserWnd::Save ( PvPropertyList aPropertyList)

Persists the current browser options.

This call builds a list of properties containing pairs of names/values.

Parameters
[in]aPropertyListA list of pairs of names/values.
Returns
Includes:
void PvGenBrowserWnd::SetGenParameterArray ( PvGenParameterArray aArray)

Assign the feature list to be controlled.

Parameters
[in]aArrayThe feature list to be controlled; a PvGenParameterArray object.
PvResult PvGenBrowserWnd::SetRefreshMode ( PvGenRefresh  aRefreshMode)

Changes the selected refresh mode.

Parameters
[in]aRefreshModeaVisibility New refresh mode.
Returns
Includes:
PvResult PvGenBrowserWnd::SetVisibility ( PvGenVisibility  aVisibility)

Changes visibility.

Parameters
[in]aVisibilityNew visibiliity.
Returns
Includes:

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

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