Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



Loading...
Searching...
No Matches
Public Member Functions | List of all members
PvSerialTerminalWnd Class Reference

GUI-based terminal interface to a Pleora Video Interface serial port. More...

Public Member Functions

 PvSerialTerminalWnd ()
 Constructor.
 
virtual ~PvSerialTerminalWnd ()
 Destructor.
 
PvResult SetDevice (IPvDeviceAdapter *aDevice)
 Assigns the device through which the serial port is accessed.
 
PvResult SetSerialPort (PvDeviceSerial aPort)
 Assigns a specific serial port to the terminal window.
 
PvDeviceSerial GetSerialPort () const
 Returns the serial port currently assigned to the terminal window.
 
- 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.
 
void GetPosition (int32_t &aPosX, int32_t &aPosY, int32_t &aSizeX, int32_t &aSizeY)
 Get the window's position and size.
 
PvResult ShowModal ()
 Display the window (modal).
 
PvResult ShowModal (QWidget *aParentHwnd)
 Display the window (modal).
 
PvResult Create (QWidget *aHwnd)
 Display the window (embedded in your program's window).
 
PvResult ShowModeless ()
 Display the window (non-modal).
 
PvResult ShowModeless (QWidget *aParentHwnd)
 Display the window (non-modal).
 
QWidget * GetQWidget ()
 Get the display controller's (PvWnd object) handle.
 
PvString GetTitle () const
 Get the window's title.
 
void SetTitle (const PvString &aTitle)
 Set the window's title.
 
PvResult Close ()
 Close the window.
 

Additional Inherited Members

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

Detailed Description

GUI-based terminal interface to a Pleora Video Interface serial port.

PvSerialTerminalWnd presents a GUI to the user allowing serial communication through a Pleora Video Interface.

Use of the PvSerialTerminalWnd class to directly access the camera head will interfere with the synchronization between the Pleora Video Interface and the camera head. It is recommended to avoid accessing Pleora Video Interface features linked to the camera head while using the PvSerialTerminalWnd class to interact with the camera head.

How to use this class

To use a this class as a modal dialog:

  1. Connect to a device using any of the PvDevice::Connect methods.
  2. Instantiate a PvSerialTerminalWnd object.
  3. Use SetDevice to bind the serial port to a specific device.
  4. Use ShowModal to create the modal dialog.

To use a this class as a modeless dialog:

  1. Connect to a device using any of the PvDevice::Connect methods.
  2. Instantiate a PvSerialTerminalWnd object.
  3. Use SetDevice to bind the serial port to a specific device.
  4. Use ShowModeless to create the modeless dialog.

Member Function Documentation

◆ GetSerialPort()

PvDeviceSerial PvSerialTerminalWnd::GetSerialPort ( ) const

Returns the serial port currently assigned to the terminal window.

Return values
Serialport currently used by the dialog.
See also
SetSerialPort

◆ SetDevice()

PvResult PvSerialTerminalWnd::SetDevice ( IPvDeviceAdapter *  aDevice)

Assigns the device through which the serial port is accessed.

Parameters
[in]aDevicePointer to a PvDevice object. The device must be connected prior to opening a serial port.
Return values
Includes

◆ SetSerialPort()

PvResult PvSerialTerminalWnd::SetSerialPort ( PvDeviceSerial  aPort)

Assigns a specific serial port to the terminal window.

Parameters
[in]aPortPvDeviceSerial enumeration value representing the device's serial port to use.
Return values
Includes
The documentation for this class was generated from the following files:

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