Class BranchDetail

Branch Coverage Detail Data

An extension of {@link Detail | Detail} to hold detailed coverage data for branch statements.

Hierarchy

Detail
- BranchDetail

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new BranchDetail(lineNumber: number, blockNumber: number): BranchDetail

Overrides Detail.constructor
- Defined in classes/details/branchDetail.ts:33
Construct a BranchDetail

Parameters
- lineNumber: number
  
  The line number associated with the detailed data
- blockNumber: number
  
  The block number assigned to the branch
Returns BranchDetail

Properties

Protected _executionCount

_executionCount: number = -1

Execution Count

The execution count of this Detail

Protected _lineNumber

_lineNumber: number = -1

Line Number

The line number that this Detail is associated with

Accessors

blockNumber

get blockNumber(): number

- Defined in classes/details/branchDetail.ts:93
Block Number

Returns number

The block number assigned to this BranchDetail

branches

get branches(): object

- Defined in classes/details/branchDetail.ts:103
Branches

Returns object

the branch map containing execution counts for specific branch paths
- [index: number]: number

executionCount

get executionCount(): number

Inherited from Detail.executionCount
- Defined in classes/details/detail.ts:50
Execution Count

Returns number

the number of times this Detail's line was executed

lineNumber

get lineNumber(): number

Inherited from Detail.lineNumber
- Defined in classes/details/detail.ts:41
Line Number

Returns number

the line number associated with this Detail

Methods

addBranchExecutionCount

addBranchExecutionCount(branchNumber: number, executionCount: number): void

- Defined in classes/details/branchDetail.ts:59
Add Branch Execution Data

Adds an execution count for a specific branching path. If the branching path already exists, the execution count is appended to the existing value. Otherwise, a new entry is saved with the given execution count.

The execution count is appended to the total execution count of this BranchDetail as well.

Parameters
- branchNumber: number
  
  A 0-indexed identifier of the branch path
- executionCount: number
  
  The execution count to add
Returns void

clone

clone(): BranchDetail

Implementation of ICloneable.clone

Overrides Detail.clone
- Defined in classes/details/branchDetail.ts:122
Returns BranchDetail

combine

combine(other: BranchDetail): BranchDetail

Overrides Detail.combine
- Defined in classes/details/branchDetail.ts:107
Parameters
- other: BranchDetail
Returns BranchDetail

getBranchExecutionCount

getBranchExecutionCount(branchNumber: number): number

- Defined in classes/details/branchDetail.ts:84
Get the execution count of a specific branch path

If the given branch number was not previously tracked, 0 will be returned.

Parameters
- branchNumber: number
  
  A 0-indexed identifier of the branch path
Returns number

Generated using TypeDoc