GwPipeComposition()

The GwPipeComposition(); rule retrieves a list of pipe compositions for a specified entity. This data is retrieved from the NCIM cache table, ncimCache.pipeComposition.

Syntax

The GwPipeComposition(); statement uses following syntax.

GwPipeComposition ( entityId or entityName);

Arguments

The following table lists the properties of the arguments of this stitcher rule.

Table 1. Arguments of GwPipeComposition()
Argument	Description	Accepts constants	Accepts variables	Accepts eval clauses
`entityId` or `entityName`	Instructs the rule to return a list of pipe compositions for this entity.	Yes	Yes	Yes

Example

The following example finds pipe compositions for a specified entity and then prints out all of the results.

int entityId = eval( int, '&NmosEntityId' );  

# Find all pipe compositions for the given entityId... 
RecordList pipeCompositions = GwPipeComposition( entityId );  

# ...and iterate through the returned results 
Record pipeCompositionRow; 
foreach ( pipeCompositions ) 
{
         pipeCompositionRow = GetInScopeRecord();
         PrintRecord( pipeCompositionRow ); 
}

Returns

This rule returns a list of records. Each record contains information about a single pipe composition, as contained in the ncimCache.pipeComposition table.

The following snippet shows an example of the results returned by this rule.

{
        ENTITYNAME='pe6-cr38.core.eu.test.lab[ Gi0/1 ]_p4-cr28.core.eu.test.lab[ 0 [ 2 ] ]';
        AGGREGATIONSEQUENCE=1;
},
{
        ENTITYNAME='p4-cr28.core.eu.test.lab[ Se0/0/1:0.202 ]_pe7-cr38.core.eu.test.lab[ Se0/0/0:0.202 ]';
        AGGREGATIONSEQUENCE=2;
}