C# Class Universe.Framework.ConsoleFramework.CommandConsole

A console that processes commands internally
Inheritance: ICommandConsole, IDisposable
Afficher le fichier Open project: Virtual-Universe/Virtual-Universe

Méthodes publiques

Свойство Type Description
m_Commands Commands
m_ConsoleScenes List
m_consoleScene IScene
m_isPrompting bool
m_lastSetPromptOption int
m_promptOptions List

Protected Properties

Свойство Type Description
m_defaultPrompt string
m_logDate DateTime
m_logFile TextWriter
m_logName string
m_logPath string

Méthodes publiques

Méthode Description
CleanInfo ( object message ) : void
CleanInfoFormat ( string format ) : void
CompareLogLevels ( string a, string b ) : bool
Debug ( object message ) : void
DebugFormat ( string format ) : void
Dispose ( ) : void
Error ( object message ) : void
ErrorFormat ( string format ) : void
Fatal ( object message ) : void
FatalFormat ( string format ) : void
Format ( Level level, string format ) : void
FormatNoTime ( Level level, string format ) : void
Help ( IScene scene, string cmd ) : void
Info ( object message ) : void
InfoFormat ( string format ) : void
Initialize ( IConfigSource source, ISimulationBase simBase ) : void
LockOutput ( ) : void
Log ( Level level, object message ) : void
Output ( string text, Level level ) : void
OutputNoTime ( string text, Level level ) : void
PasswordPrompt ( string p ) : string
Prompt ( string prompt ) : string
Prompt ( string prompt, string defaultResponse ) : string
Prompt ( string prompt, string defaultResponse, List excludedCharacters ) : string
Prompt ( string prompt, string defaultresponse, List options ) : string
Prompt ( string prompt, string defaultresponse, List options, List excludedCharacters ) : string
Prompt ( ) : void

Display a command prompt on the console and wait for user input
ReadConsole ( ) : void

Starts the prompt for the console. This will never stop until the region is closed.
ReadLine ( string p, bool isCommand, bool e ) : string
RunCommand ( string cmd ) : void
Ticker ( ) : void
Ticker ( string message, bool newline ) : void
Trace ( object message ) : void
TraceFormat ( string format ) : void
UnlockOutput ( ) : void
Warn ( object message ) : void
WarnFormat ( string format ) : void

Méthodes protégées

Méthode Description
InitializeLog ( string logPath, string logName, ISimulationBase simbase ) : void
OpenLog ( ) : void
RotateLog ( ) : void

Private Methods

Méthode Description
InternalPrompt ( string prompt, string defaultresponse, List options ) : string

Method Details

CleanInfo() public méthode

public CleanInfo ( object message ) : void
message object
Résultat void

CleanInfoFormat() public méthode

public CleanInfoFormat ( string format ) : void
format string
Résultat void

CompareLogLevels() public méthode

public CompareLogLevels ( string a, string b ) : bool
a string
b string
Résultat bool

Debug() public méthode

public Debug ( object message ) : void
message object
Résultat void

DebugFormat() public méthode

public DebugFormat ( string format ) : void
format string
Résultat void

Dispose() public méthode

public Dispose ( ) : void
Résultat void

Error() public méthode

public Error ( object message ) : void
message object
Résultat void

ErrorFormat() public méthode

public ErrorFormat ( string format ) : void
format string
Résultat void

Fatal() public méthode

public Fatal ( object message ) : void
message object
Résultat void

FatalFormat() public méthode

public FatalFormat ( string format ) : void
format string
Résultat void

Format() public méthode

public Format ( Level level, string format ) : void
level Level
format string
Résultat void

FormatNoTime() public méthode

public FormatNoTime ( Level level, string format ) : void
level Level
format string
Résultat void

Help() public méthode

public Help ( IScene scene, string cmd ) : void
scene IScene
cmd string
Résultat void

Info() public méthode

public Info ( object message ) : void
message object
Résultat void

InfoFormat() public méthode

public InfoFormat ( string format ) : void
format string
Résultat void

Initialize() public méthode

public Initialize ( IConfigSource source, ISimulationBase simBase ) : void
source IConfigSource
simBase ISimulationBase
Résultat void

InitializeLog() protected méthode

protected InitializeLog ( string logPath, string logName, ISimulationBase simbase ) : void
logPath string
logName string
simbase ISimulationBase
Résultat void

LockOutput() public méthode

public LockOutput ( ) : void
Résultat void

Log() public méthode

public Log ( Level level, object message ) : void
level Level
message object
Résultat void

OpenLog() protected méthode

protected OpenLog ( ) : void
Résultat void

Output() public méthode

public Output ( string text, Level level ) : void
text string
level Level
Résultat void

OutputNoTime() public méthode

public OutputNoTime ( string text, Level level ) : void
text string
level Level
Résultat void

PasswordPrompt() public méthode

public PasswordPrompt ( string p ) : string
p string
Résultat string

Prompt() public méthode

public Prompt ( string prompt ) : string
prompt string
Résultat string

Prompt() public méthode

public Prompt ( string prompt, string defaultResponse ) : string
prompt string
defaultResponse string
Résultat string

Prompt() public méthode

public Prompt ( string prompt, string defaultResponse, List excludedCharacters ) : string
prompt string
defaultResponse string
excludedCharacters List
Résultat string

Prompt() public méthode

public Prompt ( string prompt, string defaultresponse, List options ) : string
prompt string
defaultresponse string
options List
Résultat string

Prompt() public méthode

public Prompt ( string prompt, string defaultresponse, List options, List excludedCharacters ) : string
prompt string
defaultresponse string
options List
excludedCharacters List
Résultat string

Prompt() public méthode

Display a command prompt on the console and wait for user input
public Prompt ( ) : void
Résultat void

ReadConsole() public méthode

Starts the prompt for the console. This will never stop until the region is closed.
public ReadConsole ( ) : void
Résultat void

ReadLine() public méthode

public ReadLine ( string p, bool isCommand, bool e ) : string
p string
isCommand bool
e bool
Résultat string

RotateLog() protected méthode

protected RotateLog ( ) : void
Résultat void

RunCommand() public méthode

public RunCommand ( string cmd ) : void
cmd string
Résultat void

Ticker() public méthode

public Ticker ( ) : void
Résultat void

Ticker() public méthode

public Ticker ( string message, bool newline ) : void
message string
newline bool
Résultat void

Trace() public méthode

public Trace ( object message ) : void
message object
Résultat void

TraceFormat() public méthode

public TraceFormat ( string format ) : void
format string
Résultat void

UnlockOutput() public méthode

public UnlockOutput ( ) : void
Résultat void

Warn() public méthode

public Warn ( object message ) : void
message object
Résultat void

WarnFormat() public méthode

public WarnFormat ( string format ) : void
format string
Résultat void

Property Details

m_Commands public_oe property

public Commands m_Commands
Résultat Commands

m_ConsoleScenes public_oe property

public List m_ConsoleScenes
Résultat List

m_consoleScene public_oe property

public IScene m_consoleScene
Résultat IScene

m_defaultPrompt protected_oe property

protected string m_defaultPrompt
Résultat string

m_isPrompting public_oe property

public bool m_isPrompting
Résultat bool

m_lastSetPromptOption public_oe property

public int m_lastSetPromptOption
Résultat int

m_logDate protected_oe property

protected DateTime m_logDate
Résultat DateTime

m_logFile protected_oe property

protected TextWriter m_logFile
Résultat TextWriter

m_logName protected_oe property

protected string m_logName
Résultat string

m_logPath protected_oe property

protected string m_logPath
Résultat string

m_promptOptions public_oe property

public List m_promptOptions
Résultat List