Class/Object

ml.combust.bundle.dsl

Bundle

Related Docs: object Bundle | package dsl

Permalink

case class Bundle(name: String, format: SerializationFormat, version: String, attributes: Option[AttributeList], nodes: Seq[Any]) extends HasAttributeList[Bundle] with Product with Serializable

Root object for serializing Bundle.ML pipelines and graphs.

name

name of the bundle

format

serialization format of the Bundle

version

Bundle.ML version used for serializing

attributes

optional AttributeList to serialize with the bundle

nodes

list of root nodes in the bundle

Linear Supertypes
Serializable, Serializable, Product, Equals, HasAttributeList[Bundle], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bundle
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. HasAttributeList
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bundle(name: String, format: SerializationFormat, version: String, attributes: Option[AttributeList], nodes: Seq[Any])

    Permalink

    name

    name of the bundle

    format

    serialization format of the Bundle

    version

    Bundle.ML version used for serializing

    attributes

    optional AttributeList to serialize with the bundle

    nodes

    list of root nodes in the bundle

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 attr(name: String): Attribute

    Permalink

    Get an attribute.

    Get an attribute.

    Throws an error if it does not exist.

    name

    name of the attribute

    returns

    the attribute

    Definition Classes
    HasAttributeList
  6. val attributes: Option[AttributeList]

    Permalink

    optional AttributeList to serialize with the bundle

    optional AttributeList to serialize with the bundle

    Definition Classes
    BundleHasAttributeList
  7. def bundleContext[Context](context: Context, bundleRegistry: BundleRegistry, path: File): BundleContext[Context]

    Permalink

    Create a BundleContext for serializing to Bundle.ML

    Create a BundleContext for serializing to Bundle.ML

    Context

    context for implementation

    bundleRegistry

    bundle registry for serializing ops, nodes, and custom types

    path

    path to the Bundle.ML directory

    returns

    context for serializing Bundle.ML

  8. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. val format: SerializationFormat

    Permalink

    serialization format of the Bundle

  12. def getAttr(name: String): Option[Attribute]

    Permalink

    Get an attribute as an option.

    Get an attribute as an option.

    name

    name of the attribute

    returns

    Some(attribute) or None if it is not in the list

    Definition Classes
    HasAttributeList
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def getValue(name: String): Option[Value]

    Permalink

    Get the Value of an attribute as an Option.

    Get the Value of an attribute as an Option.

    name

    name of the attribute

    returns

    Value of the attribute as an Option[Value], None if it does not exist

    Definition Classes
    HasAttributeList
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. def meta(implicit hr: HasBundleRegistry): BundleMeta

    Permalink

    Create meta data for this bundle.

    Create meta data for this bundle.

    hr

    bundle registry for custom types

    returns

    bundle meta data

  17. val name: String

    Permalink

    name of the bundle

  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. val nodes: Seq[Any]

    Permalink

    list of root nodes in the bundle

  20. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  22. def replaceAttrList(list: Option[AttributeList]): Bundle

    Permalink

    Replace the attributes with another list.

    Replace the attributes with another list.

    list

    attributes to use to replace

    returns

    copy of T with attributes replaced by list arg

    Definition Classes
    BundleHasAttributeList
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. def value(name: String): Value

    Permalink

    Get the Value of an attribute.

    Get the Value of an attribute.

    Throws an error if that attribute does not exist.

    name

    name of the attribute

    returns

    Value of the attribute

    Definition Classes
    HasAttributeList
  25. val version: String

    Permalink

    Bundle.ML version used for serializing

  26. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def withAttr(name: String, value: Option[Value]): Bundle

    Permalink

    Add an optional attribute to the list.

    Add an optional attribute to the list.

    name

    name of the attribute

    value

    optional value

    returns

    a copy of T with the attribute optionally added

    Definition Classes
    HasAttributeList
  30. def withAttr(name: String, value: Value): Bundle

    Permalink

    Add an attribute to the list.

    Add an attribute to the list.

    name

    name of the attribute

    value

    value of the attribute

    returns

    a copy of T with the attribute added

    Definition Classes
    HasAttributeList
  31. def withAttr(attribute: Option[Attribute]): Bundle

    Permalink

    Add an optional attribute to the list.

    Add an optional attribute to the list.

    attribute

    optional attribute to add to the list

    returns

    a copy of T with the attribute optionally added

    Definition Classes
    HasAttributeList
  32. def withAttr(attribute: Attribute): Bundle

    Permalink

    Add an attribute to the list.

    Add an attribute to the list.

    attribute

    attribute to add to the list

    returns

    a copy of T with the attribute added to the attribute list

    Definition Classes
    HasAttributeList
  33. def withAttrList(list: AttributeList): Bundle

    Permalink

    Add a list of attributes to attributes.

    Add a list of attributes to attributes.

    Adds all attributes in the list argument to attributes.

    list

    list of attributes to add

    returns

    copy of T with all attributes added to attributes

    Definition Classes
    HasAttributeList

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HasAttributeList[Bundle]

Inherited from AnyRef

Inherited from Any

Ungrouped