Packages

case class CircuitState(circuit: Circuit, form: CircuitForm, annotations: AnnotationSeq, renames: Option[RenameMap]) 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

Source
Compiler.scala
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: AnnotationSeq, renames: Option[RenameMap])

    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
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val annotations: AnnotationSeq
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val circuit: Circuit
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def deletedAnnotations: Seq[Annotation]
  9. def emittedCircuitOption: Option[EmittedCircuit]

    Helper for getting just an emitted circuit

  10. def emittedComponents: Seq[EmittedComponent]

    Helper function for extracting emitted components from annotations

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. val form: CircuitForm
  14. def getAnnotationsOf(annoClasses: Class[_]*): AnnotationSeq

    Returns all annotations which are of a class in annoClasses

  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getEmittedCircuit: EmittedCircuit

    Helper for getting an EmittedCircuit when it is known to exist

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. val renames: Option[RenameMap]
  22. def resolvePaths(targets: Seq[CompleteTarget]): CircuitState

    Returns a new CircuitState with all targets being resolved.

    Returns a new CircuitState with all targets being resolved. Paths through instances are replaced with a uniquified final target Includes modifying the circuit and annotations

  23. def resolvePathsOf(annoClasses: Class[_]*): CircuitState

    Returns a new CircuitState with the targets of every annotation of a type in annoClasses

  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped