class AbstractUISocketElement

This class is the interface used for creating UI Socket Element Objects.

Inheritance:

Public Fields

Session* session

SessionObject

list<string> dimensionList

List of the dimension which specify the type of dimension

Public Methods

AbstractUISocketElement()

Default constructor for AbstractUISocketElement

string getElementId()

Get ElementId.

void setElementId(string elementId)

Set ElementId.

bool isDimensional()

Checks whether socket Element is dimensional or not.

void setDimensional(bool isDimensional)

Set Dimensional if 'isDimensional' is true.

SocketDescription* getSocket()

Get Socket Description object.

void setSocket(SocketDescription* socketDescription)

Set the Reference Socket Description.

Session* getSession()

Get session.

void setSession(Session* session)

Set Session with specified 'session'.

bool isIncludeRes()

Get the value of 'includeRes'

void setIncludeRes(bool isIncludeRes)

Set the value of 'includeRes'

virtual AbstractUISocketElement* clone()

It's virtual interface method which prepares a Clone Copy of calling class.

virtual void addSocketElement(AbstractUISocketElement*socketElement)

It's virtual interface method which adds the given AbstractUISocketElement to the socketElementList.

virtual SocketElementList* getElementIdSocketElementMap()

It's virtual interface method which gives socketElementList containing name and Object of element.

virtual void setElementIdSocketElementMap(SocketElementList* elementIdSocketElementMap)

It's virtual interface method which adds socketElementList containing name and Object of element in List of calling class.

virtual void parse(IXML_Node* rootElement)

It's virtual interface method which parses the Element Node.

Documentation

This class is the interface used for creating UI Socket Element Objects. It provides for the common functionality all UI Socket Elements require.

Session* session

SessionObject

list<string> dimensionList

List of the dimension which specify the type of dimension

AbstractUISocketElement()

Default constructor for AbstractUISocketElement

string getElementId()

Get ElementId.

Returns:

a String

void setElementId(string elementId)

Set ElementId.

Parameters:

elementId - as String value of elementId

bool isDimensional()

Checks whether socket Element is dimensional or not.

Returns:

bool

void setDimensional(bool isDimensional)

Set Dimensional if 'isDimensional' is true.

Parameters:

- isDimensional a boolean value of isDimensional

SocketDescription* getSocket()

Get Socket Description object.

Returns:

an Object of SocketDescription

void setSocket(SocketDescription* socketDescription)

Set the Reference Socket Description.

Parameters:

socketDescription - an Object of SocketDescription

Session* getSession()

Get session.

Returns:

an Object of Session

void setSession(Session* session)

Set Session with specified 'session'.

Parameters:

- session an Object of Session

bool isIncludeRes()

Get the value of 'includeRes'

Returns:

a boolean value

void setIncludeRes(bool isIncludeRes)

Set the value of 'includeRes'

Parameters:

- isIncludeRes a boolean value

virtual AbstractUISocketElement* clone()

It's virtual interface method which prepares a Clone Copy of calling class.

Returns:

an AbstractUISocketElement Cloned Object

virtual void addSocketElement(AbstractUISocketElement*socketElement)

It's virtual interface method which adds the given AbstractUISocketElement to the socketElementList.

Parameters:

an - AbstractUISocketElement Object

virtual SocketElementList* getElementIdSocketElementMap()

It's virtual interface method which gives socketElementList containing name and Object of element.

Returns:

Link List Object SocketElementList.

virtual void setElementIdSocketElementMap(SocketElementList* elementIdSocketElementMap)

It's virtual interface method which adds socketElementList containing name and Object of element in List of calling class.

Parameters:

Link - List Object SocketElementList.

virtual void parse(IXML_Node* rootElement)

It's virtual interface method which parses the Element Node.

Parameters:

rootElement - as Element Node.

Direct child classes:

UISocketVariable
UISocketSet
UISocketNotification
UISocketCommand

Author:

Parikshit Thakur & Team, Trace R&D Center

Version:

Alphabetic index HTML hierarchy of classes or Java