class SocketUtilities

SocketUtilities class is a Utility class which provides following functionality.

Public Methods

SocketUtilities()

Basic Constructor for SocketUtilities

static SocketUtilities* getInstance()

Return the instance for class SocketUtilities

map<string,string> * getValue(string elementPath, Session*session, bool includeSets)

Returns the value of AbstractUISocketElement specified in elementPath

int setValue(string elementPath, string value, Session*session)

Set the value for given elementPath

AbstractUISocketElement* getElement(string elementPath, Session*session)

Returns the Object AbstractUISocketElement for given elementPath

int addDim(string elementPath, Session*session)

Adds the dimension to the given elementPath

list<list<string>*> * getIndices(Session* session, list<string>*eltIds, list<string>*indexNos)

This function will return map containing pairs of element identifiers and it's requested indexed values.

int removeDim(string path, Session*session)

Removes the specific dimension

map<string,string> * getRangeValue(string path, Session*session)

Returns the Range Value for given path

bool isValidPath(string originalPath, string requestPath)

Checks if requested path is included in original path

Documentation

SocketUtilities class is a Utility class which provides following functionality. 1. Set value for given elementPath. elementPath may contain dimensional elements. 2. Get the value of AbstractUISocketElement specified in elementPath. elementPath may contain dimensional elements. 3. Add the dimension to given elementPath. elementPath may contain dimensional elements. 4. Return the AbstractUISocketElement from given elementPath.elementPath may contain dimensional elements.

SocketUtilities()

Basic Constructor for SocketUtilities

static SocketUtilities* getInstance()

Return the instance for class SocketUtilities

Returns:

SocketUtilities Object

map<string,string> * getValue(string elementPath, Session*session, bool includeSets)

Returns the value of AbstractUISocketElement specified in elementPath

Parameters:

elementPath - as String
- session as Session
includeSets - a Boolean of includeSets

Returns:

map<string,string> of key value pair of element path and element value.

int setValue(string elementPath, string value, Session*session)

Set the value for given elementPath

Parameters:

elementPath - as String
- session as Session

Returns:

integer value representing as follows 0 if successfull 1 if elementPath is invalid 2 if dimension value in elementPath is invalid 4 if UCHe is too busy and cannot perform the add action

AbstractUISocketElement* getElement(string elementPath, Session*session)

Returns the Object AbstractUISocketElement for given elementPath

Parameters:

elementPath - as String
- session as Session

Returns:

AbstractUISocketElement Object

int addDim(string elementPath, Session*session)

Adds the dimension to the given elementPath

Parameters:

elementPath - as String
- session as Session

Returns:

integer value representing as follows 0 if successfull 1 if elementPath is invalid 2 if dimension value in elementPath is invalid 3 if dimension already exists 4 if UCHe is too busy and cannot perform the add action

list<list<string>*> * getIndices(Session* session, list<string>*eltIds, list<string>*indexNos)

This function will return map containing pairs of element identifiers and it's requested indexed values.

Parameters:

list - of elementids
list - of index

Returns:

map contain element identifiers and indexed values

int removeDim(string path, Session*session)

Removes the specific dimension

Parameters:

String - Value of elementpath
Object - of Session

Returns:

integer value representing as follows 0 if successfull 1 if elementPath is invalid 2 if dimension value in elementPath is invalid 4 if UCHe is too busy and cannot perform the add action

map<string,string> * getRangeValue(string path, Session*session)

Returns the Range Value for given path

Parameters:

String - Value of element path
- Session Object

Returns:

String Values for given path and session

bool isValidPath(string originalPath, string requestPath)

Checks if requested path is included in original path

Parameters:

String - Value of originalPath
String - Value of requestPath

Returns:

true if requestPath is found in originalPath

This class has no child classes.

Author:

Parikshit Thakur & Team, Trace R&D Center

Version:

Revision: 1.0

Alphabetic index HTML hierarchy of classes or Java