Packages

t

chisel3.experimental

AffectsChiselPrefix

trait AffectsChiselPrefix extends AnyRef

Generate prefixes from values of this type in the Chisel compiler plugin

Users can mixin this trait to tell the Chisel compiler plugin to include the names of vals of this type when generating prefixes for naming Data and Mem instances. This is generally useful whenever creating a class that contains Data, Mem, or Module instances but does not itself extend Data or Module.

Source
package.scala
Example:

  1. import chisel3._
import chisel3.experimental.AffectsChiselPrefix

class MyModule extends Module {
  // Note: This contains a Data but is not a named component itself
  class NotAData extends AffectsChiselPrefix {
    val value = Wire(Bool())
  }

  // Name with AffectsChiselPrefix:    "nonData_value"
  // Name without AffectsChiselPrefix: "value"
  val nonData = new NotAData

  // Name with AffectsChiselPrefix:    "nonData2_value"
  // Name without AffectsChiselPrefix: "value_1"
  val nonData2 = new NotAData
}
See also

See the compiler plugin documentation for more information on this process.

Linear Supertypes
AnyRef, Any
Known Subclasses
Counter
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AffectsChiselPrefix
  2. AnyRef
  3. 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

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 AffectsChiselPrefix toany2stringadd[AffectsChiselPrefix] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AffectsChiselPrefix, B)
    Implicit
    This member is added by an implicit conversion from AffectsChiselPrefix toArrowAssoc[AffectsChiselPrefix] 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: (AffectsChiselPrefix) => Boolean, msg: => Any): AffectsChiselPrefix
    Implicit
    This member is added by an implicit conversion from AffectsChiselPrefix toEnsuring[AffectsChiselPrefix] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (AffectsChiselPrefix) => Boolean): AffectsChiselPrefix
    Implicit
    This member is added by an implicit conversion from AffectsChiselPrefix toEnsuring[AffectsChiselPrefix] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): AffectsChiselPrefix
    Implicit
    This member is added by an implicit conversion from AffectsChiselPrefix toEnsuring[AffectsChiselPrefix] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): AffectsChiselPrefix
    Implicit
    This member is added by an implicit conversion from AffectsChiselPrefix toEnsuring[AffectsChiselPrefix] 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. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. 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 AffectsChiselPrefix toStringFormat[AffectsChiselPrefix] 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): (AffectsChiselPrefix, B)
    Implicit
    This member is added by an implicit conversion from AffectsChiselPrefix toArrowAssoc[AffectsChiselPrefix] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAffectsChiselPrefix to any2stringadd[AffectsChiselPrefix]

Inherited by implicit conversion StringFormat fromAffectsChiselPrefix to StringFormat[AffectsChiselPrefix]

Inherited by implicit conversion Ensuring fromAffectsChiselPrefix to Ensuring[AffectsChiselPrefix]

Inherited by implicit conversion ArrowAssoc fromAffectsChiselPrefix to ArrowAssoc[AffectsChiselPrefix]

Ungrouped