Packages

c

firrtl.annotations

ReferenceTarget

case class ReferenceTarget(module: String, path: Seq[(Instance, OfModule)], ref: String, component: Seq[TargetToken]) extends IsComponent with Product with Serializable

Target pointing to a declared named component in a firrtl.ir.DefModule This includes: firrtl.ir.Port, firrtl.ir.DefWire, firrtl.ir.DefRegister, firrtl.ir.DefMemory, firrtl.ir.DefNode

module

Name of the root module of this reference

path

Path through instance/ofModules

ref

Name of component

component

Subcomponent of this reference, e.g. field or index

Annotations
@deprecated
Deprecated

(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.

Source
Target.scala
Linear Supertypes
Serializable, Product, Equals, IsComponent, IsMember, CompleteTarget, Target, Named, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReferenceTarget
  2. Serializable
  3. Product
  4. Equals
  5. IsComponent
  6. IsMember
  7. CompleteTarget
  8. Target
  9. Named
  10. AnyRef
  11. Any
Implicitly
  1. by convertNamed2Target
  2. by convertTarget2Named
  3. by convertIsComponent2ComponentName
  4. by any2stringadd
  5. by StringFormat
  6. by Ensuring
  7. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ReferenceTarget(module: String, path: Seq[(Instance, OfModule)], ref: String, component: Seq[TargetToken])

    module

    Name of the root module of this reference

    path

    Path through instance/ofModules

    ref

    Name of component

    component

    Subcomponent of this reference, e.g. field or index

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 ReferenceTarget toany2stringadd[ReferenceTarget] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ReferenceTarget, B)
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toArrowAssoc[ReferenceTarget] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addHierarchy(root: String, instance: String): ReferenceTarget

    Adds another level of instance hierarchy Example: Given root=A and instance=b, transforms (Top, B)/c:C -> (Top, A)/b:B/c:C

    Adds another level of instance hierarchy Example: Given root=A and instance=b, transforms (Top, B)/c:C -> (Top, A)/b:B/c:C

    Definition Classes
    ReferenceTarget → CompleteTarget
  7. def allSubTargets(tpe: Type): Seq[ReferenceTarget]
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def asPath: Seq[(Instance, OfModule)]

    returns

    Creates a path, assuming all Instance and OfModules in this IsMember is used as a path

    Definition Classes
    ReferenceTarget → IsMember
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def complete: CompleteTarget

    returns

    Converts this Target into a CompleteTarget

    Definition Classes
    Target
  12. val component: Seq[TargetToken]
  13. def componentType(baseType: Type): Type

    returns

    the type of the subcomponent specified by this target's component

  14. def encapsulatedBy(other: IsModule): Boolean

    Checks whether this is inside of other

    Checks whether this is inside of other

    Definition Classes
    Target
  15. def encapsulatingModule: String

    returns

    The ModuleTarget of the module that directly contains this component

    Definition Classes
    IsMember
  16. def encapsulatingModuleTarget: ModuleTarget
    Definition Classes
    IsMember
  17. def ensuring(cond: (ReferenceTarget) => Boolean, msg: => Any): ReferenceTarget
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toEnsuring[ReferenceTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (ReferenceTarget) => Boolean): ReferenceTarget
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toEnsuring[ReferenceTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: => Any): ReferenceTarget
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toEnsuring[ReferenceTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): ReferenceTarget
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toEnsuring[ReferenceTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def expr: Expression
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toComponentName performed by method convertIsComponent2ComponentName in firrtl.annotations.Target.
    Definition Classes
    ComponentName
  23. def field(value: String): ReferenceTarget

    value

    Field name of this target

    returns

    A new ReferenceTarget to the specified field of this ReferenceTarget

  24. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def getComplete: Option[CompleteTarget]

    returns

    If legal, convert this Target into a CompleteTarget

    Definition Classes
    CompleteTarget → Target
  27. def index(value: Int): ReferenceTarget

    value

    Index value of this target

    returns

    A new ReferenceTarget to the specified index of this ReferenceTarget

  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def isLocal: Boolean

    Whether the target is directly instantiated in its root module

    Whether the target is directly instantiated in its root module

    Definition Classes
    IsComponent → Target
  30. def justPath: Seq[TargetToken]

    returns

    Tokens of just this member's path

    Definition Classes
    IsComponent → IsMember
  31. def leafModule: String
    Definition Classes
    ReferenceTarget → IsMember
  32. def leafSubTargets(tpe: Type): Seq[ReferenceTarget]
  33. def modify(moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget

    returns

    Returns a new GenericTarget with new values

    Definition Classes
    Target
  34. val module: String

    returns

    Root module, e.g. top-level module of this target

    Definition Classes
    ReferenceTarget → IsMember
  35. def moduleOpt: Option[String]

    returns

    Module name, if it exists

    Definition Classes
    ReferenceTarget → Target
  36. def moduleTarget: ModuleTarget

    returns

    Member's top-level module target

    Definition Classes
    IsMember
  37. val name: String
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toComponentName performed by method convertIsComponent2ComponentName in firrtl.annotations.Target.
    Definition Classes
    ComponentName
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. def noComponents: ReferenceTarget
  40. def notPath: Seq[TargetToken]

    returns

    Local tokens of what this member points (not a path)

    Definition Classes
    ReferenceTarget → IsMember
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. val path: Seq[(Instance, OfModule)]

    returns

    Returns the instance hierarchy path, if one exists

    Definition Classes
    ReferenceTarget → IsMember → Target
  44. def pathAsTargets: Seq[InstanceTarget]

    returns

    List of local Instance Targets refering to each instance/ofModule in this member's path

    Definition Classes
    IsMember
  45. def pathTarget: IsModule

    returns

    Member's path target

    Definition Classes
    IsComponent → IsMember
  46. def pathlessTarget: ReferenceTarget

    Returns the local form of this ReferenceTarget

    Returns the local form of this ReferenceTarget

    For example, given ~Top|Top/foo:Foo/bar:Bar>x,

    .pathlessTarget returns ~Top|Bar>x

    This is useful for cases in which annotations must point to the module itself rather than an absolute *instance* of the module (e.g. deduplication).

    returns

    Same target without a path

    Definition Classes
    ReferenceTarget → IsMember
  47. def productElementNames: Iterator[String]
    Definition Classes
    Product
  48. val ref: String
  49. def serialize: String

    returns

    Human-readable serialization

    Definition Classes
    Target
  50. def setPathTarget(newPath: IsModule): ReferenceTarget

    Resets this target to have a new path

    Resets this target to have a new path

    Definition Classes
    ReferenceTarget → IsMember
  51. def sharedRoot(other: Target): Boolean

    Share root module

    Share root module

    Definition Classes
    Target
  52. def stripHierarchy(n: Int): ReferenceTarget

    Removes n levels of instance hierarchy

    Removes n levels of instance hierarchy

    Example: n=1, transforms (Top, A)/b:B/c:C -> (Top, B)/c:C

    Definition Classes
    ReferenceTarget → IsComponent
  53. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  54. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    Target
  55. def toNamed: ComponentName

    returns

    Converts this Target into either a ModuleName, or ComponentName

    Definition Classes
    IsComponent → Target
  56. def toString(): String
    Definition Classes
    CompleteTarget → AnyRef → Any
  57. def toTarget: CompleteTarget
    Definition Classes
    CompleteTarget → Named
  58. def tokens: Seq[TargetToken]

    returns

    Target tokens

    Definition Classes
    IsComponent → Target
  59. def tryToComplete: Target

    returns

    Converts this Target into a CompleteTarget, or if it can't, return original Target

    Definition Classes
    Target
  60. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  61. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Shadowed Implicit Value Members

  1. def addHierarchy(root: String, instance: String): IsComponent

    Adds another level of instance hierarchy Example: Given root=A and instance=b, transforms (Top, B)/c:C -> (Top, A)/b:B/c:C

    Adds another level of instance hierarchy Example: Given root=A and instance=b, transforms (Top, B)/c:C -> (Top, A)/b:B/c:C

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).addHierarchy(root, instance)
    Definition Classes
    CompleteTarget
  2. def complete: CompleteTarget

    returns

    Converts this Target into a CompleteTarget

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).complete
    Definition Classes
    Target
  3. def encapsulatedBy(other: IsModule): Boolean

    Checks whether this is inside of other

    Checks whether this is inside of other

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).encapsulatedBy(other)
    Definition Classes
    Target
  4. def getComplete: Option[CompleteTarget]

    returns

    If legal, convert this Target into a CompleteTarget

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).getComplete
    Definition Classes
    CompleteTarget → Target
  5. def isLocal: Boolean

    Whether the target is directly instantiated in its root module

    Whether the target is directly instantiated in its root module

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).isLocal
    Definition Classes
    Target
  6. def modify(moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget

    returns

    Returns a new GenericTarget with new values

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).modify(moduleOpt, tokens)
    Definition Classes
    Target
  7. val module: ModuleName
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toComponentName performed by method convertIsComponent2ComponentName in firrtl.annotations.Target.
    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:
    (referenceTarget: ComponentName).module
    Definition Classes
    ComponentName
  8. def moduleOpt: Option[String]

    returns

    Module name, if it exists

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).moduleOpt
    Definition Classes
    Target
  9. def path: Seq[(Instance, OfModule)]

    returns

    Returns the instance hierarchy path, if one exists

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).path
    Definition Classes
    Target
  10. def productElementNames: Iterator[String]
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toComponentName performed by method convertIsComponent2ComponentName in firrtl.annotations.Target.
    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:
    (referenceTarget: ComponentName).productElementNames
    Definition Classes
    Product
  11. def serialize: String

    returns

    Human-readable serialization

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).serialize
    Definition Classes
    Target
  12. def sharedRoot(other: Target): Boolean

    Share root module

    Share root module

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).sharedRoot(other)
    Definition Classes
    Target
  13. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).toGenericTarget
    Definition Classes
    Target
  14. def toNamed: Named

    returns

    Converts this Target into either a ModuleName, or ComponentName

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).toNamed
    Definition Classes
    Target
  15. def toString(): String
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).toString()
    Definition Classes
    CompleteTarget → AnyRef → Any
  16. def toTarget: CompleteTarget
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).toTarget
    Definition Classes
    CompleteTarget → Named
  17. def toTarget: CompleteTarget
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toNamed performed by method convertTarget2Named in firrtl.annotations.Target.
    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:
    (referenceTarget: Named).toTarget
    Definition Classes
    Named
  18. def toTarget: ReferenceTarget
    Implicit
    This member is added by an implicit conversion from ReferenceTarget toComponentName performed by method convertIsComponent2ComponentName in firrtl.annotations.Target.
    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:
    (referenceTarget: ComponentName).toTarget
    Definition Classes
    ComponentName → Named
  19. def tokens: Seq[TargetToken]

    returns

    Target tokens

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).tokens
    Definition Classes
    Target
  20. def tryToComplete: Target

    returns

    Converts this Target into a CompleteTarget, or if it can't, return original Target

    Implicit
    This member is added by an implicit conversion from ReferenceTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    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:
    (referenceTarget: CompleteTarget).tryToComplete
    Definition Classes
    Target

Deprecated Value Members

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

Inherited from Product

Inherited from Equals

Inherited from IsComponent

Inherited from IsMember

Inherited from CompleteTarget

Inherited from Target

Inherited from Named

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion convertNamed2Target fromReferenceTarget to CompleteTarget

Inherited by implicit conversion convertTarget2Named fromReferenceTarget to Named

Inherited by implicit conversion convertIsComponent2ComponentName fromReferenceTarget to ComponentName

Inherited by implicit conversion any2stringadd fromReferenceTarget to any2stringadd[ReferenceTarget]

Inherited by implicit conversion StringFormat fromReferenceTarget to StringFormat[ReferenceTarget]

Inherited by implicit conversion Ensuring fromReferenceTarget to Ensuring[ReferenceTarget]

Inherited by implicit conversion ArrowAssoc fromReferenceTarget to ArrowAssoc[ReferenceTarget]

Ungrouped