chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package firrtl
  Definition Classes
    root
-  package options
  Definition Classes
    firrtl
-  package phases
  Definition Classes
    options
- AddDefaults
- Checks
- GetIncludes
- WriteOutputAnnotations

c

firrtl.options.phases

# WriteOutputAnnotations

###

#### class WriteOutputAnnotations extends Phase

Phase that writes an AnnotationSeq to the filesystem, according to the following rules: 1) Annotations which extend CustomFileEmission are written seperately to their prescribed destinations and replaced per replacements]]. 2) All remaining annotations are written to destination specified by annotationFileOut, iff the stage option is set, with the following exception: a) Annotations extending Unserializable are not written b) Annotations extending CustomFileEmission are written to the file they specify using the serialization they define. They show up in the output Annotation file using their "replacements", if one is specified.

Source
  WriteOutputAnnotations.scala

Linear Supertypes
Phase, DependencyAPI[Phase], TransformLike[AnnotationSeq], LazyLogging, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. WriteOutputAnnotations
2. Phase
3. DependencyAPI
4. TransformLike
5. LazyLogging
6. AnyRef
7. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new WriteOutputAnnotations()

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from WriteOutputAnnotations toany2stringadd[WriteOutputAnnotations] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (WriteOutputAnnotations, B)
   Implicit
     This member is added by an implicit conversion from WriteOutputAnnotations toArrowAssoc[WriteOutputAnnotations] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  def ensuring(cond: (WriteOutputAnnotations) => Boolean, msg: => Any): WriteOutputAnnotations
   Implicit
     This member is added by an implicit conversion from WriteOutputAnnotations toEnsuring[WriteOutputAnnotations] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (WriteOutputAnnotations) => Boolean): WriteOutputAnnotations
   Implicit
     This member is added by an implicit conversion from WriteOutputAnnotations toEnsuring[WriteOutputAnnotations] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): WriteOutputAnnotations
    Implicit
      This member is added by an implicit conversion from WriteOutputAnnotations toEnsuring[WriteOutputAnnotations] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): WriteOutputAnnotations
    Implicit
      This member is added by an implicit conversion from WriteOutputAnnotations toEnsuring[WriteOutputAnnotations] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
15.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def getLogger: Logger
    Definition Classes
      LazyLogging
17.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
18.  def invalidates(a: Phase): Boolean

    A function that, given *another* transform (parameter `a`) will return true if this transform invalidates/undos the effects of the *other* transform (parameter `a`).

    A function that, given *another* transform (parameter `a`) will return true if this transform invalidates/undos the effects of the *other* transform (parameter `a`).

    a

      transform

    Definition Classes
      WriteOutputAnnotations → DependencyAPI
19.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
20.  val logger: Logger
    Attributes
      protected
    Definition Classes
      LazyLogging
21.  lazy val name: String

    The name of this Phase.

    The name of this Phase. This will be used to generate debug/error messages or when deleting annotations. This will default to the `simpleName` of the class.

    returns

      this phase's name

    Definition Classes
      Phase → TransformLike
    Note

      Override this with your own implementation for different naming behavior.

22.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
23.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
24.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
25.  def optionalPrerequisiteOf: Seq[Nothing]

    A sequence of transforms to add this transform as an `optionalPrerequisite`.

    A sequence of transforms to add this transform as an `optionalPrerequisite`. The use of `optionalPrerequisiteOf` enables the transform declaring them to always run before some other transforms. However, declaring `optionalPrerequisiteOf` will not result in the sequence of transforms executing.

    This is useful for providing an ordering constraint to guarantee that other transforms (e.g., emitters) will not be scheduled before you.

    Definition Classes
      WriteOutputAnnotations → DependencyAPI
    Note

      This method **will not** result in the listed transforms running. If you want to add multiple transforms at once, you should use a `DependencyManager` with multiple targets.

26.  def optionalPrerequisites: Seq[Dependency[Phase]]

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

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

27.  def prerequisites: Seq[Dependency[Phase { ... /* 2 definitions in type refinement */ }]]

    All transform that must run before this transform

    All transform that must run before this transform

    Definition Classes
      WriteOutputAnnotations → DependencyAPI
    Note

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

28.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
29.  def toString(): String
    Definition Classes
      AnyRef → Any
30.  def transform(annotations: AnnotationSeq): AnnotationSeq

    Write the input AnnotationSeq to a fie.

    Write the input AnnotationSeq to a fie.

    returns

      an output object of the same type

    Definition Classes
      WriteOutputAnnotations → TransformLike
31.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
32.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
33.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from WriteOutputAnnotations toStringFormat[WriteOutputAnnotations] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): (WriteOutputAnnotations, B)
   Implicit
     This member is added by an implicit conversion from WriteOutputAnnotations toArrowAssoc[WriteOutputAnnotations] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from Phase

### Inherited from DependencyAPI[Phase]

### Inherited from TransformLike[AnnotationSeq]

### Inherited from LazyLogging

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromWriteOutputAnnotations to any2stringadd[WriteOutputAnnotations]

### Inherited by implicit conversion StringFormat fromWriteOutputAnnotations to StringFormat[WriteOutputAnnotations]

### Inherited by implicit conversion Ensuring fromWriteOutputAnnotations to Ensuring[WriteOutputAnnotations]

### Inherited by implicit conversion ArrowAssoc fromWriteOutputAnnotations to ArrowAssoc[WriteOutputAnnotations]

### Ungrouped