Class

firrtl

CircuitState

Related Doc: package firrtl

Permalink

case class CircuitState(circuit: Circuit, form: CircuitForm, annotations: Option[AnnotationMap] = None, renames: Option[RenameMap] = None) extends Product with Serializable

Current State of the Circuit

circuit

The current state of the Firrtl AST

form

The current form of the circuit

annotations

The current collection of Annotation

renames

A map of Named things that have been renamed. Generally only a return value from Transforms

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

Instance Constructors

  1. new CircuitState(circuit: Circuit, form: CircuitForm, annotations: Option[AnnotationMap] = None, renames: Option[RenameMap] = None)

    Permalink

    Creates a CircuitState object

    Creates a CircuitState object

    circuit

    The current state of the Firrtl AST

    form

    The current form of the circuit

    annotations

    The current collection of Annotation

    renames

    A map of Named things that have been renamed. Generally only a return value from Transforms

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. val annotations: Option[AnnotationMap]

    Permalink

    The current collection of Annotation

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val circuit: Circuit

    Permalink

    The current state of the Firrtl AST

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def deletedAnnotations: Seq[Annotation]

    Permalink
  9. def emittedCircuitOption: Option[EmittedCircuit]

    Permalink

    Helper for getting just an emitted circuit

  10. def emittedComponents: Seq[EmittedComponent]

    Permalink

    Helper function for extracting emitted components from annotations

  11. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. val form: CircuitForm

    Permalink

    The current form of the circuit

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def getEmittedCircuit: EmittedCircuit

    Permalink

    Helper for getting an EmittedCircuit when it is known to exist

  16. final def isInstanceOf[T0]: Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  20. val renames: Option[RenameMap]

    Permalink

    A map of Named things that have been renamed.

    A map of Named things that have been renamed. Generally only a return value from Transforms

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped