class documentation

class MinimalConsole(ConsoleBase):

View In Hierarchy

Plugin class to add a minimal console functionality to the CSE.

Method run Run the console. This is a blocking call that will run until the console is stopped, either by a shutdown command, interrupt, or by a shutdown of the CSE.
Method startMinimalConsole Initialize the minimal console plugin. Set the console instance in the CSE.
Class Variable cseSetConsole Injected function to set the console instance in the CSE.

Inherited from ConsoleBase:

Method doStartWithTextUI Check if the console should start with the text UI.
Method runTUI Open the text UI.
Method shutdown Shutdown the Console instance.
Method shutdownCSE Shutdown the CSE. Confirm shutdown before actually doing that.
Method stop Stop the console loop.
Class Variable textUI Injected TextUI instance.
def run(self):

Run the console. This is a blocking call that will run until the console is stopped, either by a shutdown command, interrupt, or by a shutdown of the CSE.

@start
def startMinimalConsole(self):

Initialize the minimal console plugin. Set the console instance in the CSE.

cseSetConsole: Callable[[ConsoleBase], None] =

Injected function to set the console instance in the CSE.