Packages

case class Plant(loc: Location, id: AST.Identifier, pipes: Seq[Pipe] = Seq.empty[Pipe], processors: Seq[Processor] = Seq.empty[Processor], inJoints: Seq[InletJoint] = Seq.empty[InletJoint], outJoints: Seq[OutletJoint] = Seq.empty[OutletJoint], terms: Seq[Term] = Seq.empty[Term], includes: Seq[Include] = Seq.empty[Include], authors: Seq[AuthorInfo] = Seq.empty[AuthorInfo], brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None) extends DomainDefinition with WithIncludes with WithTerms with WithAuthors with Product with Serializable

The definition of a plant which brings pipes, processors and joints together into a closed system of data processing.

loc

The location of the plant definition

id

The name of the plant

pipes

The set of pipes involved in the plant

processors

The set of processors involved in the plant.

inJoints

The InletJoints connecting pipes and processors

outJoints

The OutletJoints connecting pipes and processors

brief

A brief description (one sentence) for use in documentation

description

An optional description of the plant

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Plant
  2. Serializable
  3. Product
  4. Equals
  5. WithAuthors
  6. WithTerms
  7. WithIncludes
  8. DomainDefinition
  9. Definition
  10. Container
  11. BrieflyDescribedValue
  12. DescribedValue
  13. RiddlValue
  14. RiddlNode
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Plant(loc: Location, id: AST.Identifier, pipes: Seq[Pipe] = Seq.empty[Pipe], processors: Seq[Processor] = Seq.empty[Processor], inJoints: Seq[InletJoint] = Seq.empty[InletJoint], outJoints: Seq[OutletJoint] = Seq.empty[OutletJoint], terms: Seq[Term] = Seq.empty[Term], includes: Seq[Include] = Seq.empty[Include], authors: Seq[AuthorInfo] = Seq.empty[AuthorInfo], brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None)

    loc

    The location of the plant definition

    id

    The name of the plant

    pipes

    The set of pipes involved in the plant

    processors

    The set of processors involved in the plant.

    inJoints

    The InletJoints connecting pipes and processors

    outJoints

    The OutletJoints connecting pipes and processors

    brief

    A brief description (one sentence) for use in documentation

    description

    An optional description of the plant

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 authors: Seq[AuthorInfo]
    Definition Classes
    PlantWithAuthors
  6. val brief: Option[AST.LiteralString]
    Definition Classes
    PlantBrieflyDescribedValue
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. def containedDefinitions: Seq[AST.Definition]
    Definition Classes
    WithIncludes
  9. lazy val contents: Seq[AST.PlantDefinition]
    Definition Classes
    PlantContainer
  10. val description: Option[AST.Description]
    Definition Classes
    PlantDescribedValue
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def format: String

    Format the node to a string

    Format the node to a string

    Definition Classes
    RiddlNode
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def hasAuthors: Boolean
    Definition Classes
    WithAuthorsDefinition
  15. def hasOptions: Boolean
    Definition Classes
    Definition
  16. def hasTypes: Boolean
    Definition Classes
    Definition
  17. val id: AST.Identifier
    Definition Classes
    PlantDefinition
  18. def identify: String
    Definition Classes
    Definition
  19. def identifyWithLoc: String
    Definition Classes
    Definition
  20. val inJoints: Seq[InletJoint]
  21. val includes: Seq[Include]
    Definition Classes
    PlantWithIncludes
  22. def isContainer: Boolean

    Determine if this node is a container or not

    Determine if this node is a container or not

    Definition Classes
    ContainerRiddlNode
  23. 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
  24. def isImplicit: Boolean
    Definition Classes
    Definition
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def isRootContainer: Boolean
    Definition Classes
    Container
  27. final val kind: String
    Definition Classes
    PlantDefinition
  28. def kindId: String
    Definition Classes
    Definition
  29. 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
    PlantRiddlValue
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def nonEmpty: Boolean
    Definition Classes
    RiddlNode
    Annotations
    @deprecatedOverriding()
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  34. val outJoints: Seq[OutletJoint]
  35. val pipes: Seq[Pipe]
  36. val processors: Seq[Processor]
  37. def productElementNames: Iterator[String]
    Definition Classes
    Product
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. val terms: Seq[Term]
    Definition Classes
    PlantWithTerms
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  42. 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 WithAuthors

Inherited from WithTerms

Inherited from WithIncludes

Inherited from AST.DomainDefinition

Inherited from AST.Definition

Inherited from AST.DescribedValue

Inherited from AST.RiddlValue

Inherited from AST.RiddlNode

Inherited from AnyRef

Inherited from Any

Ungrouped