winIDEA SDK
Loading...
Searching...
No Matches
isys::CTerminalCtrl Class Reference

This class is designed to replace the CTerminalDocController class. More...

#include <CSessionCtrl.h>

Public Member Functions

 CTerminalCtrl (SPConnectionMgr spConnectionMgr, const std::string &strConfiguration)
 Constructs a CTerminalCtrl instance with the specified configuration.
void disconnect ()
 Disconnects from the associated terminal.
std::string read ()
 Reads a string from the terminal.
void write (std::string strWrite)
 Writes a string to the terminal.

Detailed Description

This class is designed to replace the CTerminalDocController class.

It offers functionality to manage terminal interactions within a session. To obtain an instance of CTerminalCtrl, use the CSessionCtrl::get_terminal() method.

Constructor & Destructor Documentation

◆ CTerminalCtrl()

isys::CTerminalCtrl::CTerminalCtrl ( SPConnectionMgr spConnectionMgr,
const std::string & strConfiguration )

Constructs a CTerminalCtrl instance with the specified configuration.

Initializes the terminal control with the given configuration and connects it to the provided connection manager. Connects to the associated terminal.

Parameters
spConnectionMgrsmart pointer to the connection manager instance.
strConfiguration

Member Function Documentation

◆ disconnect()

void isys::CTerminalCtrl::disconnect ( )

Disconnects from the associated terminal.

Exceptions
TEXCEPTIONif disconnecting fails

◆ read()

std::string isys::CTerminalCtrl::read ( )

Reads a string from the terminal.

This method reads a string of data from the terminal. The string is read from the terminal's input buffer, and the method returns it.

Returns
std::string The string read from the terminal.
Exceptions
TEXCEPTIONif operation fails.

◆ write()

void isys::CTerminalCtrl::write ( std::string strWrite)

Writes a string to the terminal.

Parameters
strWriteThe string to be written to the terminal
Exceptions
TEXCEPTIONif operation fails.