class SocketDescription

Parses the UI Socket Description file and stores all the Elements and makes Socket Document information accessible.

Public Fields

string socketNameAndPath

Returns socket local URI or global URL

Public Methods

SocketDescription(TargetDescription* sheet, IXML_Node* element, ITAListener* taListener)

Constructor.

void parseSocketElement()

Parse the <socket> Node of Target Description file(td).

string getName()

Returns the name of socket

string getSocketId()

Return 'id' attribute of <socket> Element of Target Description file.

string getCreator()

Get the String value of the <creator> Element of Socket Description File(uis)

string getContributor()

Get the String value of the <contributor> Element of Socket Description File(uis)

string getPublisher()

Get the String value of the <publisher> Element of Socket Description File(uis)

string getRights()

Get the String value of the <rights> Element of Socket Description File(uis)

string getConformsTo()

Get the String value of the <conformsTo> Element of Socket Description File(uis)

string getModified()

Get the String value of the <modified> Element of Socket Description File(uis)

bool getHidden()

Get the boolean value of the attribute 'hidden' of the Element <uiSocket> of Socket Description File(uis)

bool isHidden()

Get the boolean value of the attribute 'hidden' of the Element <uiSocket> of Socket Description File(uis)

TargetDescription* getTD()

Returns the target description (TD) Object

SocketElementList* getSocketElements()

Get List of AbstractUISocketElements by parsing Socket Description file(uis) if it is not parsed.

string getSocketFriendlyName()

Get Friendly Name for this Socket('id' attribute of <socket> Element of Target Description file).

string getSocketDescriptionUri()

Return a string value of URI that points to the location of Socket Description File(uis).

list<string> * getDynSocketElementIds()

Get list of Dynamic Socket Element id's.

bool isSocketNameExists(string elementId)

Check whether IUISocketElement specified by 'elementId' exists in this Socket Description or not.

Documentation

Parses the UI Socket Description file and stores all the Elements and makes Socket Document information accessible.

SocketDescription(TargetDescription* sheet, IXML_Node* element, ITAListener* taListener)

Constructor. Parse the <socket> Node of Target Description file(.td).

Parameters:

td - an Object of TargetDescription
element - an Object of IXML_Node

void parseSocketElement()

Parse the <socket> Node of Target Description file(td).

Parameters:

element - an Object of Element @throws TAException

string socketNameAndPath

Returns socket local URI or global URL

Returns:

the socket name and path

string getName()

Returns the name of socket

Returns:

the name of socket

string getSocketId()

Return 'id' attribute of <socket> Element of Target Description file.

Returns:

a String value of id

string getCreator()

Get the String value of the <creator> Element of Socket Description File(uis)

Returns:

a String value of the <creator> Element of Socket Description File(.uis)

string getContributor()

Get the String value of the <contributor> Element of Socket Description File(uis)

Returns:

a String value of the <contributor> Element of Socket Description File(.uis)

string getPublisher()

Get the String value of the <publisher> Element of Socket Description File(uis)

Returns:

a String value of the <publisher> Element of Socket Description File(.uis)

string getRights()

Get the String value of the <rights> Element of Socket Description File(uis)

Returns:

a String value of the <rights> Element of Socket Description File(.uis)

string getConformsTo()

Get the String value of the <conformsTo> Element of Socket Description File(uis)

Returns:

a String value of the <conformsTo> Element of Socket Description File(.uis)

string getModified()

Get the String value of the <modified> Element of Socket Description File(uis)

Returns:

a String value of the <modified> Element of Socket Description File(.uis)

bool getHidden()

Get the boolean value of the attribute 'hidden' of the Element <uiSocket> of Socket Description File(uis)

Returns:

a boolean value of the attribute 'hidden' of the Element <uiSocket> of Socket Description File(.uis)

bool isHidden()

Get the boolean value of the attribute 'hidden' of the Element <uiSocket> of Socket Description File(uis)

Returns:

a boolean value of the attribute 'hidden' of the Element <uiSocket> of Socket Description File(.uis)

TargetDescription* getTD()

Returns the target description (TD) Object

Returns:

reference to TargetDescription class

SocketElementList* getSocketElements()

Get List of AbstractUISocketElements by parsing Socket Description file(uis) if it is not parsed. Else get the clone copy of parsed IUISocketElement List.

Returns:

SocketElementList Struct

string getSocketFriendlyName()

Get Friendly Name for this Socket('id' attribute of <socket> Element of Target Description file).

Returns:

a string value of friendly name

string getSocketDescriptionUri()

Return a string value of URI that points to the location of Socket Description File(uis).

Returns:

a string value of URI that points to the location of Socket Description File(.uis).

list<string> * getDynSocketElementIds()

Get list of Dynamic Socket Element id's. In other words get the Id of the Elements which has 'includeRes' attribute value is 'true'.

Returns:

a List<string> for DynSocketElementIds

bool isSocketNameExists(string elementId)

Check whether IUISocketElement specified by 'elementId' exists in this Socket Description or not.

Parameters:

elementId - a string value of elementId

Returns:

whether IUISocketElement specified by 'elementId' exists or not.

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