chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package chisel3

  This package contains the main chisel3 API.

  This package contains the main chisel3 API.

  Definition Classes
    root
-  package aop
  Definition Classes
    chisel3
-  package injecting
  Definition Classes
    aop
-  package inspecting
  Definition Classes
    aop
- Aspect
- AspectLibrary
- Select

c

chisel3.aop

# Aspect

###
Companion object Aspect

#### abstract class Aspect[T <: RawModule] extends Annotation with Unserializable with NoTargetAnnotation

Represents an aspect of a Chisel module, by specifying what behavior should be done to instance, via the FIRRTL Annotation Mechanism

T

  Type of top-level module

Source
  Aspect.scala

Linear Supertypes
NoTargetAnnotation, Unserializable, Annotation, Product, Equals, AnyRef, Any
Known Subclasses
InjectingAspect, InjectorAspect, InspectingAspect, InspectorAspect
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Aspect
2. NoTargetAnnotation
3. Unserializable
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

### Instance Constructors

1.  new Aspect()

### Abstract Value Members

1.  abstract def canEqual(that: Any): Boolean
   Definition Classes
     Equals
2.  abstract def productArity: Int
   Definition Classes
     Product
3.  abstract def productElement(n: Int): Any
   Definition Classes
     Product
4.  abstract def toAnnotation(top: T): AnnotationSeq

   Convert this Aspect to a seq of FIRRTL annotation

### 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 Aspect[T] toany2stringadd[Aspect[T]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (Aspect[T], B)
   Implicit
     This member is added by an implicit conversion from Aspect[T] toArrowAssoc[Aspect[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 clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  def ensuring(cond: (Aspect[T]) => Boolean, msg: => Any): Aspect[T]
   Implicit
     This member is added by an implicit conversion from Aspect[T] toEnsuring[Aspect[T]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (Aspect[T]) => Boolean): Aspect[T]
   Implicit
     This member is added by an implicit conversion from Aspect[T] toEnsuring[Aspect[T]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): Aspect[T]
    Implicit
      This member is added by an implicit conversion from Aspect[T] toEnsuring[Aspect[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): Aspect[T]
    Implicit
      This member is added by an implicit conversion from Aspect[T] toEnsuring[Aspect[T]] 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 hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
19.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
20.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
21.  def productElementName(n: Int): String
    Definition Classes
      Product
22.  def productElementNames: Iterator[String]
    Definition Classes
      Product
23.  def productIterator: Iterator[Any]
    Definition Classes
      Product
24.  def productPrefix: String
    Definition Classes
      Product
25.  def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
      Annotation
    Note

      rarely used

26.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
27.  def toString(): String
    Definition Classes
      AnyRef → Any
28.  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
29.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
30.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
31.  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 Aspect[T] toStringFormat[Aspect[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): (Aspect[T], B)
   Implicit
     This member is added by an implicit conversion from Aspect[T] toArrowAssoc[Aspect[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 NoTargetAnnotation

### Inherited from Unserializable

### Inherited from Annotation

### Inherited from Product

### Inherited from Equals

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromAspect[T] to any2stringadd[Aspect[T]]

### Inherited by implicit conversion StringFormat fromAspect[T] to StringFormat[Aspect[T]]

### Inherited by implicit conversion Ensuring fromAspect[T] to Ensuring[Aspect[T]]

### Inherited by implicit conversion ArrowAssoc fromAspect[T] to ArrowAssoc[Aspect[T]]

### Ungrouped