verifCreateSnapshot

verifCreateSnapshot(
g_sessionId
[ t_snapshotName ]
[ ?name t_name ]
[ ?prefix t_prefix ]
[ ?comment t_comment ]
[ ?visible g_visible ]
[ ?locked g_locked ]
)
=> t / nil

Description

Creates a new snapshot '*.snapz' that contains the following: - An archive, stored in .json format, of the current requirements, mappings, and results as shown in Results tab. - A copy of the settings.v3 setup. - A copy of the results directory.

Arguments

g_sessionId	Integer, string number, or window specifying the Verifier session ID. For example, 0, "0", or window(2).
t_snapshotName	Name of the snapshot. By default, the name is in the 'snap_<date and time>' format. This argument cannot be used with the ?name argument.
?name t_name	Name of the snapshot. By default, the name is in the 'snap_<date and time>' format. This argument cannot be used with the tSnapshotName argument.
?prefix t_prefix	Prefix of the snapshot. By default, the prefix is 'snap_'.
?comment t_comment	Comment added to the snapshot.
?visible g_visible	Visibility status of the snapshot.
?locked g_locked	Locked status of the snapshot.

Value Returned

t	Snapshot is created successfully in the specified Verifier session.
nil	Snapshot does not exist or Verifier does not have the permission to create a new snapshot, or the command is not successful.

Examples

The following example starts a Verifier session with a cellview 'test/snapshots/verifier' and create a new snapshot.

uid = verifOpenCellView("test" "snapshots" "verifier")
=> 0

Creates a snapshot with the default naming format.

verifCreateSnapshot(uid)
=> t

Creates a snapshot with specified name.

verifCreateSnapshot(uid "mySnap")
=> t

Creates a snapshot automatically.

verifRegisterCallback(
    lambda((sess sig args)
            when(sig == 'simulationsAdded
                verifSetSnapshotsEnabled(sess t)
                verifCreateSnapshot(sess ?prefix "sim" ?comment "Pre-simulation snapshot")
        )
    )
)

Related Topics

verifAreSnapshotsEnabled

verifCreateSnapshotConfiguration

verifDeleteSnapshot

verifSetSnapshotsEnabled

Snapshot Functions

Return to top