svt_pattern_sequence Class Reference

Method to add a new name/value pair to the indicated pattern.

pttrn_ix - Pattern which is to get the new name/value pair.

name - Name portion of the new name/value pair.

value - Value portion of the new name/value pair.

array_ix - Index into value when value is an array.

positive_match - Indicates whether match (positive_match == 1) or mismatch (positive_match == 0) is desired.

Allocates a new object of same type.

Return values - Returns a newly allocated svt_pattern_sequence instance.

Utility method to check for a full sequence match.

data_match - The current matching data.

pttrn_ix - The position of the current match.

match - Indication of the current match.

restart_match - Indication of whether a the match is to be restarted.

Copies the object into to, allocating if necessay.

to - svt_pattern_sequence object is the destination of the copy. If not provided, copy method will use the allocate method to create an object of the necessary type.

Copies the sequence of patterns into the provided svt_pattern_sequence.

to - svt_pattern_sequence that the pttrn is copied to.

first_ix - The index at which the copy is to start. Defaults to 0 indicating that the copy should start with the first pttrn array element.

limit_ix - The first index AFTER the last element to be copied. Defaults to -1 indicating that the copy should go from first_ix to the end of the current pttrn array.

Method called at the end of the match_sequence and wait_for_match pattern match to do additional checks of the original data_match. Can be used by an extended class to impose additional requirements above and beyond the basic pattern match requirements.

data_match - Queue which includes the data objects that made up the pattern match.

Utility method used to get a unique identifier string for the pattern sequence.

Returns this class' name as a string.

Method to see if this pattern sequence can be matched against the provided queue of svt_sequence_item_base objects. This method assumes that the data is complete and that it can be fully accessed via the iterator svt_sequence_item_base_iter :: next method.

Does a basic pattern match before calling detail_match to do a final detailed validation of the match. This method will also return if it makes a match or completely fails based on starting at the current position. The client is responsible for setting up and initiating the next match_sequence request.

data_iter - Iterator that will be scanned in search of the pattern sequence.

data_match - If a match was made, this queue includes the data objects that made up the pattern match. If the data_match queue is empty, it indicates the match failed.

CONSTRUCTOR: Creates a new instance of the svt_pattern_sequence class.

pttrn_seq_id - Identifier associated with this pattern sequence.

pttrn_cnt - Number of patterns that will be placed in the pattern sequence.

pttrn_name - Name associated with this pattern sequence.

reporter - Used to replace the default message report object.

Utility method to evaluate whether the previous match against a sub-sequence was successful.

data_match - The current matching data.

curr_data - The current data we are reviewing for a match.

data_sub_match - The data matched within the sub-sequence.

pttrn_ix - The position of the current match.

Displays the contents of the object to a string. Each line of the generated output is preceded by prefix.

prefix - String which specifies a prefix to put at the beginning of each line of output.

Resizes the pattern array as indicated, loading up the pattern array with svt_pattern instances.

new_size - Number of patterns to include in the array.

Utility method to set things up for a match restart.

data_iter - Iterator that is being used to do the overall scan in search of the pattern sequence.

data_match - The current matching data.

pttrn_ix - The position of the current match.

pttrn_match_cnt - The patterns within the pattern sequence that have been matched thus far.

match - Indication of the current match.

restart_match - Indication of whether a the match is to be restarted.

Utility method for creating a pattern sub-sequence.

first_pttrn_ix - Position where the sub-sequence is to start.

Method to see if this pattern sequence can be matched against the provided queue of svt_sequence_item_base objects. This method assumes that the data is still being generated and that it must rely on the svt_sequence_item_base_iter :: wait_for_next method to recognize when additional data is available to continue the match.

Does a basic pattern match before calling detail_match to do a final detailed validation of the match. This method will also return if it makes a match or completely fails based on starting at the current position. The client is responsible for setting up and initiating the next wait_for_match request.

data_iter - Iterator that will be scanned in search of the pattern sequence.

data_match - If a match was made, this queue includes the data objects that made up the pattern match. If the data_match queue is empty, it indicates the match failed.