Packages

case class Processor(loc: Location, id: AST.Identifier, shape: ProcessorShape, inlets: Seq[Inlet], outlets: Seq[Outlet], examples: Seq[Example], brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None) extends PlantDefinition with ContextDefinition with Product with Serializable

A computing element for processing data from Inlets to Outlets. A processor's processing is specified by Gherkin Examples

loc

The location of the Processor definition

id

The name of the processor

shape

The shape of the processor's inputs and outputs

inlets

The list of inlets that provide the data the processor needs

outlets

The list of outlets that the processor produces

examples

A set of examples that define the data processing

brief

A brief description (one sentence) for use in documentation

description

An optional description of the processor

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Processor
  2. Serializable
  3. Product
  4. Equals
  5. ContextDefinition
  6. PlantDefinition
  7. Definition
  8. Container
  9. BrieflyDescribedValue
  10. DescribedValue
  11. RiddlValue
  12. RiddlNode
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Processor(loc: Location, id: AST.Identifier, shape: ProcessorShape, inlets: Seq[Inlet], outlets: Seq[Outlet], examples: Seq[Example], brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None)

    loc

    The location of the Processor definition

    id

    The name of the processor

    shape

    The shape of the processor's inputs and outputs

    inlets

    The list of inlets that provide the data the processor needs

    outlets

    The list of outlets that the processor produces

    examples

    A set of examples that define the data processing

    brief

    A brief description (one sentence) for use in documentation

    description

    An optional description of the processor

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val brief: Option[AST.LiteralString]
    Definition Classes
    ProcessorBrieflyDescribedValue
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def contents: Seq[ProcessorDefinition]
    Definition Classes
    ProcessorContainer
  8. val description: Option[AST.Description]
    Definition Classes
    ProcessorDescribedValue
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val examples: Seq[Example]
  11. def format: String

    Format the node to a string

    Format the node to a string

    Definition Classes
    RiddlNode
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hasAuthors: Boolean
    Definition Classes
    Definition
  14. def hasOptions: Boolean
    Definition Classes
    Definition
  15. def hasTypes: Boolean
    Definition Classes
    Definition
  16. val id: AST.Identifier
    Definition Classes
    ProcessorDefinition
  17. def identify: String
    Definition Classes
    Definition
  18. def identifyWithLoc: String
    Definition Classes
    Definition
  19. val inlets: Seq[Inlet]
  20. def isContainer: Boolean

    Determine if this node is a container or not

    Determine if this node is a container or not

    Definition Classes
    ContainerRiddlNode
  21. def isEmpty: Boolean

    determine if this node is empty or not.

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

    Definition Classes
    ContainerRiddlNode
  22. def isImplicit: Boolean
    Definition Classes
    Definition
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def isRootContainer: Boolean
    Definition Classes
    Container
  25. final val kind: String
    Definition Classes
    ProcessorDefinition
  26. def kindId: String
    Definition Classes
    Definition
  27. val loc: Location

    The location in the parse at which this RiddlValue occurs

    The location in the parse at which this RiddlValue occurs

    Definition Classes
    ProcessorRiddlValue
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def nonEmpty: Boolean
    Definition Classes
    RiddlNode
    Annotations
    @deprecatedOverriding()
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  32. val outlets: Seq[Outlet]
  33. def productElementNames: Iterator[String]
    Definition Classes
    Product
  34. val shape: ProcessorShape
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AST.ContextDefinition

Inherited from AST.PlantDefinition

Inherited from AST.Definition

Inherited from AST.DescribedValue

Inherited from AST.RiddlValue

Inherited from AST.RiddlNode

Inherited from AnyRef

Inherited from Any

Ungrouped