Packages

  • package root

    This is the documentation for Chisel.

    This is the documentation for Chisel.

    Package structure

    The chisel3 package presents the public API of Chisel. It contains the concrete core types UInt, SInt, Bool, Clock, and Reg, the abstract types Bits, Aggregate, and Data, and the aggregate types Bundle and Vec.

    The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.

    Utility objects and methods are found in the util package.

    The testers package defines the basic interface for chisel testers.

    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 hierarchy
    Definition Classes
    experimental
  • package core
    Definition Classes
    hierarchy
  • object Instance extends SourceInfoDoc with Serializable

    Factory methods for constructing Instances

    Factory methods for constructing Instances

    Definition Classes
    core
  • InstanceBaseModuleExtensions
c

chisel3.experimental.hierarchy.core.Instance

InstanceBaseModuleExtensions

implicit class InstanceBaseModuleExtensions[T <: BaseModule] extends AnyRef

Source
Instance.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InstanceBaseModuleExtensions
  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

Instance Constructors

  1. new InstanceBaseModuleExtensions(i: Instance[T])

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 InstanceBaseModuleExtensions[T] toany2stringadd[InstanceBaseModuleExtensions[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (InstanceBaseModuleExtensions[T], B)
    Implicit
    This member is added by an implicit conversion from InstanceBaseModuleExtensions[T] toArrowAssoc[InstanceBaseModuleExtensions[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: (InstanceBaseModuleExtensions[T]) => Boolean, msg: => Any): InstanceBaseModuleExtensions[T]
    Implicit
    This member is added by an implicit conversion from InstanceBaseModuleExtensions[T] toEnsuring[InstanceBaseModuleExtensions[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (InstanceBaseModuleExtensions[T]) => Boolean): InstanceBaseModuleExtensions[T]
    Implicit
    This member is added by an implicit conversion from InstanceBaseModuleExtensions[T] toEnsuring[InstanceBaseModuleExtensions[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): InstanceBaseModuleExtensions[T]
    Implicit
    This member is added by an implicit conversion from InstanceBaseModuleExtensions[T] toEnsuring[InstanceBaseModuleExtensions[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): InstanceBaseModuleExtensions[T]
    Implicit
    This member is added by an implicit conversion from InstanceBaseModuleExtensions[T] toEnsuring[InstanceBaseModuleExtensions[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 suggestName(name: String): Unit
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toAbsoluteTarget: IsModule

    If this is an instance of a Module, returns the toAbsoluteTarget of this instance

    If this is an instance of a Module, returns the toAbsoluteTarget of this instance

    returns

    absoluteTarget of this instance

  24. def toRelativeTarget(root: Option[BaseModule]): IsModule

    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.

    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.

  25. def toRelativeTargetToHierarchy(root: Option[Hierarchy[BaseModule]]): IsModule
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. def toTarget: IsModule

    If this is an instance of a Module, returns the toTarget of this instance

    If this is an instance of a Module, returns the toTarget of this instance

    returns

    target of this instance

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

Inherited from Any

Inherited by implicit conversion any2stringadd fromInstanceBaseModuleExtensions[T] to any2stringadd[InstanceBaseModuleExtensions[T]]

Inherited by implicit conversion StringFormat fromInstanceBaseModuleExtensions[T] to StringFormat[InstanceBaseModuleExtensions[T]]

Inherited by implicit conversion Ensuring fromInstanceBaseModuleExtensions[T] to Ensuring[InstanceBaseModuleExtensions[T]]

Inherited by implicit conversion ArrowAssoc fromInstanceBaseModuleExtensions[T] to ArrowAssoc[InstanceBaseModuleExtensions[T]]

Ungrouped