API Guides > ConceptRT 3.x
BaseConsole Class Referenceabstract

Base class for console. More...

Detailed Description

Base class for console.

+ Inheritance diagram for BaseConsole:

Public Member Methods

virtual bool WaitCommandLine (TimeSpan timeout=TimeInfinite)=0
 Wait on a command line is typed. More...
 
virtual String ReadCommandLine (TimeSpan timeout=TimeInfinite)=0
 Read a command line and wait until it is typed. More...
 
- Public Member Methods inherited from BaseDataLogger
const bool & GetIsEnabled () const
 Enable the logging. More...
 
const bool & GetIsEnabled ()
 Enable the logging. More...
 
void SetIsEnabled (const bool &value)
 Enable the logging. More...
 
const bool & GetTimeStamped () const
 Enable the time stamping of the logged text. More...
 
const bool & GetTimeStamped ()
 Enable the time stamping of the logged text. More...
 
void SetTimeStamped (const bool &value)
 Enable the time stamping of the logged text. More...
 
void Write (PCChar8 text)
 Writes a text. More...
 
void WriteLine (PCChar8 text="")
 Writes a text and a new line. More...
 
void Write (ISerializable &data)
 Writes the data of an ISerializable object. More...
 
void WriteLine (ISerializable &data)
 Writes the data of an ISerializable object and a new line. More...
 
void Write (PCChar8 text, ISerializable &data)
 Writes the data of an ISerializable object. More...
 
void WriteLine (PCChar8 text, ISerializable &data)
 Writes the data of an ISerializable object and a new line. More...
 

Protected Member Functions

 BaseConsole (BaseDataLogger &logger)
 Constructor. More...
 
void PerformWrite (PCChar8 text, ISerializable *data, bool newLine, bool timeStamp)
 Perform to write the logged message. More...
 
- Protected Member Functions inherited from BaseDataLogger
void LockedPerformWrite (PCChar8 text, ISerializable *data, bool newLine, bool timeStamp)
 Perform to write the logged message in a locked context. More...
 

Additional Inherited Members

- Protected Attributes inherited from BaseDataLogger
CriticalSection _criticalSection
 _criticalSection used to synchronize the writter with inner traitement mechanisms when needed. More...
 

Constructor & Destructor Documentation

BaseConsole ( BaseDataLogger logger)
protected

Constructor.

Parameters
loggerthe logger to write the console outputs.

Methods Documentation

void PerformWrite ( PCChar8  text,
ISerializable data,
bool  newLine,
bool  timeStamp 
)
protectedvirtual

Perform to write the logged message.

Parameters
textA text written before the data. (Can be NULL)
datathe data. (Can be NULL)
newLineWrite a new line at the end.
timeStampWrite a time stamp at the beginning

This method implement the writing mechanism to the destination.

Implements BaseDataLogger.

virtual String ReadCommandLine ( TimeSpan  timeout = TimeInfinite)
pure virtual

Read a command line and wait until it is typed.

Parameters
timeout(optional) the time out. Default value is TimeInfinite.
Returns
the command line or "" if timeout occurs.

Implemented in BaseDynamicInvocationConsole.

virtual bool WaitCommandLine ( TimeSpan  timeout = TimeInfinite)
pure virtual

Wait on a command line is typed.

Parameters
timeout(optional) the time out. Default value is TimeInfinite.
Returns
true if command line written, false if timeout occurs.

Implemented in BaseDynamicInvocationConsole.