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
- Alphabetic
- By Inheritance
- CircuitState
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val annotations: AnnotationSeq
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val circuit: Circuit
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def deletedAnnotations: Seq[Annotation]
- def emittedCircuitOption: Option[EmittedCircuit]
Helper for getting just an emitted circuit
- def emittedComponents: Seq[EmittedComponent]
Helper function for extracting emitted components from annotations
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val form: CircuitForm
- def getAnnotationsOf(annoClasses: Class[_]*): AnnotationSeq
Returns all annotations which are of a class in annoClasses
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getEmittedCircuit: EmittedCircuit
Helper for getting an EmittedCircuit when it is known to exist
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val renames: Option[RenameMap]
- 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
- def resolvePathsOf(annoClasses: Class[_]*): CircuitState
Returns a new CircuitState with the targets of every annotation of a type in annoClasses
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
This is the documentation for Firrtl.