PlTbUtils  1.3
PlTbUtils is a collection of functions, procedures and components for easily creating stimuli and checking response in automatic self-checking testbenches.
pltbutils_user_cfg_pkg Package Reference

PlTbUtils User Configuration Package: User's function and procedure declarations. More...

Package Body >> pltbutils_user_cfg_pkg

Functions

string   tcfilter ( constant s: in string )

Procedures

  custom_stopsim( constant timestamp: in time )
  custom_startsim_msg( constant testcase_name: in string ,constant timestamp: in time )
  custom_endsim_msg(
constant testcase_name: in string
constant timestamp: in time
constant num_tests: in integer
constant num_skip_tests: in integer
constant num_checks: in integer
constant num_errors: in integer
constant show_success_fail: in boolean
)
  custom_starttest_msg(
constant test_num: in integer
constant test_name: in string
constant timestamp: in time
)
  custom_skiptest_msg(
constant test_num: in integer
constant test_name: in string
constant timestamp: in time
)
  custom_endtest_msg(
constant test_num: in integer
constant test_name: in string
constant timestamp: in time
constant test_active: in boolean
constant num_checks_in_test: in integer
constant num_errors_in_test: in integer
)
  custom_check_msg(
constant rpt: in string
constant timestamp: in time
constant expr: in boolean
constant actual: in string
constant expected: in string
constant mask: in string
constant test_num: in integer
constant test_name: in string
constant check_num: in integer
constant err_cnt_in_test: in integer
)
  custom_error_msg(
constant rpt: in string
constant timestamp: in time
constant test_num: in integer
constant test_name: in string
constant err_cnt_in_test: in integer
)

Constants

C_PLTBUTILS_USE_STD_STARTSIM_MSG  boolean := true
C_PLTBUTILS_USE_STD_ENDSIM_MSG  boolean := true
C_PLTBUTILS_USE_STD_STARTTEST_MSG  boolean := true
C_PLTBUTILS_USE_STD_SKIPTEST_MSG  boolean := true
C_PLTBUTILS_USE_STD_ENDTEST_MSG  boolean := true
C_PLTBUTILS_USE_STD_CHECK_MSG  boolean := true
C_PLTBUTILS_USE_STD_ERROR_MSG  boolean := true
C_PLTBUTILS_USE_STD_STOPSIM  boolean := true
C_PLTBUTILS_USE_CUSTOM_STARTSIM_MSG  boolean := false
C_PLTBUTILS_USE_CUSTOM_ENDSIM_MSG  boolean := false
C_PLTBUTILS_USE_CUSTOM_STARTTEST_MSG  boolean := false
C_PLTBUTILS_USE_CUSTOM_SKIPTEST_MSG  boolean := false
C_PLTBUTILS_USE_CUSTOM_ENDTEST_MSG  boolean := false
C_PLTBUTILS_USE_CUSTOM_CHECK_MSG  boolean := false
C_PLTBUTILS_USE_CUSTOM_ERROR_MSG  boolean := false
C_PLTBUTILS_USE_CUSTOM_STOPSIM  boolean := false

Detailed Description

PlTbUtils User Configuration Package: User's function and procedure declarations.

  • The user is free to modify the constant values to fit his/her requirements.
  • The user should NOT modify the procedure declarations.
  • The user should NOT modify the procedure implementation arguments, but the user is free to modify the behaviour to fit their requirements.

Example for use with TeamCity. Remove, modify or replace to suit other other continous integration tools or scripts, if you need to.

Definition at line 59 of file pltbutils_user_cfg_pkg.vhd.

Member Function Documentation

◆ custom_check_msg()

custom_check_msg ( constant   rpt in string ,
constant   timestamp in time ,
constant   expr in boolean ,
constant   actual in string ,
constant   expected in string ,
constant   mask in string ,
constant   test_num in integer ,
constant   test_name in string ,
constant   check_num in integer ,
constant   err_cnt_in_test in integer  
)
Procedure

Definition at line 124 of file pltbutils_user_cfg_pkg.vhd.

◆ custom_endsim_msg()

custom_endsim_msg ( constant   testcase_name in string ,
constant   timestamp in time ,
constant   num_tests in integer ,
constant   num_skip_tests in integer ,
constant   num_checks in integer ,
constant   num_errors in integer ,
constant   show_success_fail in boolean  
)
Procedure

Definition at line 93 of file pltbutils_user_cfg_pkg.vhd.

◆ custom_endtest_msg()

custom_endtest_msg ( constant   test_num in integer ,
constant   test_name in string ,
constant   timestamp in time ,
constant   test_active in boolean ,
constant   num_checks_in_test in integer ,
constant   num_errors_in_test in integer  
)
Procedure

Definition at line 115 of file pltbutils_user_cfg_pkg.vhd.

◆ custom_error_msg()

custom_error_msg ( constant   rpt in string ,
constant   timestamp in time ,
constant   test_num in integer ,
constant   test_name in string ,
constant   err_cnt_in_test in integer  
)
Procedure

Definition at line 137 of file pltbutils_user_cfg_pkg.vhd.

◆ custom_skiptest_msg()

custom_skiptest_msg ( constant   test_num in integer ,
constant   test_name in string ,
constant   timestamp in time  
)
Procedure

Definition at line 109 of file pltbutils_user_cfg_pkg.vhd.

◆ custom_startsim_msg()

custom_startsim_msg ( constant   testcase_name in string ,
constant   timestamp in time  
)
Procedure

Definition at line 88 of file pltbutils_user_cfg_pkg.vhd.

◆ custom_starttest_msg()

custom_starttest_msg ( constant   test_num in integer ,
constant   test_name in string ,
constant   timestamp in time  
)
Procedure

Definition at line 103 of file pltbutils_user_cfg_pkg.vhd.

◆ custom_stopsim()

custom_stopsim ( constant   timestamp in time  
)
Procedure

Definition at line 84 of file pltbutils_user_cfg_pkg.vhd.

◆ tcfilter()

string tcfilter (   s in string  
)
Function

Definition at line 145 of file pltbutils_user_cfg_pkg.vhd.

Member Data Documentation

◆ C_PLTBUTILS_USE_CUSTOM_CHECK_MSG

C_PLTBUTILS_USE_CUSTOM_CHECK_MSG boolean := false
Constant

Definition at line 77 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_CUSTOM_ENDSIM_MSG

C_PLTBUTILS_USE_CUSTOM_ENDSIM_MSG boolean := false
Constant

Definition at line 73 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_CUSTOM_ENDTEST_MSG

C_PLTBUTILS_USE_CUSTOM_ENDTEST_MSG boolean := false
Constant

Definition at line 76 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_CUSTOM_ERROR_MSG

C_PLTBUTILS_USE_CUSTOM_ERROR_MSG boolean := false
Constant

Definition at line 78 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_CUSTOM_SKIPTEST_MSG

C_PLTBUTILS_USE_CUSTOM_SKIPTEST_MSG boolean := false
Constant

Definition at line 75 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_CUSTOM_STARTSIM_MSG

C_PLTBUTILS_USE_CUSTOM_STARTSIM_MSG boolean := false
Constant

Definition at line 72 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_CUSTOM_STARTTEST_MSG

C_PLTBUTILS_USE_CUSTOM_STARTTEST_MSG boolean := false
Constant

Definition at line 74 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_CUSTOM_STOPSIM

C_PLTBUTILS_USE_CUSTOM_STOPSIM boolean := false
Constant

Definition at line 79 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_STD_CHECK_MSG

C_PLTBUTILS_USE_STD_CHECK_MSG boolean := true
Constant

Definition at line 69 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_STD_ENDSIM_MSG

C_PLTBUTILS_USE_STD_ENDSIM_MSG boolean := true
Constant

Definition at line 65 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_STD_ENDTEST_MSG

C_PLTBUTILS_USE_STD_ENDTEST_MSG boolean := true
Constant

Definition at line 68 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_STD_ERROR_MSG

C_PLTBUTILS_USE_STD_ERROR_MSG boolean := true
Constant

Definition at line 70 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_STD_SKIPTEST_MSG

C_PLTBUTILS_USE_STD_SKIPTEST_MSG boolean := true
Constant

Definition at line 67 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_STD_STARTSIM_MSG

C_PLTBUTILS_USE_STD_STARTSIM_MSG boolean := true
Constant

Definition at line 64 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_STD_STARTTEST_MSG

C_PLTBUTILS_USE_STD_STARTTEST_MSG boolean := true
Constant

Definition at line 66 of file pltbutils_user_cfg_pkg.vhd.

◆ C_PLTBUTILS_USE_STD_STOPSIM

C_PLTBUTILS_USE_STD_STOPSIM boolean := true
Constant

Definition at line 71 of file pltbutils_user_cfg_pkg.vhd.


The documentation for this class was generated from the following file: