Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvCameraBridgeManagerWnd Class Reference

A user interface for configuring PvCameraBridge instances of a device. More...

Public Member Functions

 PvCameraBridgeManagerWnd ()
 Constructor.
 
virtual ~PvCameraBridgeManagerWnd ()
 Destructor.
 
PvResult SetDevice (PvDevice *aDevice)
 Sets the device the bridge manager works on. More...
 
PvResult SetStream (PvStream *aStream)
 Sets the stream the bridge manager works on. More...
 
PvResult Save (PvConfigurationWriter &aWriter)
 Persists the current serial bridge manager configuration. More...
 
PvResult Load (PvConfigurationReader &aRead, PvStringList &aErrors)
 Restores a serial bridge manager configuration. More...
 
PvResult Recover ()
 Deprecated. More...
 
int GetBridgeCount () const
 Returns how many bridges are currently managed by the bridge manager. More...
 
PvDeviceSerial GetBridgePort (int aIndex)
 Returns the serial port used by one of the bridges managed by the bridge manager. More...
 
PvCameraBridgeGetBridge (int aIndex)
 Returns one of the bridges managed by the bridge manager. More...
 
bool IsPCFVisible () const
 Returns true if the Pleora Camera File option is visible and enabled. More...
 
void ShowPCF ()
 Makes the Pleora Camera File option visible and enabled in the user interface. More...
 
void HidePCF ()
 Hides and disables the Pleora Camera File option in the user interface. 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 for configuring PvCameraBridge instances of a device.

Member Function Documentation

◆ GetBridge()

PvCameraBridge * PvCameraBridgeManagerWnd::GetBridge ( int  aIndex)

Returns one of the bridges managed by the bridge manager.

Parameters
[in]aIndexZero-based index of the bridge.
Returns
Serial port used by the bridge at aIndex or NULL if aIndex if out of range.

◆ GetBridgeCount()

int PvCameraBridgeManagerWnd::GetBridgeCount ( ) const

Returns how many bridges are currently managed by the bridge manager.

Returns
Bridge count.

◆ GetBridgePort()

PvDeviceSerial PvCameraBridgeManagerWnd::GetBridgePort ( int  aIndex)

Returns the serial port used by one of the bridges managed by the bridge manager.

Parameters
[in]aIndexZero-based index of the bridge.
Returns
Serial port used by the bridge at aIndex or PvDeviceSerialInvalid if aIndex is out of range.

◆ HidePCF()

void PvCameraBridgeManagerWnd::HidePCF ( )

Hides and disables the Pleora Camera File option in the user interface.

See ShowPCF for more information.

◆ IsPCFVisible()

bool PvCameraBridgeManagerWnd::IsPCFVisible ( ) const

Returns true if the Pleora Camera File option is visible and enabled.

Returns
True if the Pleora Camera Files option is visible.

◆ Load()

PvResult PvCameraBridgeManagerWnd::Load ( PvConfigurationReader aReader,
PvStringList aErrors 
)

Restores a serial bridge manager configuration.

The load works on a best effort basis. Whatever can be restored will be restored. For everything else, error report strings are appended to the aErrors list.

The order to properties in the aPropertyList is not important.

Parameters
[in]aReaderA PvConfigurationRead object used to read the bridges configuration.
[out]aErrorsA list of errors that happened during the peristence load operation.
Returns
Includes:

◆ Recover()

PvResult PvCameraBridgeManagerWnd::Recover ( )

Deprecated.

Instead, on disconnect event use Save to store the serial bridge state. After reconnection, use Load to bring it back.

Returns
Includes:

◆ Save()

PvResult PvCameraBridgeManagerWnd::Save ( PvConfigurationWriter aWriter)

Persists the current serial bridge manager configuration.

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

Parameters
[in]aWriterA configuration object used to save the bridge manager state.
Returns
Includes:

◆ SetDevice()

PvResult PvCameraBridgeManagerWnd::SetDevice ( PvDevice aDevice)

Sets the device the bridge manager works on.

Parameters
[in]aDeviceDevice to manage the bridges/ports for.
Returns
Includes:

◆ SetStream()

PvResult PvCameraBridgeManagerWnd::SetStream ( PvStream aStream)

Sets the stream the bridge manager works on.

Parameters
[in]aStreamStream to manage the bridges/ports for.
Returns
Includes:

◆ ShowPCF()

void PvCameraBridgeManagerWnd::ShowPCF ( )

Makes the Pleora Camera File option visible and enabled in the user interface.

Saves a flag, so its safe to call before showing the dialog. If the dialog is visible, the UI is updated. If PCF is selected when called, forces the camera bridge type to None.


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

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