Packages

case class InletJoint(loc: Location, id: AST.Identifier, inletRef: InletRef, pipe: PipeRef, brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None) extends Joint with Product with Serializable

A joint that connects an Processor's Inlet to a Pipe.

loc

The location of the InletJoint

id

The name of the inlet joint

inletRef

A reference to the inlet being connected

pipe

A reference to the pipe being connected

brief

A brief description (one sentence) for use in documentation

description

An optional description of the joint

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

Instance Constructors

  1. new InletJoint(loc: Location, id: AST.Identifier, inletRef: InletRef, pipe: PipeRef, brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None)

    loc

    The location of the InletJoint

    id

    The name of the inlet joint

    inletRef

    A reference to the inlet being connected

    pipe

    A reference to the pipe being connected

    brief

    A brief description (one sentence) for use in documentation

    description

    An optional description of the joint

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
    InletJointBrieflyDescribedValue
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. final def contents: Seq[AST.Definition]
    Definition Classes
    LeafDefinitionContainer
  8. val description: Option[AST.Description]
    Definition Classes
    InletJointDescribedValue
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def format: String

    Format the node to a string

    Format the node to a string

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

    Determine if this node is a container or not

    Determine if this node is a container or not

    Definition Classes
    ContainerRiddlNode
  20. final 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
    AlwaysEmptyContainerRiddlNode
  21. def isImplicit: Boolean
    Definition Classes
    Definition
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def isRootContainer: Boolean
    Definition Classes
    Container
  24. final val kind: String
    Definition Classes
    InletJointDefinition
  25. def kindId: String
    Definition Classes
    Definition
  26. 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
    InletJointRiddlValue
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def nonEmpty: Boolean
    Definition Classes
    RiddlNode
    Annotations
    @deprecatedOverriding()
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. val pipe: PipeRef
  32. def productElementNames: Iterator[String]
    Definition Classes
    Product
  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. 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 Joint

Inherited from AST.ContextDefinition

Inherited from AST.PlantDefinition

Inherited from AST.AlwaysEmpty

Inherited from AST.LeafDefinition

Inherited from AST.Definition

Inherited from AST.DescribedValue

Inherited from AST.RiddlValue

Inherited from AST.RiddlNode

Inherited from AnyRef

Inherited from Any

Ungrouped