Class QuantumConsoleProcessor

The core processor of Quantum Console handling command table generation and invocation.

Inheritance

Object

QuantumConsoleProcessor

Namespace: QFSW.QC

Assembly: QFSW.QC.dll

Syntax

public static class QuantumConsoleProcessor

Fields

loggingLevel

The logging level to use during operation of the Quantum Console Processor.

Declaration

public static LoggingLevel loggingLevel

Field Value

Type	Description
LoggingLevel

Properties

LoadedCommandCount

Declaration

public static int LoadedCommandCount { get; }

Property Value

Type	Description
Int32

TableGenerated

Declaration

public static bool TableGenerated { get; }

Property Value

Type	Description
Boolean

TableIsGenerating

Declaration

public static bool TableIsGenerating { get; }

Property Value

Type	Description
Boolean

Methods

GenerateCommandTable(Boolean, Boolean)

Generates the command table so that commands can be invoked.

Declaration

public static void GenerateCommandTable(bool deployThread = false, bool forceReload = false)

Parameters

Type	Name	Description
Boolean	deployThread	If set to true a second thread will be deployed for the table generation.
Boolean	forceReload	If set to true then the table will be cleared and generated again.

GetAllCommands()

Gets all loaded commands.

Declaration

public static IEnumerable<CommandData> GetAllCommands()

Returns

Type	Description
IEnumerable<CommandData>	All loaded commands.

GetUniqueCommands()

Gets all loaded unique commands. Unique excludes multiple overloads of the same command from appearing.

Declaration

public static IEnumerable<CommandData> GetUniqueCommands()

Returns

Type	Description
IEnumerable<CommandData>	All loaded unique commands.

InvokeCommand(String)

Invokes a command on the QuantumConsoleProcessor.

Declaration

public static object InvokeCommand(string commandString)

Parameters

Type	Name	Description
String	commandString	The command to invoke.

Returns

Type	Description
Object	Return value of the invocation.

TryAddCommand(CommandData)

Registers a new command.

Declaration

public static bool TryAddCommand(CommandData command)

Parameters

Type	Name	Description
CommandData	command	The command to register.

Returns

Type	Description
Boolean	If the addition was successful.

TryRemoveCommand(CommandData)

Removes an existing command.

Declaration

public static bool TryRemoveCommand(CommandData command)

Parameters

Type	Name	Description
CommandData	command	The command to remove.

Returns

Type	Description
Boolean	If the removal was successful.