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
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass CollectingPass[DefinitionStats]class Passclass Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
THe name of the pass for inclusion in messages it produces.
THe name of the pass for inclusion in messages it produces. This must be implemented by the subclass
Attributes
- Returns
-
A string value giving the name of this pass
- Source
- StatsPass.scala
A signal that the processing is complete and no more calls to process will be made.
A signal that the processing is complete and no more calls to process will be made. This also gives the Pass subclass a chance to do post-processing as some computations can only be done after collecting data from the entire AST
Value parameters
- root
-
The root of the parsed model just as a convenience for post-processing
Attributes
- Definition Classes
- Source
- StatsPass.scala
Generate the output of this Pass.
Generate the output of this Pass. This will only be called after all the calls to process have completed.
Attributes
- Returns
-
an instance of the output type
- Definition Classes
- Source
- StatsPass.scala
Inherited methods
Close any resources used so this can be used with AutoCloseable or Using.Manager
Close any resources used so this can be used with AutoCloseable or Using.Manager
Attributes
- Inherited from:
- Pass
- Source
- Pass.scala
Pre-process the root before actually traversing.
Pre-process the root before actually traversing. This is also a signal that the processing is about to start.
Value parameters
- root
-
A com.ossuminc.riddl.language.AST.Root node which encapsulates the whole model. This is the state of the Root as of the last pass.
Attributes
- Returns
-
Typically returns the same Root objects with changes in subsequent levels, but it entirely possibly to completely reorganize the hierarchy, including its root node.
- Inherited from:
- Pass
- Source
- Pass.scala
The method usually called for each definition that is to be processed but our implementation of traverse instead calls collect so a value can be returned.
The method usually called for each definition that is to be processed but our implementation of traverse instead calls collect so a value can be returned. This implementation is final because it is meant to be ignored.
Value parameters
- definition
-
The definition to be processed
- parents
-
The stack of definitions that are the parents of com.ossuminc.riddl.language.AST.Definition. This stack goes from immediate parent towards the root. The root is deepest in the stack.
Attributes
- Definition Classes
- Inherited from:
- CollectingPass
- Source
- Pass.scala
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Inherited fields
Attributes
- Inherited from:
- CollectingPass
- Source
- Pass.scala
Attributes
- Inherited from:
- Pass
- Source
- Pass.scala
Attributes
- Inherited from:
- Pass
- Source
- Pass.scala