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 experimental

  Package for experimental features, which may have their API changed, be removed, etc.

  Package for experimental features, which may have their API changed, be removed, etc.

  Because its contents won't necessarily have the same level of stability and support as non-experimental, you must explicitly import this package to use its contents.

  Definition Classes
    chisel3
-  package dataview
  Definition Classes
    experimental
-  package hierarchy
  Definition Classes
    experimental
- AffectsChiselPrefix
- Analog
- BaseModule
- BundleLiteralException
- BundleLiterals
- ChiselAnnotation
- ChiselMultiAnnotation
- ChiselSubtypeOf
- CloneModuleAsRecord
- DeprecatedSourceInfo
- DoubleParam
- EnumAnnotations
- ExtModule
- HWTuple10
- HWTuple2
- HWTuple3
- HWTuple4
- HWTuple5
- HWTuple6
- HWTuple7
- HWTuple8
- HWTuple9
- HasAutoTypename
- HasTypeAlias
- IntParam
- IntrinsicModule
- NoSourceInfo
- OpaqueType
- Param
- RawParam
- RecordAlias
- SerializableModule
- SerializableModuleGenerator
- SerializableModuleParameter
- SourceInfo
- SourceLine
- StringParam
- Trace
- UnlocatableSourceInfo
- VecLiteralException
- VecLiterals
- annotate
- attach
- dedupGroup
- doNotDedup
- dump
- noPrefix
- prefix
- requireIsAnnotatable
- requireIsChiselType
- requireIsHardware
- skipPrefix
- treedump

t

chisel3.experimental

# HasAutoTypename

###

#### trait HasAutoTypename extends AnyRef

Trait for Records that signals the compiler plugin to generate a typeName for the inheriting Record based on the parameter values provided to its constructor.

Self Type
  HasAutoTypename with Record
Source
  HasAutoTypename.scala
Example:

1. Consider a Bundle which manually implements `typeName`:

       class MyBundle(param1: Int, param2: Int)(gen: Data) extends Bundle {
         val foo = UInt(param1.W)
         val bar = UInt(param2.W)
         val data = gen
         override def typeName = s"MyBundle_${param1}_${param2}_${gen.typeName}"
       }

       (new MyBundle(3, 4)(SInt(3.W))).typeName // "MyBundle_3_4_SInt3"
       (new MyBundle(1, 32)(Bool())).typeName   // "MyBundle_1_32_Bool"

   An identical `typeName` implementation can be generated and provided with `HasAutoTypename`, making the manual implementation unnecessary:

       class MyBundle(param1: Int, param2: Int)(gen: Data) extends Bundle with HasAutoTypename {
         val foo = UInt(param1.W)
         val bar = UInt(param2.W)
         val data = gen
       }

       (new MyBundle(3, 4)(SInt(3.W))).typeName // "MyBundle_3_4_SInt3"
       (new MyBundle(1, 32)(Bool())).typeName   // "MyBundle_1_32_Bool"

Linear Supertypes
AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. HasAutoTypename
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 HasAutoTypename toany2stringadd[HasAutoTypename] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (HasAutoTypename, B)
   Implicit
     This member is added by an implicit conversion from HasAutoTypename toArrowAssoc[HasAutoTypename] 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: (HasAutoTypename) => Boolean, msg: => Any): HasAutoTypename
   Implicit
     This member is added by an implicit conversion from HasAutoTypename toEnsuring[HasAutoTypename] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (HasAutoTypename) => Boolean): HasAutoTypename
   Implicit
     This member is added by an implicit conversion from HasAutoTypename toEnsuring[HasAutoTypename] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): HasAutoTypename
    Implicit
      This member is added by an implicit conversion from HasAutoTypename toEnsuring[HasAutoTypename] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): HasAutoTypename
    Implicit
      This member is added by an implicit conversion from HasAutoTypename toEnsuring[HasAutoTypename] 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.  def typeName: String

    Auto generate a type name for this Bundle using the bundle arguments supplied by the compiler plugin.

24.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
25.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
26.  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 HasAutoTypename toStringFormat[HasAutoTypename] 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): (HasAutoTypename, B)
   Implicit
     This member is added by an implicit conversion from HasAutoTypename toArrowAssoc[HasAutoTypename] 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 fromHasAutoTypename to any2stringadd[HasAutoTypename]

### Inherited by implicit conversion StringFormat fromHasAutoTypename to StringFormat[HasAutoTypename]

### Inherited by implicit conversion Ensuring fromHasAutoTypename to Ensuring[HasAutoTypename]

### Inherited by implicit conversion ArrowAssoc fromHasAutoTypename to ArrowAssoc[HasAutoTypename]

### Ungrouped