import AbstractReport from 'typhonjs-escomplex-commons/src/module/report/AbstractReport.js'

public class | source

AbstractReport

Direct Subclass:

AggregateMethodReport, ClassReport, ModuleReport, AggregateMethodReport, ClassReport, ModuleReport

Indirect Subclass:

ClassMethodReport, MethodReport, ModuleMethodReport, ClassMethodReport, MethodReport, ModuleMethodReport

Provides several helper methods to work with method oriented data stored as this.methodAggregate in ClassReport / ModuleReport and directly in ClassMethodReport / ModuleMethodReport.

Constructor Summary

Public Constructor
public	constructor(aggregateMethodReport: AggregateMethodReport) If given assigns the method report to an internal variable.

Member Summary

Public Members
public get	aggregateMethodReport: AggregateMethodReport: * Returns the associated `AggregateMethodReport` or `this`.
public	methodAggregate: AggregateMethodReport Stores any associated `AggregateMethodReport`.

Method Summary

Public Methods
public	incrementDistinctHalsteadItems(metric: string, identifier: string) Increments the associated aggregate report HalsteadData for distinct identifiers.
public	incrementHalsteadItems(metric: string, identifier: string) Increments the associated aggregate report Halstead items including distinct and total counts.
public	incrementHalsteadMetric(metric: string, type: string) Increments the associated aggregate report Halstead metric type.
public	incrementParams(count: number) Increments the associated aggregate report parameter count.
public	isHalsteadMetricDistinct(metric: string, identifier: string): boolean Returns true if a given HalsteadData metric / identifier is not found in the associated aggregate report.
public	toFormat(name: string, options: object): string Formats this report given the type.

Public Constructors

public constructor(aggregateMethodReport: AggregateMethodReport) source

If given assigns the method report to an internal variable. This is used by ClassReport and ModuleReport which stores a AggregateMethodReport respectively in this.methodAggregate.