Class/Object

firrtl.stage.transforms

UpdateAnnotations

Related Docs: object UpdateAnnotations | package transforms

Permalink

class UpdateAnnotations extends Transform with WrappedTransform with Translator[CircuitState, (CircuitState, CircuitState)]

Source
UpdateAnnotations.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UpdateAnnotations
  2. Translator
  3. WrappedTransform
  4. Transform
  5. DependencyAPI
  6. TransformLike
  7. LazyLogging
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UpdateAnnotations(underlying: Transform)

    Permalink

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. def aToB(a: CircuitState): (CircuitState, CircuitState)

    Permalink

    A method converting type A into type B

    A method converting type A into type B

    returns

    an object of type B

    Definition Classes
    UpdateAnnotationsTranslator
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def bToA(b: (CircuitState, CircuitState)): CircuitState

    Permalink

    A method converting type B back into type A

    A method converting type B back into type A

    returns

    an object of type A

    Definition Classes
    UpdateAnnotationsTranslator
  7. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def execute(c: CircuitState): CircuitState

    Permalink

    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
    UpdateAnnotationsTransform
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. def inputForm: CircuitForm

    Permalink
    Definition Classes
    WrappedTransform
  15. def internalTransform(b: (CircuitState, CircuitState)): (CircuitState, CircuitState)

    Permalink

    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
    UpdateAnnotationsTranslator
  16. final def invalidates(b: Transform): Boolean

    Permalink
    Definition Classes
    WrappedTransform
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  19. final lazy val name: String

    Permalink
    Definition Classes
    WrappedTransform
  20. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  23. def optionalPrerequisiteOf: Seq[Dependency[Transform]]

    Permalink
    Definition Classes
    WrappedTransform
  24. def optionalPrerequisites: Seq[Dependency[Transform]]

    Permalink

    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
    TransformDependencyAPI
    Note

    The use of a Seq here is to preserve input order. Internally, this will be converted to a private, ordered Set.

  25. def outputForm: CircuitForm

    Permalink
    Definition Classes
    WrappedTransform
  26. def prerequisites: Seq[Dependency[Transform]]

    Permalink
    Definition Classes
    WrappedTransform
  27. final def runTransform(state: CircuitState): CircuitState

    Permalink

    Perform the transform and update annotations.

    Perform the transform and update annotations.

    state

    Input Firrtl AST

    returns

    A transformed Firrtl AST

    Definition Classes
    Transform
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  30. final def transform(a: CircuitState): CircuitState

    Permalink

    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
    TranslatorTransformLike
  31. final lazy val trueUnderlying: Transform

    Permalink

    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
  32. val underlying: Transform

    Permalink

    The underlying firrtl.Transform

    The underlying firrtl.Transform

    Definition Classes
    UpdateAnnotationsWrappedTransform
  33. final def wait(): Unit

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

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

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

Deprecated Value Members

  1. def dependents: Seq[Dependency[Transform]]

    Permalink
    Definition Classes
    WrappedTransform
    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.3) Due to confusion, 'dependents' is being renamed to 'optionalPrerequisiteOf'. Override the latter instead.

  2. final def getMyAnnotations(state: CircuitState): Seq[Annotation]

    Permalink

    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

Inherited from WrappedTransform

Inherited from Transform

Inherited from DependencyAPI[Transform]

Inherited from TransformLike[CircuitState]

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped