Packages

c

firrtl.annotations

InstanceTarget

case class InstanceTarget(module: String, path: Seq[(Instance, OfModule)], instance: String, ofModule: String) extends IsModule with IsComponent with Product with Serializable

Points to an instance declaration of a module (termed an ofModule)

module

Root module (e.g. the base module of this target)

path

Path through instance/ofModules

instance

Name of the instance

ofModule

Name of the instance's module

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, IsModule, IsMember, CompleteTarget, Target, Named, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InstanceTarget
  2. Serializable
  3. Product
  4. Equals
  5. IsComponent
  6. IsModule
  7. IsMember
  8. CompleteTarget
  9. Target
  10. Named
  11. AnyRef
  12. 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 InstanceTarget(module: String, path: Seq[(Instance, OfModule)], instance: String, ofModule: String)

    module

    Root module (e.g. the base module of this target)

    path

    Path through instance/ofModules

    instance

    Name of the instance

    ofModule

    Name of the instance's module

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 InstanceTarget toany2stringadd[InstanceTarget] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (InstanceTarget, B)
    Implicit
    This member is added by an implicit conversion from InstanceTarget toArrowAssoc[InstanceTarget] 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, inst: String): InstanceTarget

    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
    InstanceTarget → IsModule → CompleteTarget
  7. def addReference(rt: ReferenceTarget): ReferenceTarget

    returns

    a ReferenceTarget referring to given reference within this instance

  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
    InstanceTarget → IsMember
  10. def asReference: ReferenceTarget

    returns

    a ReferenceTarget referring to this declaration of this instance

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

    returns

    Converts this Target into a CompleteTarget

    Definition Classes
    Target
  13. def encapsulatedBy(other: IsModule): Boolean

    Checks whether this is inside of other

    Checks whether this is inside of other

    Definition Classes
    Target
  14. def encapsulatingModule: String

    returns

    The ModuleTarget of the module that directly contains this component

    Definition Classes
    IsMember
  15. def encapsulatingModuleTarget: ModuleTarget
    Definition Classes
    IsMember
  16. def ensuring(cond: (InstanceTarget) => Boolean, msg: => Any): InstanceTarget
    Implicit
    This member is added by an implicit conversion from InstanceTarget toEnsuring[InstanceTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (InstanceTarget) => Boolean): InstanceTarget
    Implicit
    This member is added by an implicit conversion from InstanceTarget toEnsuring[InstanceTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: => Any): InstanceTarget
    Implicit
    This member is added by an implicit conversion from InstanceTarget toEnsuring[InstanceTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): InstanceTarget
    Implicit
    This member is added by an implicit conversion from InstanceTarget toEnsuring[InstanceTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def expr: Expression
    Implicit
    This member is added by an implicit conversion from InstanceTarget toComponentName performed by method convertIsComponent2ComponentName in firrtl.annotations.Target.
    Definition Classes
    ComponentName
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def getComplete: Option[CompleteTarget]

    returns

    If legal, convert this Target into a CompleteTarget

    Definition Classes
    CompleteTarget → Target
  25. def instOf(inst: String, of: String): InstanceTarget

    returns

    Creates a new Target, appending an instance and ofmodule

    Definition Classes
    InstanceTarget → IsModule
  26. val instance: String
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. 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
  29. def justPath: Seq[TargetToken]

    returns

    Tokens of just this member's path

    Definition Classes
    IsComponent → IsMember
  30. def leafModule: String
    Definition Classes
    InstanceTarget → IsMember
  31. def modify(moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget

    returns

    Returns a new GenericTarget with new values

    Definition Classes
    Target
  32. val module: String

    returns

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

    Definition Classes
    InstanceTarget → IsMember
  33. def moduleOpt: Option[String]

    returns

    Module name, if it exists

    Definition Classes
    InstanceTarget → Target
  34. def moduleTarget: ModuleTarget

    returns

    Member's top-level module target

    Definition Classes
    IsMember
  35. val name: String
    Implicit
    This member is added by an implicit conversion from InstanceTarget toComponentName performed by method convertIsComponent2ComponentName in firrtl.annotations.Target.
    Definition Classes
    ComponentName
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. def notPath: Seq[Product with TargetToken with Serializable { def value: String }]

    returns

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

    Definition Classes
    InstanceTarget → IsMember
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. val ofModule: String
  41. def ofModuleTarget: ModuleTarget

    returns

    a ModuleTarget referring to declaration of this ofModule

  42. val path: Seq[(Instance, OfModule)]

    returns

    Returns the instance hierarchy path, if one exists

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

    returns

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

    Definition Classes
    IsMember
  44. def pathTarget: IsModule

    returns

    Member's path target

    Definition Classes
    IsComponent → IsMember
  45. def pathlessTarget: InstanceTarget

    Returns the local form of this InstanceTarget

    Returns the local form of this InstanceTarget

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

    .pathlessTarget returns ~Top|Foo/bar:Bar

    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
    InstanceTarget → IsMember
  46. def productElementNames: Iterator[String]
    Definition Classes
    Product
  47. def ref(value: String): ReferenceTarget

    returns

    Creates a new Target, appending a ref

    Definition Classes
    InstanceTarget → IsModule
  48. def serialize: String

    returns

    Human-readable serialization

    Definition Classes
    Target
  49. def setPathTarget(newPath: IsModule): InstanceTarget

    Resets this target to have a new path

    Resets this target to have a new path

    Definition Classes
    InstanceTarget → IsMember
  50. def sharedRoot(other: Target): Boolean

    Share root module

    Share root module

    Definition Classes
    Target
  51. def stripHierarchy(n: Int): IsModule

    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
    InstanceTarget → IsComponent
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    Target
  54. def toNamed: ComponentName

    returns

    Converts this Target into either a ModuleName, or ComponentName

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

    returns

    Target tokens

    Definition Classes
    IsComponent → Target
  58. def tryToComplete: Target

    returns

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

    Definition Classes
    Target
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  61. 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 InstanceTarget 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:
    (instanceTarget: 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 InstanceTarget 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:
    (instanceTarget: 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 InstanceTarget 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:
    (instanceTarget: 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 InstanceTarget 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:
    (instanceTarget: 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 InstanceTarget 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:
    (instanceTarget: 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 InstanceTarget 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:
    (instanceTarget: CompleteTarget).modify(moduleOpt, tokens)
    Definition Classes
    Target
  7. val module: ModuleName
    Implicit
    This member is added by an implicit conversion from InstanceTarget 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:
    (instanceTarget: 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 InstanceTarget 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:
    (instanceTarget: 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 InstanceTarget 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:
    (instanceTarget: CompleteTarget).path
    Definition Classes
    Target
  10. def productElementNames: Iterator[String]
    Implicit
    This member is added by an implicit conversion from InstanceTarget 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:
    (instanceTarget: ComponentName).productElementNames
    Definition Classes
    Product
  11. def serialize: String

    returns

    Human-readable serialization

    Implicit
    This member is added by an implicit conversion from InstanceTarget 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:
    (instanceTarget: 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 InstanceTarget 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:
    (instanceTarget: 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 InstanceTarget 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:
    (instanceTarget: 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 InstanceTarget 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:
    (instanceTarget: CompleteTarget).toNamed
    Definition Classes
    Target
  15. def toString(): String
    Implicit
    This member is added by an implicit conversion from InstanceTarget 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:
    (instanceTarget: CompleteTarget).toString()
    Definition Classes
    CompleteTarget → AnyRef → Any
  16. def toTarget: CompleteTarget
    Implicit
    This member is added by an implicit conversion from InstanceTarget 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:
    (instanceTarget: CompleteTarget).toTarget
    Definition Classes
    CompleteTarget → Named
  17. def toTarget: CompleteTarget
    Implicit
    This member is added by an implicit conversion from InstanceTarget 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:
    (instanceTarget: Named).toTarget
    Definition Classes
    Named
  18. def toTarget: ReferenceTarget
    Implicit
    This member is added by an implicit conversion from InstanceTarget 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:
    (instanceTarget: ComponentName).toTarget
    Definition Classes
    ComponentName → Named
  19. def tokens: Seq[TargetToken]

    returns

    Target tokens

    Implicit
    This member is added by an implicit conversion from InstanceTarget 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:
    (instanceTarget: 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 InstanceTarget 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:
    (instanceTarget: CompleteTarget).tryToComplete
    Definition Classes
    Target

Deprecated Value Members

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

Inherited from IsMember

Inherited from CompleteTarget

Inherited from Target

Inherited from Named

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion convertNamed2Target fromInstanceTarget to CompleteTarget

Inherited by implicit conversion convertTarget2Named fromInstanceTarget to Named

Inherited by implicit conversion convertIsComponent2ComponentName fromInstanceTarget to ComponentName

Inherited by implicit conversion any2stringadd fromInstanceTarget to any2stringadd[InstanceTarget]

Inherited by implicit conversion StringFormat fromInstanceTarget to StringFormat[InstanceTarget]

Inherited by implicit conversion Ensuring fromInstanceTarget to Ensuring[InstanceTarget]

Inherited by implicit conversion ArrowAssoc fromInstanceTarget to ArrowAssoc[InstanceTarget]

Ungrouped