Description: Returns a data structure giving the module tree and the uncovered code list for a given source file.
Returns: Struct
Usage: Script
Format: CoverageSnapshot(Module[, ResetCounters])
Parameters: Module { Module } { required } { no default: }
Specifies what source file to generate the coverage snapshot for (the snapshot will be generated for all modules defined in the source file, regardless of whether the specified module is the root module in the file or not).
ResetCounters { Boolean } { optional } { default: True }
Specifies whether the execution counters should be reset to zero or not after generating the snapshot. It is optional and defaults to TRUE.
Comments: The source file is dictated by the module passed in for the first parameter.
The structure returned is:
FileCoverage Struct [
Children { Dictionary of child module names.
The values are either a pointer to Child struct
or a file name.
File name is used if not in the same source file.
File names are relative to VTS directory. };
List { Pointer UncoveredList };
FileSize { Number of bytes in the file };
TimeStamp { File time for the file };
Class { Class defined for the module };
]
The referenced structures are:
Child Struct [
Begin { Offset from the source file for module definition};
End { Last byte offset for the module definition };
Children{ Dictionary as defined in FileCoverage Struct };
Class { Class defined for the module };
]
UncoveredList Struct [
Begin { Offset to start of uncovered code in source file };
End { Offset to last byte of uncovered code in range };
Mode { 0 for code, 1 for variables };
Next { Pointer to next UncoveredList for the file };
]