com.ossuminc.riddl.passes.stats
package com.ossuminc.riddl.passes.stats
Members list
Type members
Classlikes
case class DefinitionStats(kind: String, isEmpty: Boolean, descriptionLines: Int, numSpecifications: Int, numCompleted: Long, numContained: Long, numAuthors: Long, numTerms: Long, numOptions: Long, numIncludes: Long, numStatements: Long)
DefinitionStats
DefinitionStats
Value parameters
- descriptionLines
-
The number of lines of documentation between the description and brief fields
- isEmpty
-
An indication if the definition is completely empty
- numAuthors
-
The number of defining authors
- numCompleted
-
The number of specifications that hve been completed
- numContained
-
The number of contained definitions
- numIncludes
-
The number of include statements
- numOptions
-
The number of options declared
- numSpecifications
-
The number of kinds of specifications that can be completed from the node's specifications method
- numStatements
-
The number of statements used
- numTerms
-
The number of term definitions
Attributes
- Source
- StatsPass.scala
- Supertypes
class KindStats(var count: Long, var numEmpty: Long, var descriptionLines: Long, var numSpecifications: Long, var numCompleted: Long, var numContained: Long, var numAuthors: Long, var numTerms: Long, var numOptions: Long, var numIncludes: Long, var numStatements: Long)
Attributes
- Source
- StatsPass.scala
- Supertypes
-
class Objecttrait Matchableclass Any
case class StatsOutput(root: Root, messages: Messages, maximum_depth: Int, categories: Map[String, KindStats]) extends CollectingPassOutput[DefinitionStats]
Attributes
- Source
- StatsPass.scala
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait PassOutputclass Objecttrait Matchableclass AnyShow all
object StatsPass extends PassInfo[PassOptions]
Attributes
- Companion
- class
- Source
- StatsPass.scala
- Supertypes
-
trait Producttrait Mirrortrait PassInfo[PassOptions]class Objecttrait Matchableclass AnyShow all
- Self type
-
StatsPass.type
case class StatsPass(input: PassInput, outputs: PassesOutput) extends CollectingPass[DefinitionStats]
Pass that generates statistics about a RIDDL Model
Pass that generates statistics about a RIDDL Model
Value parameters
- input
-
The input to the pass
- outputs
-
The outputs from the passes
Attributes
- Companion
- object
- Source
- StatsPass.scala
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass CollectingPass[DefinitionStats]class Passclass Objecttrait Matchableclass AnyShow all
In this article