tpm_elemget

Up a level

tpm_elemget

Element Information Functions

Lists information about an element in a topology.

struct resbuf

*tpm_elemget(

ade_id tpm_id,

ade_id elem_id);

Returns a resbuf list of value pairs or NULL.

For each value pair in the list that is returned, the first value is an integer code for the information type, and the second value is the information. The list format depends on the element type: node, link, or polygon.

The following examples illustrate possible contents of resbuf data structures returned by tpm_elemget.

If the referenced element is a node, the contents of the resbuf could be as follows.

If the refernced element is a link, the contents of the resbuf could be as follows.

If the referenced element is a polygon, the contents of the resbuf could be as follows.

For each dotted pair in the list that is returned, the first value is an integer code for the information type, and the second value is the information. The list format depends on the element type: node, link, or polygon.

When a topology is built, it is given a set of object data fields. Their purpose is to contain the information listed in the preceding tables.

The following sample loads and then opens a network topology for read using tpm_acload() and tpm_acopen() respectively. A element id is obtained using tpm_elemid() with the topology id returned by tpm_acopen(). Tpm_elemget() is called with all required parameters. A resbuf is populated with information associated with the specified element, a portion of which is then displayed. The resbuf is then released as required.

char* pszTopoName = "NetTopo";
int returnCode = tpm_acload(pszTopoName, NULL);
int topoWriteAccess = 0;
ade_id topoId = tpm_acopen(pszTopoName, topoWriteAccess);
int elementType = 2;
long elementIndex = 1;
ade_id elementID = tpm_elemid(topoId, elementType, elementIndex);
struct resbuf* pElementInfoRb = tpm_elemget(topoId, elementID);
if (NULL != pElementInfoRb){
    struct resbuf* rb = pElementInfoRb;
    while(NULL != rb) {
        if (rb->restype == RTSHORT && (rb->resval.rint == 0)) {
            acutPrintf(
                "\nThe specified elements topology id is: %.0lf"
                , rb->rbnext->resval.rreal);
            break;
        }
        rb = rb->rbnext;
    }
}
else {
    acutPrintf(
        "\nThe specified element was not found.");
}
acutRelRb(pElementInfoRb);
tpm_acclose(topoId);
tpm_acunload(pszTopoName);