Package com.solibri.smc.api.checking

Interface Score

  • public interface Score
    Score provides a metric to measure project coverage and checking coverage.
    Since:
    9.12.6

    • Method Detail

      • getTime

        Instant getTime()
        Returns the time when the score was calculated.
        Returns:
        the time
        Since:
        9.12.6

      • getProjectCoverageScore

        int getProjectCoverageScore()
        Returns the coverage score of the project.
        Returns:
        the project coverage score
        Since:
        9.12.6

      • getTotalComponentsCount

        int getTotalComponentsCount()
        Returns the total number of components in the project at the time of the calculation.
        Returns:
        the total number of components
        Since:
        9.12.6

      • getPassedComponentsCount

        int getPassedComponentsCount()
        Returns the number of components which passed the rule check at the time of the calculation.
        Returns:
        the number of passed components
        Since:
        9.12.6

      • getFailedComponentsCount

        int getFailedComponentsCount()
        Returns the number of components which failed the rule check at the time of the calculation.
        Returns:
        the number of failed components
        Since:
        9.12.6

      • getRuleCoverageScore

        int getRuleCoverageScore()
        Returns the rule coverage score, which signify the extent of rule checks performed on the project.
        Returns:
        the rule coverage score
        Since:
        9.12.6

      • getCheckedRuleCount

        int getCheckedRuleCount()
        Returns the number of used rules at the time of score calculation.

        It ignores all the new or custom rules, unless included in defined set of rules considered for score. Using the rule once is same as using it multiple times.

        Returns:
        the number of checked rules
        Since:
        9.12.6

      • getUncheckedRuleCount

        int getUncheckedRuleCount()
        Returns the number of rules which were not used at the time of score calculation.

        It ignores all the new or custom rules, unless included in defined set of rules considered for score. Using the rule once is same as using it multiple times.

        Returns:
        the number of unchecked rules
        Since:
        9.12.6