PlTbUtils: pltbutils_user_cfg_pkg Package Body Reference

PlTbUtils 1.3

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

Package >> pltbutils_user_cfg_pkg

Functions
string	tcfilter ( constant s: in string )
	TeamCity string filter. Filters out characters which are not allowed in TeamCity messages.

Procedures
	custom_stopsim( constant timestamp: in time )
	Example custom messages for TeamCity.
	custom_startsim_msg( constant testcase_name: in string ,constant timestamp: in time )
	Example custom messages for TeamCity.
	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 )
	Example custom messages for TeamCity.
	custom_starttest_msg( constant test_num: in integer constant test_name: in string constant timestamp: in time )
	Example custom messages for TeamCity.
	custom_skiptest_msg( constant test_num: in integer constant test_name: in string constant timestamp: in time )
	Example custom messages for TeamCity.
	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 )
	Example custom messages for TeamCity.
	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 )
	Example custom messages for TeamCity.
	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 )
	Example custom messages for TeamCity.

Detailed Description

Definition at line 151 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

Example custom messages for TeamCity.

Definition at line 252 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

Example custom messages for TeamCity.

Definition at line 197 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

Example custom messages for TeamCity.

Definition at line 234 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

Example custom messages for TeamCity.

Definition at line 308 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

Example custom messages for TeamCity.

Definition at line 223 of file pltbutils_user_cfg_pkg.vhd.

◆ custom_startsim_msg()

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

Procedure

Example custom messages for TeamCity.

Edit to suit other continous integration tools or scripts, if you need to. General TeamCity information: http://www.jetbrains.com/teamcity/ http://en.wikipedia.org/wiki/Teamcity TeamCity test reporting: http://confluence.jetbrains.com/display/TCD8/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ReportingTests

Definition at line 188 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

Example custom messages for TeamCity.

Definition at line 212 of file pltbutils_user_cfg_pkg.vhd.

◆ custom_stopsim()

custom_stopsim	(	constant	timestamp in time
	)

Procedure

Example custom messages for TeamCity.

Definition at line 158 of file pltbutils_user_cfg_pkg.vhd.

◆ tcfilter()

string tcfilter	(		s in string
	)

Function

TeamCity string filter. Filters out characters which are not allowed in TeamCity messages.

Search for "escaped values" in http://confluence.jetbrains.com/display/TCD8/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ReportingTests The TeamCity escape character is not used, because that changes the length of the string. The VHDL code can be simplified if it doesn't have to deal with changes of string lengths.

Definition at line 339 of file pltbutils_user_cfg_pkg.vhd.

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

src/vhdl/pltbutils_user_cfg_pkg.vhd

_pltbutils_user_cfg_pkg
Generated by 1.9.1