Packages

sealed trait Targetable[A] extends AnyRef

Type class for types that can be converted to a Target

See AnyTargetable for type-erased containers of Targetables

Source
Targetable.scala
Note

This uses type classes instead of inheritance because Hierarchy does not constrain its type parameter and thus not all instances of Hierarchy are Targetable.

Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Targetable
  2. AnyRef
  3. Any
Implicitly
  1. by TargetableSyntax
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def toAbsoluteTarget(a: A): IsMember

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

  2. abstract def toRelativeTarget(a: A, root: Option[BaseModule]): IsMember

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

    Returns a FIRRTL IsMember 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 Targetable must be a descendant of root, if it is defined.

    ,

    This doesn't have special handling for Views.

  3. abstract def toRelativeTargetToHierarchy(a: A, root: Option[Hierarchy[BaseModule]]): IsMember

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

    Returns a FIRRTL IsMember 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 Targetable must be a descendant of root, if it is defined.

    ,

    This doesn't have special handling for Views.

  4. abstract def toTarget(a: A): IsMember

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

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

Shadowed Implicit Value Members

  1. def toAbsoluteTarget: IsMember
    Implicit
    This member is added by an implicit conversion from Targetable[A] toTargetableSyntax[Targetable[A]] performed by method TargetableSyntax in chisel3.experimental.Targetable.This conversion will take place only if an implicit value of type Targetable[Targetable[A]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (targetable: TargetableSyntax[Targetable[A]]).toAbsoluteTarget
    Definition Classes
    TargetableSyntax
  2. def toRelativeTarget(root: Option[BaseModule]): IsMember
    Implicit
    This member is added by an implicit conversion from Targetable[A] toTargetableSyntax[Targetable[A]] performed by method TargetableSyntax in chisel3.experimental.Targetable.This conversion will take place only if an implicit value of type Targetable[Targetable[A]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (targetable: TargetableSyntax[Targetable[A]]).toRelativeTarget(root)
    Definition Classes
    TargetableSyntax
  3. def toRelativeTargetToHierarchy(root: Option[Hierarchy[BaseModule]]): IsMember
    Implicit
    This member is added by an implicit conversion from Targetable[A] toTargetableSyntax[Targetable[A]] performed by method TargetableSyntax in chisel3.experimental.Targetable.This conversion will take place only if an implicit value of type Targetable[Targetable[A]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (targetable: TargetableSyntax[Targetable[A]]).toRelativeTargetToHierarchy(root)
    Definition Classes
    TargetableSyntax
  4. def toTarget: IsMember
    Implicit
    This member is added by an implicit conversion from Targetable[A] toTargetableSyntax[Targetable[A]] performed by method TargetableSyntax in chisel3.experimental.Targetable.This conversion will take place only if an implicit value of type Targetable[Targetable[A]] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (targetable: TargetableSyntax[Targetable[A]]).toTarget
    Definition Classes
    TargetableSyntax

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Targetable[A] toStringFormat[Targetable[A]] 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): (Targetable[A], B)
    Implicit
    This member is added by an implicit conversion from Targetable[A] toArrowAssoc[Targetable[A]] 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 TargetableSyntax fromTargetable[A] to TargetableSyntax[Targetable[A]]

Inherited by implicit conversion any2stringadd fromTargetable[A] to any2stringadd[Targetable[A]]

Inherited by implicit conversion StringFormat fromTargetable[A] to StringFormat[Targetable[A]]

Inherited by implicit conversion Ensuring fromTargetable[A] to Ensuring[Targetable[A]]

Inherited by implicit conversion ArrowAssoc fromTargetable[A] to ArrowAssoc[Targetable[A]]

Ungrouped