chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package firrtl
  Definition Classes
    root
-  package annotations
  Definition Classes
    firrtl
-  package graph
  Definition Classes
    firrtl
-  package ir
  Definition Classes
    firrtl
-  package options
  Definition Classes
    firrtl
-  package passes
  Definition Classes
    firrtl
-  package renamemap
  Definition Classes
    firrtl
-  package stage

  The stage package provides Stage/Phase infrastructure for FIRRTL compilers:

  The stage package provides Stage/Phase infrastructure for FIRRTL compilers:

  - A number of support Phases
  - FirrtlOptions, a class representing options common to FIRRTL compilers
  - FirrtlOptionsView, a utility that constructs an OptionsView of FirrtlOptions from an AnnotationSeq
  Definition Classes
    firrtl
-  package transforms
  Definition Classes
    firrtl
-  package util
  Definition Classes
    firrtl
- AnnotationSeq
- BuildInfo
- CDefMPort
- CDefMemory
- EmittedAnnotation
- EmittedCircuit
- EmittedCircuitAnnotation
- EmittedComponent
- EmittedFirrtlCircuit
- EmittedFirrtlCircuitAnnotation
- EmittedVerilogCircuit
- EmittedVerilogCircuitAnnotation
- FileUtils
- FirrtlUserException
- MInfer
- MPortDir
- MRead
- MReadWrite
- MWrite
- Parser
- PrimOps
- RenameMap
- Utils

t

firrtl

# EmittedAnnotation

###

#### trait EmittedAnnotation[T <: EmittedComponent] extends NoTargetAnnotation with CustomFileEmission

Traits for Annotations containing emitted components

Source
  Emitter.scala

Linear Supertypes
CustomFileEmission, NoTargetAnnotation, Annotation, Product, Equals, AnyRef, Any
Known Subclasses
EmittedCircuitAnnotation, EmittedFirrtlCircuitAnnotation, EmittedVerilogCircuitAnnotation
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. EmittedAnnotation
2. CustomFileEmission
3. NoTargetAnnotation
4. Annotation
5. Product
6. Equals
7. AnyRef
8. 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

### Abstract Value Members

1.  abstract def canEqual(that: Any): Boolean
   Definition Classes
     Equals
2.  abstract def getBytes: Iterable[Byte]

   A method that can convert this annotation to bytes that will be written to a file.

   A method that can convert this annotation to bytes that will be written to a file.

   If you only need to serialize a string, you can use the `getBytes` method:

       def getBytes: Iterable[Byte] = myString.getBytes

   Definition Classes
     CustomFileEmission
3.  abstract def productArity: Int
   Definition Classes
     Product
4.  abstract def productElement(n: Int): Any
   Definition Classes
     Product
5.  abstract val value: T

### Concrete 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 EmittedAnnotation[T] toany2stringadd[EmittedAnnotation[T]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (EmittedAnnotation[T], B)
   Implicit
     This member is added by an implicit conversion from EmittedAnnotation[T] toArrowAssoc[EmittedAnnotation[T]] 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 baseFileName(annotations: AnnotationSeq): String

   Output filename where serialized content will be written

   Output filename where serialized content will be written

   The full annotation sequence is a parameter to allow for the location where this annotation will be serialized to be a function of other annotations, e.g., if the location where information is written is controlled by a separate file location annotation.

   annotations

     the annotation sequence at the time of emission

   Attributes
     protected
   Definition Classes
     EmittedAnnotation → CustomFileEmission
8.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
9.  def ensuring(cond: (EmittedAnnotation[T]) => Boolean, msg: => Any): EmittedAnnotation[T]
   Implicit
     This member is added by an implicit conversion from EmittedAnnotation[T] toEnsuring[EmittedAnnotation[T]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: (EmittedAnnotation[T]) => Boolean): EmittedAnnotation[T]
    Implicit
      This member is added by an implicit conversion from EmittedAnnotation[T] toEnsuring[EmittedAnnotation[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean, msg: => Any): EmittedAnnotation[T]
    Implicit
      This member is added by an implicit conversion from EmittedAnnotation[T] toEnsuring[EmittedAnnotation[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: Boolean): EmittedAnnotation[T]
    Implicit
      This member is added by an implicit conversion from EmittedAnnotation[T] toEnsuring[EmittedAnnotation[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
14.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
15.  final def filename(annotations: AnnotationSeq): File

    Method that returns the filename where this annotation will be serialized.

    Method that returns the filename where this annotation will be serialized.

    annotations

      the annotations at the time of serialization

    Definition Classes
      CustomFileEmission
16.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
17.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
18.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
19.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
20.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
21.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
22.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
23.  def productElementName(n: Int): String
    Definition Classes
      Product
24.  def productElementNames: Iterator[String]
    Definition Classes
      Product
25.  def productIterator: Iterator[Any]
    Definition Classes
      Product
26.  def productPrefix: String
    Definition Classes
      Product
27.  def replacements(file: File): AnnotationSeq

    Optionally, a sequence of annotations that will replace this annotation in the output annotation file.

    Optionally, a sequence of annotations that will replace this annotation in the output annotation file.

    A non-empty implementation of this method is a mechanism for telling a downstream Stage how to deserialize the information that was serialized to a separate file. For example, if a FIRRTL circuit is serialized to a separate file, this method could include an input file annotation that a later stage can use to read the serialized FIRRTL circuit back in.

    Definition Classes
      CustomFileEmission
28.  def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
      Annotation
    Note

      rarely used

29.  val suffix: Option[String]

    Optional suffix of the output file

    Optional suffix of the output file

    Attributes
      protected
    Definition Classes
      EmittedAnnotation → CustomFileEmission
30.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
31.  def toString(): String
    Definition Classes
      AnyRef → Any
32.  def update(renames: RenameMap): Seq[NoTargetAnnotation]

    Update the target based on how signals are renamed

    Update the target based on how signals are renamed

    Definition Classes
      NoTargetAnnotation → Annotation
33.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
34.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
35.  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 EmittedAnnotation[T] toStringFormat[EmittedAnnotation[T]] 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): (EmittedAnnotation[T], B)
   Implicit
     This member is added by an implicit conversion from EmittedAnnotation[T] toArrowAssoc[EmittedAnnotation[T]] 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 CustomFileEmission

### Inherited from NoTargetAnnotation

### Inherited from Annotation

### Inherited from Product

### Inherited from Equals

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromEmittedAnnotation[T] to any2stringadd[EmittedAnnotation[T]]

### Inherited by implicit conversion StringFormat fromEmittedAnnotation[T] to StringFormat[EmittedAnnotation[T]]

### Inherited by implicit conversion Ensuring fromEmittedAnnotation[T] to Ensuring[EmittedAnnotation[T]]

### Inherited by implicit conversion ArrowAssoc fromEmittedAnnotation[T] to ArrowAssoc[EmittedAnnotation[T]]

### Ungrouped