Packages

case class Pipe(loc: Location, id: Identifier, transmitType: Option[TypeRef], brief: Option[LiteralString] = None, description: Option[Description] = None) extends PlantDefinition with Product with Serializable

Definition of a pipe for data streaming purposes. Pipes are conduits through which data of a particular type flows.

loc

The location of the pipe definition

id

The name of the pipe

transmitType

The type of data transmitted.

brief

A brief description (one sentence) for use in documentation

description

An optional description of the pipe.

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

Instance Constructors

  1. new Pipe(loc: Location, id: Identifier, transmitType: Option[TypeRef], brief: Option[LiteralString] = None, description: Option[Description] = None)

    loc

    The location of the pipe definition

    id

    The name of the pipe

    transmitType

    The type of data transmitted.

    brief

    A brief description (one sentence) for use in documentation

    description

    An optional description of the pipe.

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[LiteralString]
    Definition Classes
    PipeBrieflyDescribedValue
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. val description: Option[Description]
    Definition Classes
    PipeDescribedValue
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def format: String
    Definition Classes
    RiddlNode
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. val id: Identifier
    Definition Classes
    PipeDefinition
  12. def identify: String
    Definition Classes
    Definition
  13. def identifyWithLoc: String
    Definition Classes
    Definition
  14. def isContainer: Boolean
    Definition Classes
    RiddlValue
  15. def isEmpty: Boolean
    Definition Classes
    RiddlNode
  16. def isImplicit: Boolean
    Definition Classes
    Definition
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def kind: String
    Definition Classes
    Definition
  19. def kindId: String
    Definition Classes
    Definition
  20. val loc: Location
    Definition Classes
    PipeRiddlValue
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def nonEmpty: Boolean
    Definition Classes
    RiddlNode
    Annotations
    @deprecatedOverriding()
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. val transmitType: Option[TypeRef]
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. 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 PlantDefinition

Inherited from Definition

Inherited from BrieflyDescribedValue

Inherited from DescribedValue

Inherited from RiddlValue

Inherited from RiddlNode

Inherited from AnyRef

Inherited from Any

Ungrouped