svt_svc_err_check_stats Class Reference

Inheritance diagram for class svt_svc_err_check_stats:

List of all members.


Detailed Description

Error Check Statistics Class extension for SVC interface



Public Member Functions

function string  get_class_name ( )
function void  new ( string suite_name = "", string check_id_str = "", string group = "", string sub_group = "", string description = "", string reference = "", svt_err_check_stats :: fail_effect_enum default_fail_effect = svt_err_check_stats::ERROR, int filter_after_count = 0, bit is_enabled = 1 )
function void  register_fail ( string message = "", svt_err_check_stats :: fail_effect_enum override_fail_effect = svt_err_check_stats::DEFAULT, string filename = "", int line = 0 )
function void  register_pass ( svt_err_check_stats :: fail_effect_enum override_pass_effect = svt_err_check_stats::DEFAULT, string filename = "", int line = 0 )

Public Attributes

svt_svc_message_manager  svc_msg_mgr 


Member Function Documentation

  function string
 svt_svc_err_check_stats::get_class_name

 (   ) 


Returns a string giving the name of the class.

 Superseded functions 
 svt_sequence_item_base :: get_class_name 
 svt_err_check_stats :: get_class_name 

  function void
 svt_svc_err_check_stats::new

 (  string suite_name = "", string check_id_str = "", string group = "", string sub_group = "", string description = "", string reference = "", svt_err_check_stats :: fail_effect_enum default_fail_effect = svt_err_check_stats::ERROR, int filter_after_count = 0, bit is_enabled = 1  ) 


CONSTRUCTOR: Create a new svt_err_check_stats instance, passing the appropriate argument values to the svt_data parent class.

suite_name - Passed in by transactor, to identify the model suite.

check_id_str - Unique string identifier.

group - The group to which the check belongs.

sub_group - The sub-group to which the check belongs.

description - Text description of the check.

reference - (Optional) Text to reference protocol spec requirement associated with the check.

default_fail_effect - (Optional: Default = ERROR) Sets the default handling of a failed check.

filter_after_count - (Optional) Sets the number of fails before automatic filtering is applied.

is_enabled - (Optional) The default enabled setting for the check.


 Superseded functions 
 svt_err_check_stats :: new 

  function void
 svt_svc_err_check_stats::register_fail

 (  string message = "", svt_err_check_stats :: fail_effect_enum override_fail_effect = svt_err_check_stats::DEFAULT, string filename = "", int line = 0  ) 


Registers a FAILED check with this class. As long as the failure has not been filtered, this method produces log output with information about the check, and the fact that it has FAILED, along with a message (if specified).

message - (Optional) Additional output that will be printed along with the basic failure message.

override_fail_effect - (Optional: Default=DEFAULT) Allows the failure to be overridden for this particular failure.

filename - Optional argument identifying the source file for the message.

line - Optional argument identifying the source line number for the message.


 Superseded functions 
 svt_err_check_stats :: register_fail 

  function void
 svt_svc_err_check_stats::register_pass

 (  svt_err_check_stats :: fail_effect_enum override_pass_effect = svt_err_check_stats::DEFAULT, string filename = "", int line = 0  ) 


Registers a PASSED check with this class. As long as the pass has not been filtered, this method produces log output with information about the check, and the fact that it has PASSED.

override_pass_effect - (Optional: Default=DEFAULT) Allows the pass to be overridden for this particular pass. Most values correspond to the corresponding message levels. The exceptions are

  • IGNORE - No message is generated.
  • EXPECTED - The message is generated as verbose.

filename - Optional argument identifying the source file for the message.

line - Optional argument identifying the source line number for the message.


 Superseded functions 
 svt_err_check_stats :: register_pass 


Member Attribute Documentation

 svt_svc_message_manager  attribute
 svt_svc_err_check_stats::svc_msg_mgr


Handle to associated svc_msg_mgr