RIDDL API Documentation
0.0.0-1-1f99f002
API
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.
RIDDL API Documentation/com.ossuminc.riddl/com.ossuminc.riddl.passes/com.ossuminc.riddl.passes.validate/ValidationPass

ValidationPass

com.ossuminc.riddl.passes.validate.ValidationPass
See theValidationPass companion object
case class ValidationPass(input: PassInput, outputs: PassesOutput)(using x$3: PlatformContext) extends Pass, StreamingValidation

A Pass for validating the content of a RIDDL model. This pass can produce many warnings and errors about the model.

Value parameters

input

Input from previous passes

outputs

The outputs from prior passes (symbols & resolution)

Attributes

Companion
object
Source
ValidationPass.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Pass
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def name: String

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

Definition Classes
Source
ValidationPass.scala
override def postProcess(root: Root): Unit

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
ValidationPass.scala
def process(value: RiddlValue, parents: ParentStack): Unit

The main implementation of the Pass.

The main implementation of the Pass. The AST is walked in a depth first manner calling this function for each definition it encounters.

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

Source
ValidationPass.scala
override def result(root: Root): ValidationOutput

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
ValidationPass.scala

Inherited methods

def addInlet(inlet: Inlet): Unit

Attributes

Inherited from:
StreamingValidation
Source
StreamingValidation.scala
def addOutlet(outlet: Outlet): Unit

Attributes

Inherited from:
StreamingValidation
Source
StreamingValidation.scala
def areSameType(typ1: Option[Type], typ2: Option[Type]): Boolean

Attributes

Inherited from:
TypeValidation
Source
TypeValidation.scala
def article(thing: String): String

Attributes

Inherited from:
BasicValidation
Source
BasicValidation.scala
def check(predicate: Boolean, message: => String, kind: KindOfMessage, loc: At): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
Source
BasicValidation.scala
def checkIdentifierLength[T <: Definition](d: T, min: Int): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
Source
BasicValidation.scala
def checkOverloads(): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
Source
BasicValidation.scala
def checkSequence[A](elements: Seq[A])(check: A => Unit): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
Source
BasicValidation.scala
def checkStreaming(root: Root): Unit

Attributes

Inherited from:
StreamingValidation
Source
StreamingValidation.scala
def close(): Unit

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
def lookup[T <: Definition : ClassTag](id: Seq[String]): List[T]

Attributes

Inherited from:
BasicValidation
Source
BasicValidation.scala
def parentOf(definition: Definition): Parent

Attributes

Inherited from:
BasicValidation
Source
BasicValidation.scala
def parentsOf(definition: Definition): Parents

Attributes

Inherited from:
BasicValidation
Source
BasicValidation.scala
def preProcess(root: Root): Root

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
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

lazy val resolution: ResolutionOutput

Attributes

Source
ValidationPass.scala
lazy val symbols: SymbolsOutput

Attributes

Source
ValidationPass.scala

Inherited fields

protected val connectors: ListBuffer[Connector]

Attributes

Inherited from:
StreamingValidation
Source
StreamingValidation.scala
val in: PassInput

Attributes

Inherited from:
Pass
Source
Pass.scala
protected val inlets: ListBuffer[Inlet]

Attributes

Inherited from:
StreamingValidation
Source
StreamingValidation.scala
val out: PassesOutput

Attributes

Inherited from:
Pass
Source
Pass.scala
protected val outlets: ListBuffer[Outlet]

Attributes

Inherited from:
StreamingValidation
Source
StreamingValidation.scala
protected val streamlets: ListBuffer[Streamlet]

Attributes

Inherited from:
StreamingValidation
Source
StreamingValidation.scala
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.