chisel
7.9.0+2-5294dafe-SNAPSHOT
API
Generated with
chisel/firrtl/EmittedCircuitAnnotation

EmittedCircuitAnnotation

firrtl.EmittedCircuitAnnotation
sealed trait EmittedCircuitAnnotation[T <: EmittedCircuit] extends EmittedAnnotation[T]

Attributes

Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
Emitter.scala
Graph
Supertypes
trait Annotation
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Value members

Concrete methods

override 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

Attributes

Definition Classes
Source
Emitter.scala

Inherited methods

override protected 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.

Value parameters

annotations

the annotation sequence at the time of emission

Attributes

Definition Classes
Inherited from:
EmittedAnnotation
Source
Emitter.scala
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.

Value parameters

annotations

the annotations at the time of serialization

Attributes

Inherited from:
CustomFileEmission
Source
StageAnnotations.scala
def productElementName(n: Int): String

Attributes

Inherited from:
Product
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def productPrefix: String

Attributes

Inherited from:
Product
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.

Attributes

Inherited from:
CustomFileEmission
Source
StageAnnotations.scala
def serialize: String

Optional pretty print

Optional pretty print

Attributes

Note

rarely used

Inherited from:
Annotation
Source
Annotation.scala
def update(renames: RenameMap): Seq[NoTargetAnnotation]

Update the target based on how signals are renamed

Update the target based on how signals are renamed

Attributes

Inherited from:
NoTargetAnnotation
Source
Annotation.scala

Inherited and Abstract methods

def canEqual(that: Any): Boolean

Attributes

Inherited from:
Equals
def productArity: Int

Attributes

Inherited from:
Product
def productElement(n: Int): Any

Attributes

Inherited from:
Product

Inherited fields

override protected val suffix: Option[String]

Optional suffix of the output file

Optional suffix of the output file

Attributes

Inherited from:
EmittedAnnotation
Source
Emitter.scala

Inherited and Abstract fields

val value: T

Attributes

Inherited from:
EmittedAnnotation
Source
Emitter.scala
Generated with