RIDDL
3.3.1
API
Generated with
RIDDL/com.reactific.riddl.language/com.reactific.riddl.language.ast/Definitions/Processor

Processor

com.reactific.riddl.language.ast.Definitions.Processor
trait Processor[OPT <: OptionValue, DEF <: Definition] extends VitalDefinition[OPT, DEF], WithTypes

Definition of a Processor. This is a base class for all Processor definitions (things that have inlets, outlets, handlers, and take messages directly with a reference).

Attributes

Graph
Supertypes
trait WithTypes
trait VitalDefinition[OPT, DEF]
trait WithTerms
trait WithIncludes[DEF]
trait WithAuthors
trait WithOptions[OPT]
trait Definition
trait Container[DEF]
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
class Adaptor
class Application
class Context
class Entity
class Projector
class Repository
class Streamlet
Show all

Members list

Value members

Abstract methods

def inlets: Seq[Inlet]

Inherited methods

def authors: Seq[AuthorRef]

Attributes

Inherited from:
WithAuthors
def brief: Option[LiteralString]

Attributes

Inherited from:
BrieflyDescribedValue
def briefValue: String

Attributes

Inherited from:
BrieflyDescribedValue
def completeness: (Int, Int)

Compute the completeness of this definition.

Compute the completeness of this definition. Vital definitions should have options, terms, and authors but includes are optional. Incompleteness is signalled by child definitions that are empty.

Attributes

Returns

A numerator and denominator for percent complete

Inherited from:
VitalDefinition
def contents: Seq[T]

Attributes

Inherited from:
WithIncludes
def description: Option[Description]

Attributes

Inherited from:
DescribedValue
def descriptionValue: String

Attributes

Inherited from:
DescribedValue
override def format: String

Format the node to a string

Format the node to a string

Attributes

Definition Classes
Inherited from:
WithOptions
def getOptionValue[OPT <: OPT : ClassTag]: Option[Seq[LiteralString]]

Attributes

Inherited from:
WithOptions
override def hasAuthors: Boolean

Attributes

Definition Classes
Inherited from:
WithAuthors
override def hasDefinitions: Boolean

Attributes

Definition Classes
Inherited from:
Definition
def hasOption[OPT <: OPT : ClassTag]: Boolean

Attributes

Inherited from:
WithOptions
override def hasOptions: Boolean

Attributes

Definition Classes
Inherited from:
WithOptions
def hasTerms: Boolean

Attributes

Inherited from:
WithTerms
override def hasTypes: Boolean

Attributes

Definition Classes
Inherited from:
WithTypes
def id: Identifier

Attributes

Inherited from:
Definition
def identify: String

Attributes

Inherited from:
Definition
def identifyWithLoc: String

Attributes

Inherited from:
Definition
def includes: Seq[Include[T]]

Attributes

Inherited from:
WithIncludes
override def isContainer: Boolean

Determine if this node is a container or not

Determine if this node is a container or not

Attributes

Definition Classes
Inherited from:
Container
override def isDefinition: Boolean

Attributes

Definition Classes
Inherited from:
Definition
override def isEmpty: Boolean

determine if this node is empty or not.

determine if this node is empty or not. Non-containers are always empty

Attributes

Definition Classes
Inherited from:
WithOptions
def isImplicit: Boolean

Attributes

Inherited from:
Definition
def isRootContainer: Boolean

Attributes

Inherited from:
Container
override def isVital: Boolean

Attributes

Definition Classes
Inherited from:
VitalDefinition
def kind: String

Attributes

Inherited from:
Definition
def loc: At

The location in the parse at which this RiddlValue occurs

The location in the parse at which this RiddlValue occurs

Attributes

Inherited from:
RiddlValue
def maturity: Int

Compute the 'maturity' of a definition.

Compute the 'maturity' of a definition. Maturity is a score with no maximum but with scoring rules that target 100 points per definition. Maturity is broken down this way:

  • has a description - up to 50 points depending on # of non empty lines

  • has a brief description - 5 points

  • has options specified - 5 points

  • has terms defined -

  • has an author in or above the definition - 5 points \-

  • definition specific things: 0.65

Attributes

Returns
Inherited from:
VitalDefinition
final def nonEmpty: Boolean

Attributes

Inherited from:
RiddlNode
def options: Seq[T]

Attributes

Inherited from:
WithOptions
def resolveNameTo(name: String): Option[Definition]

Attributes

Inherited from:
Definition
def terms: Seq[Term]

Attributes

Inherited from:
WithTerms
def types: Seq[Type]

Attributes

Inherited from:
WithTypes

Implicits

Inherited implicits

implicit def bool2int(b: Boolean): Int

Implicit conversion of boolean to Int for easier computation of statistics below

Implicit conversion of boolean to Int for easier computation of statistics below

Value parameters

b

The boolean to convert to an Int

Attributes

Returns
Inherited from:
VitalDefinition
Generated with