Question

vpi_close()
Synopsis: Close the database if open.
Syntax: vpi_close(PLI_INT32 tool, vpiType prop, PLI_BYTE8* name)
Returns: PLI_INT32, 1 for success, 0 for fail.
Arguments:
    PLI_INT32 tool: 0 for the reader.
    vpiType prop:
        vpiAccessPostProcess: Access data stored in specified database.
        vpiAccessInteractive: Access data interactively, database is the flush area.
        Tool shall keep value history up to the current time.
    PLI_BYTE8* name: Name of the database. This can be the logical name of a database
    or the actual name of the data file depending on the tool implementation.
Related routines: None.

vpi_load_init()
    Synopsis: Initialize the load access to scope and/or collection of objects.
    Syntax: vpi_load_init(vpiHandle objCollection, vpiHandle scope, PLI_INT32 level)
    Returns: PLI_INT32, 1 for success, 0 for fail.
    Arguments:
        vpiHandle objCollection: Object collection of type vpiObjCollection, a
                                 collection of design objects.
        vpiHandle scope: Scope of the load.
        PLI_INT32 level: If 0 then enables read access to scope and all its subscopes,
                         1 means just the scope.
    Related routines: None.

vpi_load()
    Synopsis: Load the data of the given object into memory for data access and
              traversal if object is an object handle; load the whole collection
              (i.e. set of objects) if passed handle is an object collection of type
              vpiObjCollection.
    Syntax: vpi_load(vpiHandle h)
    Returns: PLI_INT32, 1 for success of loading (all) object(s) (in collection),
             0 for fail of loading (any) object (in collection).
    Arguments:
        vpiHandle h: Handle to a design object (of any valid type) or object collection
                     of type vpiObjCollection.
    Related routines: None

vpi_unload()
    Synopsis: Unload the given object data from (active) memory if object is an object
              handle, unload the whole collection if passed object is a collection of
              type vpiObjCollection. See Section 30.9 for a description of data
              unloading.
    Syntax: vpi_unload(vpiHandle h)
    Returns: PLI_INT32, 1 for success, 0 for fail.
    Arguments:
        vpiHandle h: Handle to an object or collection (of type vpiObjCollection).
    Related routines: None.

vpi_create()
    Synopsis: Create or add to an object or traverse collection.
    Syntax: vpi_create(vpiType prop, vpiHandle h, vpiHandle obj)
    Returns: vpiHandle of type vpiObjCollection for success, NULL for fail.
    Arguments:
        vpiType prop:
        vpiObjCollection: Create (or add to) object (vpiObjCollection) or
                          traverse (vpiTrvsCollection) collection.
        vpiHandle h: Handle to a (object) traverse collection of
                     type (vpiObjCollection)
        vpiTrvsCollection, NULL for first call (creation)
        vpiHandle obj: Handle of object to add, NULL if for first time creation of
                       collection.
    Related routines: None.

vpi_goto()
    Synopsis: Try to move to min, max or specified time. A new traverse (collection)
              handle is returned pointing to the specified time. If the traverse handle
              (members of collection) has a VC at that time then the returned handle
              (members of returned collection) is updated to point to the specified
              time, otherwise it is not updated. If the passed handle has no VC (for
              collection this means no VC for any object) a fail is indicated,
              otherwise a success is indicated. In case of a jump to a specified time,
              and there is no value change at the specified time, then the value change
              traverse index of the returned (new) handle (member of returned collection)
              is aligned based on the jump behavior defined in Section 30.8.4.2, and
              its time (and the time pointer argument if passed and is non-NULL) shall
              be updated based on the aligned traverse point. In the case of vpiNextVC
              or vpiPrevVC, the time argument, if passed and is non-NULL (otherwise
              it is ignored and not updated), is updated if there is a VC (for
              collection this means a VC for any object) to the new time, otherwise the
              value is not updated.
    Syntax: vpi_goto(vpiType prop, vpiHandle obj, p_vpi_time time_p, PLI_INT32
                     *ret_code)
    Returns: vpiHandle of type vpitrvsObj (vpiObjCollection).
    Arguments:
vpiType prop:
vpiMinTime: Goto the minimum time of traverse collection handle.
vpiMaxTime: Goto the maximum time of traverse collection handle.
vpiTime: Jump to the time specified in time_p.
vpiNextVC: Goto the (time of) next VC.
vpiPrevVC: Goto the (time of) previous VC.
vpiHandle obj: Handle to a traverse object (collection) of type vpiTrvsObj
(vpiTrvsCollection)
p_vpi_time time_p: Pointer to a structure containing time information. Used only if prop is
of type vpiTime, otherwise it is ignored.
PLI_INT32 *ret_code:Pointer to a return code indicator. It is 1 for success and 0 for fail.
Related routines: None.
vpi_filter()
Synopsis: Filter a general collection, a traversable object collection, or traverse collection according to a
specific criterion. Return a collection of the handles that meet the criterion. Original collection is not
changed.
Syntax: vpi_filter(vpiHandle h, PLI_INT32 ft, PLI_INT32 flag)
Returns: vpiHandle of type vpiObjCollection for success, NULL for fail.
Arguments:
vpiHandle h: Handle to a collection of type vpiCollection, vpiObjCollection or
vpiTrvsCollection
PLI_INT32 ft: Filter criterion, any vpiType or a VPI boolean property.
PLI_INT32 flag: Flag to indicate whether to match criterion (if set to TRUE), or not (if set to
FALSE).
Related routines: None.