class UpdateAnnotations extends Transform with WrappedTransform with Translator[CircuitState, (CircuitState, CircuitState)]
- Alphabetic
- By Inheritance
- UpdateAnnotations
- Translator
- WrappedTransform
- Transform
- DependencyAPI
- TransformLike
- LazyLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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
-
def
aToB(a: CircuitState): (CircuitState, CircuitState)
A method converting type
A
into typeB
A method converting type
A
into typeB
- returns
an object of type
B
- Definition Classes
- UpdateAnnotations → Translator
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
bToA(b: (CircuitState, CircuitState)): CircuitState
A method converting type
B
back into typeA
A method converting type
B
back into typeA
- returns
an object of type
A
- Definition Classes
- UpdateAnnotations → Translator
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
execute(c: CircuitState): CircuitState
Perform the transform, encode renaming with RenameMap, and can delete annotations Called by runTransform.
Perform the transform, encode renaming with RenameMap, and can delete annotations Called by runTransform.
- returns
A transformed Firrtl AST
- Definition Classes
- UpdateAnnotations → Transform
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
inputForm: CircuitForm
- Definition Classes
- WrappedTransform
-
def
internalTransform(b: (CircuitState, CircuitState)): (CircuitState, CircuitState)
A transform on an internal type
A transform on an internal type
- b
an object of type
B
- returns
an object of type
B
- Definition Classes
- UpdateAnnotations → Translator
-
final
def
invalidates(b: Transform): Boolean
- Definition Classes
- WrappedTransform
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
logger: Logger
- Attributes
- protected
- Definition Classes
- LazyLogging
-
final
lazy val
name: String
- Definition Classes
- WrappedTransform
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
optionalPrerequisiteOf: Seq[Dependency[Transform]]
- Definition Classes
- WrappedTransform
-
def
optionalPrerequisites: Seq[Dependency[Transform]]
All transforms that, if a prerequisite of *another* transform, will run before this transform.
All transforms that, if a prerequisite of *another* transform, will run before this transform.
- Definition Classes
- Transform → DependencyAPI
- Note
The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.
-
def
outputForm: CircuitForm
- Definition Classes
- WrappedTransform
-
def
prerequisites: Seq[Dependency[Transform]]
- Definition Classes
- WrappedTransform
-
final
def
runTransform(state: CircuitState): CircuitState
Perform the transform and update annotations.
Perform the transform and update annotations.
- state
Input Firrtl AST
- returns
A transformed Firrtl AST
- Definition Classes
- Transform
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
transform(a: CircuitState): CircuitState
Convert the input object to the internal type, transform the internal type, and convert back to the original type
Convert the input object to the internal type, transform the internal type, and convert back to the original type
- a
an input object
- returns
an output object of the same type
- Definition Classes
- Translator → TransformLike
-
final
lazy val
trueUnderlying: Transform
Return the original firrtl.Transform if this wrapper is wrapping other wrappers.
Return the original firrtl.Transform if this wrapper is wrapping other wrappers.
- Definition Classes
- WrappedTransform
-
val
underlying: Transform
The underlying firrtl.Transform
The underlying firrtl.Transform
- Definition Classes
- UpdateAnnotations → WrappedTransform
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
Deprecated Value Members
-
def
dependents: Seq[Dependency[Transform]]
- Definition Classes
- WrappedTransform
- Annotations
- @deprecated
- Deprecated
(Since version FIRRTL 1.3) Due to confusion, 'dependents' is being renamed to 'optionalPrerequisiteOf'. Override the latter instead.
-
final
def
getMyAnnotations(state: CircuitState): Seq[Annotation]
Convenience method to get annotations relevant to this Transform
Convenience method to get annotations relevant to this Transform
- state
The CircuitState form which to extract annotations
- returns
A collection of annotations
- Definition Classes
- Transform
- Annotations
- @deprecated
- Deprecated
(Since version 1.1) Just collect the actual Annotation types the transform wants
This is the documentation for Firrtl.