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

Streamlet

com.reactific.riddl.language.ast.Definitions.Streamlet
case class Streamlet(loc: At, id: Identifier, shape: StreamletShape, inlets: Seq[Inlet], outlets: Seq[Outlet], handlers: Seq[Handler], functions: Seq[Function], types: Seq[Type], includes: Seq[Include[StreamletDefinition]], authors: Seq[AuthorRef], options: Seq[StreamletOption], terms: Seq[Term], brief: Option[LiteralString], description: Option[Description]) extends Processor[StreamletOption, StreamletDefinition], ContextDefinition

Definition of a Streamlet. A computing element for processing data from Inlets to Outlets. A processor's processing is specified by free text statements in Handlers. Streamlets come in various shapes: Source, Sink, Flow, Merge, Split, and Router depending on how many inlets and outlets they have

Value parameters

brief

A brief description (one sentence) for use in documentation

description

An optional description of the processor

handlers

Definitions of how the processor handles each event type

id

The name of the processor

inlets

The list of inlets that provide the data the processor needs

loc

The location of the Processor definition

outlets

The list of outlets that the processor produces

shape

The shape of the processor's inputs and outputs

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait WithTypes
trait WithTerms
trait WithAuthors
trait Definition
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def contents: Seq[StreamletDefinition]

Attributes

Definition Classes
override 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
Definition Classes

Inherited methods

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 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 <: StreamletOption : 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 <: StreamletOption : 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 identify: String

Attributes

Inherited from:
Definition
def identifyWithLoc: String

Attributes

Inherited from:
Definition
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
final def nonEmpty: Boolean

Attributes

Inherited from:
RiddlNode
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

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

Attributes

Inherited from:
Definition

Concrete fields

final val kind: String

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