class TargetDescription

Parses the Target Description file and provides access to the components contained within.

Public Methods

TargetDescription(ITAListener* taListener, string tdURI)

Constructor.

TargetDescription(ITAListener* taListener, map<string, string>* tdProp)

Constructor.

list<SocketDescription*> getSockets()

Get the sockets of this Target.

void parse()

Parse the Target Description file(td).

bool isHidden()

Get the String value of the <hidden> Element of Target Description File(td)

string getConformsTo()

Get the String value of the <conformsTo> Element of Target Description File(td)

string getCreated()

Get the String value of the <created> Element of Target Description File(td)

string getCreator()

Get the String value of the <creator> Element of Target Description File(td)

string getModified()

Get the String value of the <modified> Element of Target Description File(td)

TargetDescription()

Constructor.

string getTargetName()

Get String value of TargetName('about' attribute of <target> Element).

list<string> * getSocketNames()

Return List of Socket Names available in this Target Description.

SocketElementList* getSocketElements(string socketName)

Return List<IUISocketElement> of IUISocketElement of the Socket specified by 'socketName'.

string getSocketFriendlyName(string socketName)

Get Friendly Name of the Socket specified by 'socketName'.

string getSocketDescriptionUri(string socketName)

Get a String value of URI that points to the location of Socket Description File(uis) of the Socket specified by 'socketName'.

string getTargetDescriptionUri()

a String value of URI that points to the location of Target Description File(td).

string getSocketName(string socketId)

Get Socket Name for the SocketId specified 'socketId'.

list<string> * getDynSocketElementIds(string socketName)

Return List<String> of those ElementIds who have dynamic value.

bool isElementAvailable(string socketName, string eltId)

Check whether IUISocketElement specified by 'eltId' is Available in the Socket specified by 'socketName' or not.

string getSocketId(string socketName)

Get a String value of SocketId of the Socket specified 'socketName'.

Documentation

Parses the Target Description file and provides access to the components contained within.

TargetDescription(ITAListener* taListener, string tdURI)

Constructor. Parse the Target Description File(.td) and Store its Elements and attributes of that Element.

Parameters:

- ITAListener object
tdUri - URI value of tdUri @throws TAException

TargetDescription(ITAListener* taListener, map<string, string>* tdProp)

Constructor. Download Target Description File(.td) from Resource Server using taProps, parse it and Store its Elements and attributes of that Element.

Parameters:

taListener - an Object of ITAListener
tdProps - an Object of Map&lt;String, String&gt; of Target Description File Properties @throws TAException

list<SocketDescription*> getSockets()

Get the sockets of this Target.

Returns:

a List<SocketDescription> of Sockets

void parse()

Parse the Target Description file(td).

bool isHidden()

Get the String value of the <hidden> Element of Target Description File(td)

Returns:

a String value of the <hidden> Element of Target Description File(.td)

string getConformsTo()

Get the String value of the <conformsTo> Element of Target Description File(td)

Returns:

a String value of the <conformsTo> Element of Target Description File(.td)

string getCreated()

Get the String value of the <created> Element of Target Description File(td)

Returns:

a String value of the <created> Element of Target Description File(.td)

string getCreator()

Get the String value of the <creator> Element of Target Description File(td)

Returns:

a String value of the <creator> Element of Target Description File(.td)

string getModified()

Get the String value of the <modified> Element of Target Description File(td)

Returns:

a String value of the <modified> Element of Target Description File(.td)

TargetDescription()

Constructor. Parse the Target Description File(.td) and Store its Elements and attributes of that Element.

string getTargetName()

Get String value of TargetName('about' attribute of <target> Element).

Returns:

a String value of Target Name

list<string> * getSocketNames()

Return List of Socket Names available in this Target Description.

Returns:

List<String> value of Socket Names

SocketElementList* getSocketElements(string socketName)

Return List<IUISocketElement> of IUISocketElement of the Socket specified by 'socketName'.

Parameters:

socketName - a String value of socketName

Returns:

SocketElementList Struct

string getSocketFriendlyName(string socketName)

Get Friendly Name of the Socket specified by 'socketName'.

Parameters:

socketName - a String value of socketName

Returns:

a String value of Socket Friendly Name

string getSocketDescriptionUri(string socketName)

Get a String value of URI that points to the location of Socket Description File(uis) of the Socket specified by 'socketName'.

Parameters:

socketName - a String value of socketName

Returns:

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

string getTargetDescriptionUri()

a String value of URI that points to the location of Target Description File(td).

Returns:

URI that points to the location of Target Description File(.td).

string getSocketName(string socketId)

Get Socket Name for the SocketId specified 'socketId'.

Parameters:

socketId - a String value of socketId

Returns:

a String value of Socket Name

list<string> * getDynSocketElementIds(string socketName)

Return List<String> of those ElementIds who have dynamic value.

Parameters:

socketName - a String value of Socket Name

Returns:

a List<String> of SocketElement's ElementId

bool isElementAvailable(string socketName, string eltId)

Check whether IUISocketElement specified by 'eltId' is Available in the Socket specified by 'socketName' or not.

Parameters:

socketName - a String value of Socket Name
eltId - a String value of eltId

Returns:

whether Element is Available or not

string getSocketId(string socketName)

Get a String value of SocketId of the Socket specified 'socketName'.

Parameters:

socketName - a String value of socketName

Returns:

a String value of Socket Id

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