API Guides > ConceptRT 3.x
BaseDynamicInvocationConsole Class Reference

Base class for DynamicInvocationConsole. More...

Detailed Description

Base class for DynamicInvocationConsole.

+ Inheritance diagram for BaseDynamicInvocationConsole:

Public Member Methods

bool WaitCommandLine (TimeSpan timeout=TimeInfinite)
 Wait on a command line is typed. More...
 
String ReadCommandLine (TimeSpan timeout=TimeInfinite)
 Read a command line and wait until it is typed. More...
 
void Invoke (const DynamicInvocationRequest &request, DynamicInvocationResult &result)
 Invokes the object fields and methods. 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...
 

Public Attributes

EventMultiDelegateDynamic< BaseConsole & > Idle
 Event multi delegate where to branch cyclic behavior when the Console is waiting a command line. In single thread application, it can execute the dynamic invocation server for example. More...
 

Protected Member Functions

 BaseDynamicInvocationConsole (BaseDynamicInvocationDataLogger &logger)
 Constructor. More...
 
virtual void WriteCommandLine (PCChar8 commandLine)
 Write the command line More...
 
virtual void OnIdle ()
 On Idle : add behavior on idle time. More...
 
- Protected Member Functions inherited from BaseConsole
 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

Constructor.

Parameters
loggerthe logger to write the console outputs.

Methods Documentation

void Invoke ( const DynamicInvocationRequest request,
DynamicInvocationResult result 
)
virtual

Invokes the object fields and methods.

Parameters
requestThe request.
result[in,out] The result.

Dynamic Invocation on IInvocable objects enables us to have remote access on published fields and methods.

Implements IInvocable.

virtual void OnIdle ( )
inlineprotectedvirtual

On Idle : add behavior on idle time.

String ReadCommandLine ( TimeSpan  timeout = TimeInfinite)
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.

Implements BaseConsole.

bool WaitCommandLine ( TimeSpan  timeout = TimeInfinite)
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.

Implements BaseConsole.

virtual void WriteCommandLine ( PCChar8  commandLine)
protectedvirtual

Write the command line

Parameters
commandLinethe command line

Will be called through dynamic invocation mechanism.

Fields Documentation

Event multi delegate where to branch cyclic behavior when the Console is waiting a command line. In single thread application, it can execute the dynamic invocation server for example.