mgIsTopologyInsideModgen

mgIsTopologyInsideModgen(
d_tpObjectId
[ d_figGroupId ]
)
=> t / nil

Description

Checks whether the specified topology object belongs to a Modgen. For example, this function can be used to identify Modgen topologies or to find all topologies that are available in the Modgen specified by the optional d_figGroupId argument.

When the figGroup ID (optional argument) is specified, then the function checks whether the specified topology object belongs to the specified Modgen (d_figGroupId). When not specified, then the function checks whether the specified topology object belongs to any Modgen.

Arguments

d_tpObjectId	A topology object ID.
d_figGroupId	A Modgen figGroup ID.

Value Returned

t	The topology object belongs to a Modgen. If d_figGroupId was specified, the topology object belongs to the specified Modgen.
nil	The topology object does not belong to a Modgen.

Example

The following example returns t if the topology is contained in the Modgen with topology pattern ID set to topo:

mgIsTopologyInsideModgen(topo)

Here, the topology pattern ID topo has been added to a Modgen and the variable mgId holds the Modgen figGroup ID. The following example will return t if the topology is contained in the specific Modgen that is represented by mgId:

mgIsTopologyInsideModgen(topo mgId)

Return to top