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 properties

  The properties package includes functionality related to non-hardware data.

  The properties package includes functionality related to non-hardware data.

  This entire package is currently very experimental, so expect some rough edges and rapid API evolution.

  Definition Classes
    chisel3
- AnyClassType
- Class
- ClassType
- DynamicObject
- Path
- Property
- PropertyArithmeticOps
- PropertyType

c

chisel3.properties

# DynamicObject

###
Companion object DynamicObject

#### class DynamicObject extends HasId with NamedComponent

Represents an instance of a Class.

This cannot be instantiated directly, instead see Class.unsafeGetDynamicObject.

The DynamicObject is generally unsafe, in that its getField method does not check the name, type, or direction of the accessed field. It may be used with care, and a more typesafe version called StaticObject has been added, which works with the Definition / Instance APIs.

To create a DynamicObject directly, wrap a Class with DynamicObject.apply. For example:

    val obj = DynamicObject(new Class {
      override def desiredName = "Test"
      val in = IO(Input(Property[Int]()))
      val out = IO(Output(Property[Int]()))
      out := in
    })

Source
  Object.scala

Linear Supertypes
NamedComponent, HasId, InstanceId, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. DynamicObject
2. NamedComponent
3. HasId
4. InstanceId
5. AnyRef
6. 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 DynamicObject toany2stringadd[DynamicObject] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (DynamicObject, B)
   Implicit
     This member is added by an implicit conversion from DynamicObject toArrowAssoc[DynamicObject] 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 circuitName: String
   Definition Classes
     HasId
8.  val className: ClassType
9.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
10.  def ensuring(cond: (DynamicObject) => Boolean, msg: => Any): DynamicObject
    Implicit
      This member is added by an implicit conversion from DynamicObject toEnsuring[DynamicObject] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: (DynamicObject) => Boolean): DynamicObject
    Implicit
      This member is added by an implicit conversion from DynamicObject toEnsuring[DynamicObject] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: Boolean, msg: => Any): DynamicObject
    Implicit
      This member is added by an implicit conversion from DynamicObject toEnsuring[DynamicObject] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  def ensuring(cond: Boolean): DynamicObject
    Implicit
      This member is added by an implicit conversion from DynamicObject toEnsuring[DynamicObject] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
14.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
15.  def equals(that: Any): Boolean
    Definition Classes
      HasId → AnyRef → Any
16.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
17.  final def getClass(): java.lang.Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
18.  def getField[T](name: String, property: Property[T]): Property[T]
19.  def getField[T](name: String)(implicit tpe: PropertyType[T]): Property[Type]

    Get a field from this Object.

    Get a field from this Object.

    *WARNING*: It is the caller's responsibility to ensure the field exists, with the correct type and direction.

20.  def getReference: Property[ClassType]

    Get a reference to this Object, suitable for use Ports.

21.  def hasSeed: Boolean

    returns

      Whether either autoName or suggestName has been called

    Definition Classes
      HasId
22.  def hashCode(): Int
    Definition Classes
      HasId → AnyRef → Any
23.  def instanceName: String
    Definition Classes
      HasId → InstanceId
24.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
25.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
26.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
27.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
28.  def parentModName: String
    Definition Classes
      HasId → InstanceId
29.  def parentPathName: String
    Definition Classes
      HasId → InstanceId
30.  def pathName: String
    Definition Classes
      HasId → InstanceId
31.  def setSourceClass(cls: Class): Unit
    Attributes
      protected[chisel3]
32.  def setSourceClassRef(): Unit

    Set the source Class ref to this DynamicObject's ref.

    Set the source Class ref to this DynamicObject's ref.

    After the DynamicObject is named, this must be called so the Class ref will be updated to the DynamicObject ref. This is needed for any secret ports that are bored in the class, which point to the Class ref.

    Attributes
      protected[chisel3]
33.  def suggestName(seed: => String): DynamicObject.this.type

    Takes the first seed suggested.

    Takes the first seed suggested. Multiple calls to this function will be ignored. If the final computed name conflicts with another name, it may get uniquified by appending a digit at the end.

    Is a higher priority than `autoSeed`, in that regardless of whether `autoSeed` was called, suggestName will always take precedence.

    seed

      The seed for the name of this component

    returns

      this object

    Definition Classes
      HasId
34.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
35.  final def toAbsoluteTarget: ReferenceTarget

    Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph

    Returns a FIRRTL IsMember that refers to the absolute path to this object in the elaborated hardware graph

    Definition Classes
      NamedComponent → InstanceId
36.  final def toNamed: ComponentName

    Returns a FIRRTL ComponentName that references this object

    Returns a FIRRTL ComponentName that references this object

    Definition Classes
      NamedComponent → InstanceId
    Note

      Should not be called until circuit elaboration is complete

37.  final def toRelativeTarget(root: Option[BaseModule]): ReferenceTarget

    Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.

    Returns a FIRRTL ReferenceTarget that references this object, relative to an optional root.

    If `root` is defined, the target is a hierarchical path starting from `root`.

    If `root` is not defined, the target is a hierarchical path equivalent to `toAbsoluteTarget`.

    Definition Classes
      NamedComponent
    Note

      If `root` is defined, and has not finished elaboration, this must be called within `atModuleBodyEnd`.

      ,

      The NamedComponent must be a descendant of `root`, if it is defined.

      ,

      This doesn't have special handling for Views.

38.  def toString(): String
    Definition Classes
      AnyRef → Any
39.  final def toTarget: ReferenceTarget

    Returns a FIRRTL ReferenceTarget that references this object

    Returns a FIRRTL ReferenceTarget that references this object

    Definition Classes
      NamedComponent → InstanceId
    Note

      Should not be called until circuit elaboration is complete

40.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
41.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
42.  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 DynamicObject toStringFormat[DynamicObject] 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): (DynamicObject, B)
   Implicit
     This member is added by an implicit conversion from DynamicObject toArrowAssoc[DynamicObject] 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 NamedComponent

### Inherited from HasId

### Inherited from InstanceId

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromDynamicObject to any2stringadd[DynamicObject]

### Inherited by implicit conversion StringFormat fromDynamicObject to StringFormat[DynamicObject]

### Inherited by implicit conversion Ensuring fromDynamicObject to Ensuring[DynamicObject]

### Inherited by implicit conversion ArrowAssoc fromDynamicObject to ArrowAssoc[DynamicObject]

### Ungrouped