hdbIsIterInst

hdbIsIterInst(
t_instName 
[ t_nameSpace ]
)
=> (t_baseInstName t_leftIndex t_rightIndex) / nil

Description

Determines whether an instance name is of an iterated instance. If it is of an iterated instance, the base instance name and range indexes are returned.

Arguments

t_instName	The instName for the instance.
t_nameSpace	The name space you want to use for library/cell/view and instance names when using the Hierarchy Editor interface.

Value Returned

t_baseInstName	The base part of the iterated instance name. For example, if the iterated instance name is I1<0:3>, the base instance name is I1.
x_leftRangeIndex	The left range index of the iterated instance.
x_rightRangeIndex	The right range index of the iterated instance.
nil	The instance name is not an iterated instance name.

Example

Determines whether an instance name is of a scalar instance or of an iterated instance and retrieves information about the iterated instance from its instance name.

iterInstInfo = hdbIsIterInst(instName)
if( null(iterInstInfo) 
then
    printf("%s is a scalar instance\n" instName)
else
    baseInstName = car(iterInstInfo)
    left = cadr(iterInstInfo)
    right = caddr(iterInstInfo)
    printf("%s is an iterated instance with range %x : %x\n" 
      baseInstName left right)

)

Related Topics

Hierarchy Database Functions

Occurrence Property Functions

Parent/Child Database Functions

Return to top