Public Member Functions | List of all members
ICommandShell Interface Referenceabstract

Command Shell that accepts commands and perform actions. More...

#include <lmcore.h>

Inherits IObject.

Public Member Functions

virtual ResultCode RegisterHost (ICommandHost *pHost)=0
 Register a command host with the command interpreter. More...
 
virtual ResultCode UnregisterHost (ICommandHost *pHost)=0
 Unregister a command host with the command interpreter. More...
 
virtual ResultCode ExecuteCommand (const c8 *command)=0
 accept a command and delegates it to appropriate objects More...
 
- Public Member Functions inherited from IObject
virtual u32 Grab ()=0
 Increments the reference count of the object by one. More...
 
virtual u32 Drop ()=0
 Decrements the reference count of the object by one. More...
 
virtual u32 GetRefCount ()=0
 Get the reference count of the object. More...
 
virtual ResultCode QueryData (u32 dataId, Variant &data)=0
 Query an information from the object. More...
 
virtual void SetName (const c8 *objName)=0
 Set a friendly/user defined name of this object. More...
 
virtual const c8 * GetName ()=0
 Returns the user defined/friendly name of this object. More...
 
virtual const c8 * GetId ()=0
 Get the unique id of this object. More...
 
virtual void SetId (const c8 *objId)=0
 Set an Id for the object. More...
 
virtual const TypeId & GetType ()=0
 Returns the type id of the object. More...
 

Detailed Description

Command Shell that accepts commands and perform actions.

The command shell holds a collection of command hosts objects When the command shell receives a command, it delegates them to the appropritate host objects it contains.

Member Function Documentation

◆ ExecuteCommand()

virtual ResultCode ICommandShell::ExecuteCommand ( const c8 *  command)
pure virtual

accept a command and delegates it to appropriate objects

◆ RegisterHost()

virtual ResultCode ICommandShell::RegisterHost ( ICommandHost pHost)
pure virtual

Register a command host with the command interpreter.

◆ UnregisterHost()

virtual ResultCode ICommandShell::UnregisterHost ( ICommandHost pHost)
pure virtual

Unregister a command host with the command interpreter.