Skip to content

QuantumGate::Console

Karel Donk edited this page Jun 16, 2018 · 4 revisions

QuantumGate::Console is a class that represents the QuantumGate console. It cannot be instantiated; it exposes static member functions that can be used to configure the console and add messages to it.

The console output is disabled by default and its verbosity is set to QuantumGate::Console::Verbosity::Silent. For best performance it's recommended to disable the console when its output is not needed (e.g. in production). Use the SetOutput function to do that.

Member functions

Name Description
Constructor Private.
SetVerbosity Sets the verbosity of the console.
GetVerbosity Returns the current verbosity level of the console.
SetOutput Sets the output for the console.
AddMessage Adds a message to the console.

Nested classes

Name Description
Output This is the base class for output class definitions. All console output objects should derive from this class. By deriving from this class and implementing its interface, and passing an instance of the derived class to the console via the SetOutput function, you can customize handling and display of console messages.
DummyOutput Setting the console output to an instance of this class will discard all messages sent to the console.
TerminalOutput Setting the console output to an instance of this class will send all output to the standard output. Use this for command-line and console applications.
WindowOutput Setting the console output to an instance of this class will send all output to a separate console window. Use this for desktop applications where you want the console output in a separate window.
Clone this wiki locally