class Session

It maintains the State of Socket Elements and provides methods to Set/Retrieve Values/State of Socket Elements.

Public Methods

Session(string sessionId, string targetId, map<string, void*>* targetProps, string socketName, SocketElementList* elements)

Initializes all the local variables

string getSessionId()

Get the String value of sessionId.

void* getPropertyValue(string propName)

Get an Object of propertyValue for 'propName' from Target Properties.

AbstractUISocketElement* getSocketElementById(string id)

Get the AbstractUISocketElement by ElementId.

AbstractUISocketElement* getSocketElementByPath(string path)

Get the AbstractUISocketElement by ElementPath.

SocketElementList* getSocketElements()

Get the List of all AbstractUISocketElement for this session.

string getElementIdByPath(string path)

Get the element id from given element Path.

int setValue(string path, string value)

Set the value of element given in path

int addDim(string elementPath, string value)

Add the dimension given in path

map<string,string> * getValue(string path, bool includeSets)

Get the value of element given in path

string getTargetId()

Get the targetId for this session

string getSocketName()

Get the String value of SocketName.

list<list<string>*> * getIndices(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)

Removes the dimension for given Path

bool isElementExists(string elementPath)

checks whether element exists or not from given element path.

string getElementPathById(string elementId)

Get Element Path for element Id

map<string, string> * getCommandParams(string elementPath)

Returns key-value pair for param name and value for give elementpath

Documentation

It maintains the State of Socket Elements and provides methods to Set/Retrieve Values/State of Socket Elements.

Session(string sessionId, string targetId, map<string, void*>* targetProps, string socketName, SocketElementList* elements)

Initializes all the local variables

Parameters:

sessionId - a String value of sessionId
targetId - a String value of targetId
targetProps - a Map<String, void*> of Target Properties
socketName - a String value of socketName
elements - a List of AbstractUISocketElements

string getSessionId()

Get the String value of sessionId.

Returns:

a String value of sessionId

void* getPropertyValue(string propName)

Get an Object of propertyValue for 'propName' from Target Properties.

Parameters:

propName - a String value of propName

Returns:

an Object for PropertyValue

AbstractUISocketElement* getSocketElementById(string id)

Get the AbstractUISocketElement by ElementId.

Parameters:

id - a String value of elementId

Returns:

an Object of AbstractUISocketElement

AbstractUISocketElement* getSocketElementByPath(string path)

Get the AbstractUISocketElement by ElementPath.

Parameters:

path - a String value of ElementPath

Returns:

an Object of AbstractUISocketElement

SocketElementList* getSocketElements()

Get the List of all AbstractUISocketElement for this session.

Returns:

an SocketElementList Struct

string getElementIdByPath(string path)

Get the element id from given element Path.

Parameters:

path - a String value

Returns:

String Value of element Id

int setValue(string path, string value)

Set the value of element given in path

Parameters:

path - element path to be set
value - element value to be set

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

int addDim(string elementPath, string value)

Add the dimension given in path

Parameters:

elementPath - element path to be added
value - element value to be set after adding dimension

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

map<string,string> * getValue(string path, bool includeSets)

Get the value of element given in path

Parameters:

path - element path to be get
includeSets - Boolean of includeSets

Returns:

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

string getTargetId()

Get the targetId for this session

Returns:

Id of target

string getSocketName()

Get the String value of SocketName.

Returns:

a String value of socket Name

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

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

Parameters:

eltIds - list of elementids
indexNos - list of index

Returns:

map contain element identifiers and indexed values

int removeDim(string path)

Removes the dimension for given Path

Parameters:

path - String Value of element path

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

bool isElementExists(string elementPath)

checks whether element exists or not from given element path. It will search for last element in given element path. @elementPath a String Value of element path @boolean true if element exists else false

string getElementPathById(string elementId)

Get Element Path for element Id

Parameters:

elementId - a String Value of element Id

Returns:

entire element path of element.

map<string, string> * getCommandParams(string elementPath)

Returns key-value pair for param name and value for give elementpath

Parameters:

elementPath - a String Value of elementPath

Returns:

Map<String,String> containing param name and value as key value pair.

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