Teledyne LeCroy Verification Script Engine for Teledyne LeCroy PETracer Reference Manual - Manual (Page 7)

Teledyne LeCroy Verification Script Engine Reference Manual Version 6.6x
2
2 Verification Script Structure
Writing a verification script is easy, as long as you follow a few rules and have some understanding of
how the PETracer™ application interacts with running scripts.
The main script file that contains the text of the verification script should have extension .pevs, and be
located in the subfolder ..\Scripts\VFScripts of the main PETracer folder. Some other files might be included in
the main script file using directive %include. (see the Teledyne LeCroy PETracer File Based Decoding user
manual for details).
The following schema presents a common structure of a verification script (this is similar to the content of
the script template [VSTemplate.pev_] which is included with VSE):
# VS1.pevs
#
# Verification script
#
# Brief Description:
# Performs specific verification
#
#############################################################################################
# Module info
#############################################################################################
# Filling of this block is necessary for proper verification script operation...
############################################################################################
set ModuleType = "Verification Script"; # Should be set for all verification scripts
set OutputType = "VS"; # Should be set for all verification scripts that
# output only Report string and Result.
set InputType = "VS";
set DecoderDesc = "<Your Verification Script description>";
# Optional
######################################################################################################
#
# include main Verification Script Engine definitions
#
%include "VSTools.inc"
# Should be set for all verification scripts
######################################################################################
# Global Variables and Constants
######################################################################################
# Define your verification script-specific global variables and constant in this section...
# (Optional)
const MY_GLOBAL_CONSTANT = 10;
set g_MyGlobalVariable = 0;
######################################################################################
######################################################################################
# OnStartScript()
######################################################################################
#
# It is a main intialization routine for setting up all necessary
# script parameters before running the script.
#
######################################################################################