getPbcActor()

Return periodic actor specified by its information.

Usage

pbcActor = vis.getPbcActor( pbcInfo )

Parameters

pbcInfo (integer) or (string): Name or ID of a periodic.

Return Value

pbcActor (object): Periodic actor corresponding to the pbcInfo.

Errors

pbcInfo should be valid.

Description

This routine returns the periodic actor specified by its name or ID which is given by pbcInfo. For example,

pbc = vis.getPbcActor( 0 )