class UISocketCommand

UISocketCommand is the command variant of UISocketElement.

Inheritance:

Public Fields

struct dimCmdStruct *dimCmdPtr

See AbstractUISocketElement for further details

struct cmdParamStruct*cmdParamList

See AbstractUISocketElement for further details

Public Methods

UISocketCommand()

Basic Constructor for the UISocketCommand

cmdParamStruct* cloneParamList()

void addParam(string id, UISocketCommandParam*cmdParam)

Add 'commandParam' to commandParams map.

virtual AbstractUISocketElement* clone()

It's virtual interface method which will clone calling class

Inherited from AbstractUISocketElement:

Public Fields

Session* session

list<string> dimensionList

Public Methods

string getElementId()

void setElementId(string elementId)

bool isDimensional()

void setDimensional(bool isDimensional)

SocketDescription* getSocket()

void setSocket(SocketDescription* socketDescription)

Session* getSession()

void setSession(Session* session)

bool isIncludeRes()

void setIncludeRes(bool isIncludeRes)

virtual void addSocketElement(AbstractUISocketElement*socketElement)

virtual SocketElementList* getElementIdSocketElementMap()

virtual void setElementIdSocketElementMap(SocketElementList* elementIdSocketElementMap)

virtual void parse(IXML_Node* rootElement)

Documentation

UISocketCommand is the command variant of UISocketElement. It also serves as the base class for all of the specific command types.

struct dimCmdStruct *dimCmdPtr

See AbstractUISocketElement for further details

struct cmdParamStruct*cmdParamList

See AbstractUISocketElement for further details

UISocketCommand()

Basic Constructor for the UISocketCommand

cmdParamStruct* cloneParamList()

Get Cloned copy of command Parameters.

Returns:

cmdParamStruct Structure

void addParam(string id, UISocketCommandParam*cmdParam)

Add 'commandParam' to commandParams map.

Parameters:

String - Value id of commandParam
commandParam - an Object of UISocketCommandParam

virtual AbstractUISocketElement* clone()

It's virtual interface method which will clone calling class

Returns:

Object of AbstractUISocketElement

Direct child classes:

UISocketVoidCommand
UISocketTimedCommand
UISocketBasicCommand

Author:

Parikshit Thakur & Team, Trace R&D Center

Version:

Revision: 1.0

Alphabetic index HTML hierarchy of classes or Java