svt_err_check_stats Class Reference

Method which establishes the err_check_stats_cov_inst. This object is created using the create_cov method.

enable_pass_cov - Enables the "pass" bins of the status covergroup.

enable_fail_cov - Enables the "fail" bins of the status covergroup.

Captures whether the check is enabled (1) or disabled (0).

Method which creates an svt_err_check_stats_cov instance for this svt_err_check_stats instance. The default implementation uses the'type' override facilities provided by the verification methodology.

Simple utility used to convert 'bit [1023:0]' property value representation into its equivalent string property value representation. Extended to support decoding of enum values.

prop_name - The name of the property being encoded.

prop_val_string - The string describing the value to be encoded.

prop_val - The bit vector encoding of prop_val_string.

typ - Optional field type used to help in the encode effort.

Return values - Status indicating the success/failure of the decode.

Method which deletes the err_check_stats_cov_inst field, assigning it to 'null'.

This method allocates a pattern containing svt_pattern_data instances for all of the primitive data fields in the object. The svt_pattern_data :: name is set to the corresponding field name, the svt_pattern_data :: value is set to 0.

Return values - An svt_pattern instance containing entries for all of the data fields.

Simple utility used to convert string property value representation into its equivalent 'bit [1023:0]' property value representation. Extended to support encoding of enum values.

prop_name - The name of the property being encoded.

prop_val_string - The string describing the value to be encoded.

prop_val - The bit vector encoding of prop_val_string.

typ - Optional field type used to help in the encode effort.

Return values - Status indicating the success/failure of the encode.

Returns a formatted string that provides the basic information about the check: the description and the reference.

Returns a string that provides the basic check message (basic check info plus message, if provided).

message - the message to be appended to the basic check info.

Return values - the complete string.

Returns the ID string of a check statistics object.

Return values - The check identifier string.

Returns a formatted string that provides the general information about the check including suite, check identifier, group, sub-group, description, and reference.

Returns a string that provides the general check message (check info plus message, if provided).

message - the message to be appended to the check info.

Return values - the complete string.

Returns a formatted string that provides the statistics (counts) about the check.

Returns a string giving the name of the class.

Returns a string that provides only the check's description.

Returns the err_check_name field identifying the svt_err_check instance that contains this svt_err_check_stats instance (if available).

Return values - The name of the svt_err_check instance.

Technology independent method which returns the full instance path for the err_check_stats instance.

Returns a string with the check group.

Return values - the check group.

Returns a value indicating whether the check is enabled (1) or disabled (0).

Return values - The enabled (1) or disabled (0) value.

Returns a value indicating whether the check was last enabled (1) or disabled (0).

Return values - The enabled (1) or disabled (0) value.

This method is used by a component's command interface, to allow command code to retrieve the value of a single named property of a data class derived from this class. If the prop_name argument does not match a property of the class, or if the array_ix argument is not zero and does not point to a valid array element, this function returns '0'. Otherwise it returns '1', with the value of the prop_val argument assigned to the value of the specified property. However, If the property is a sub-object, a reference to it is assigned to the data_obj (ref) argument.

prop_name - The name of a property in this class, or a derived class.

prop_val - A ref argument used to return the current value of the property, expressed as a 1024 bit quantity. When returning a string value each character requires 8 bits so returned strings must be 128 characters or less.

array_ix - If the property is an array, this argument specifies the index being accessed. If the property is not an array, it should be set to 0.

data_obj - If the property is not a sub-object, this argument is assigned to null. If the property is a sub-object, a reference to it is assigned to this (ref) argument. In that case, the prop_val argument is meaningless. The transactor will then store the data object reference in its temporary data object array, and return a handle to its location as the prop_val argument of the get_data_prop task of the component. The command testbench code must then use that handle to access the properties of the sub-object.

Return values - A single bit representing whether or not a valid property was retrieved.

Returns a string that provides only the check's reference.

Returns a string with the check sub-group.

Return values - the check sub-group.

Returns the unique identifier which is used to register and retrieve this check in check containers. This method returns check_id_str if it set, but if it is not set it returns the description.

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.

Formats the statistics (counts) about the check.

prefix - The prefix string for all output.

Method which registers a coverage override class to be used when creating coverage for this class.

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.

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.

Reports the basic information about the check: check identifier, group, sub-group, description, and reference.

prefix - The prefix string for all output.

omit_disabled - If this flag is set, and the check is not enabled, this method does nothing.

Reports the statistics (counts) about the check.

prefix - The prefix string for all output.

omit_unexercised - If this flag is set, and the check has not been exercised, this method does nothing.

Resets all counters.

Modifies the default handling of this check in the event of failure.

new_default_fail_effect - the new fail effect.

Modifies the default handling of this check in the event of pass.

new_default_pass_effect - the new pass effect.

Sets the err_check_name field identifying the svt_err_check instance that contains this svt_err_check_stats instance.

Modifies whether the check is enabled (1) or disabled (0).

new_is_enabled - the new enabled setting.

This method is used by a component's command interface, to allow command code to set the value of a single named property of a data class derived from this class. This method cannot be used to set the value of a sub-object, since sub-object consruction is taken care of automatically by the command interface. If the prop_name argument does not match a property of the class, or it matches a sub-object of the class, or if the array_ix argument is not zero and does not point to a valid array element, this function returns '0'. Otherwise it returns '1'.

prop_name - The name of a property in this class, or a derived class.

prop_val - The value to assign to the property, expressed as a 1024 bit quantity. When assigning a string value each character requires 8 bits so assigned strings must be 128 characters or less.

array_ix - If the property is an array, this argument specifies the index being accessed. If the property is not an array, it should be set to 0.

Return values - A single bit representing whether or not a valid property was set.