Trait

ml.combust.bundle.dsl

WritableShape

Related Doc: package dsl

Permalink

trait WritableShape extends ReadableShape

Trait for writable interface to a Shape.

Use this trait when serializing a Shape object, such as when writing a Node to a Bundle.ML file.

Linear Supertypes
ReadableShape, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WritableShape
  2. ReadableShape
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def bundleShape: bundle.Shape.Shape

    Permalink

    Create a protobuf shape.

    Create a protobuf shape.

    returns

    protobuf shape

    Definition Classes
    ReadableShape
  2. abstract def getInput(port: String): Option[Socket]

    Permalink

    Get an optional input by the port name.

    Get an optional input by the port name.

    port

    name of the port

    returns

    optional socket for the named port

    Definition Classes
    ReadableShape
  3. abstract def getOutput(port: String): Option[Socket]

    Permalink

    Get an optional input by the port name.

    Get an optional input by the port name.

    port

    name of the port

    returns

    optional socket for the named port

    Definition Classes
    ReadableShape
  4. abstract def input(port: String): Socket

    Permalink

    Get an input by the port name.

    Get an input by the port name.

    port

    name of port

    returns

    socket for named port

    Definition Classes
    ReadableShape
  5. abstract def inputs: Seq[Socket]

    Permalink

    Get list of all inputs.

    Get list of all inputs.

    returns

    list of inputs

    Definition Classes
    ReadableShape
  6. abstract def output(port: String): Socket

    Permalink

    Get an output by the port name.

    Get an output by the port name.

    port

    name of port

    returns

    socket for named port

    Definition Classes
    ReadableShape
  7. abstract def outputs: Seq[Socket]

    Permalink

    Get list of all outputs.

    Get list of all outputs.

    returns

    list of all outputs

    Definition Classes
    ReadableShape
  8. abstract def withInput(name: String, port: String): WritableShape.this.type

    Permalink

    Add an input socket to the shape.

    Add an input socket to the shape.

    name

    name of input socket

    port

    port of input socket

    returns

    copy of the shape with input socket added

  9. abstract def withOutput(name: String, port: String): WritableShape.this.type

    Permalink

    Add an output socket to the shape.

    Add an output socket to the shape.

    name

    name of output socket

    port

    port of output socket

    returns

    copy of the shape with output socket added

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. def standardInput: Socket

    Permalink

    Get the standard input socket.

    Get the standard input socket.

    The standard input socket is on port "input".

    returns

    standard input socket

    Definition Classes
    ReadableShape
  16. def standardOutput: Socket

    Permalink

    Get the standard output socket.

    Get the standard output socket.

    The standard output socket is on port "output".

    returns

    standard output socket

    Definition Classes
    ReadableShape
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. def withStandardIO(nameInput: String, nameOutput: String): WritableShape.this.type

    Permalink

    Add standard input/output sockets to the shape.

    Add standard input/output sockets to the shape.

    This is the same as calling WritableShape#withStandardInput and WritableShape#withStandardOutput.

    nameInput

    name of the input socket

    nameOutput

    name of the output socket

    returns

    copy of the shape with standard input/output sockets added

  23. def withStandardInput(name: String): WritableShape.this.type

    Permalink

    Add standard input socket to the shape.

    Add standard input socket to the shape.

    name

    name of standard input socket

    returns

    copy of the shape with standard input socket added

  24. def withStandardOutput(name: String): WritableShape.this.type

    Permalink

    Add standard output socket to the shape.

    Add standard output socket to the shape.

    name

    name of standard output socket

    returns

    copy of the shape with standard output socket added

Inherited from ReadableShape

Inherited from AnyRef

Inherited from Any

Ungrouped