c

firrtl.annotations

ReferenceTarget

case class ReferenceTarget(circuit: String, 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

circuit

Name of the encapsulating circuit

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

Source
Target.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, IsComponent, IsMember, CompleteTarget, Target, Named, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReferenceTarget
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. IsComponent
  7. IsMember
  8. CompleteTarget
  9. Target
  10. Named
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    circuit

    Name of the encapsulating circuit

    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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. 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
  5. def allSubTargets(tpe: Type): Seq[ReferenceTarget]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. 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
  8. val circuit: String

    returns

    The circuit of this target

    Definition Classes
    ReferenceTarget → CompleteTarget
  9. def circuitOpt: Option[String]

    returns

    Circuit name, if it exists

    Definition Classes
    ReferenceTarget → Target
  10. def circuitTarget: CircuitTarget

    returns

    The CircuitTarget of this target's circuit

    Definition Classes
    CompleteTarget
  11. def clock: ReferenceTarget

    returns

    The clock signal of this reference, must be to a firrtl.ir.DefRegister

  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  13. def complete: CompleteTarget

    returns

    Converts this Target into a CompleteTarget

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

    returns

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

  16. def encapsulatedBy(other: IsModule): Boolean

    Checks whether this is inside of other

    Checks whether this is inside of other

    Definition Classes
    Target
  17. def encapsulatingModule: String

    returns

    The ModuleTarget of the module that directly contains this component

    Definition Classes
    IsMember
  18. def encapsulatingModuleTarget: ModuleTarget
    Definition Classes
    IsMember
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def field(value: String): ReferenceTarget

    value

    Field name of this target

    returns

    A new ReferenceTarget to the specified field of this ReferenceTarget

  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def getComplete: Option[CompleteTarget]

    returns

    If legal, convert this Target into a CompleteTarget

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

    value

    Index value of this target

    returns

    A new ReferenceTarget to the specified index of this ReferenceTarget

  24. def init: ReferenceTarget

    returns

    The initialization value of this reference, must be to a firrtl.ir.DefRegister

  25. def isClock: Boolean
  26. def isInit: Boolean
  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 isReset: Boolean
  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(circuitOpt: Option[String] = circuitOpt, 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. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def noComponents: ReferenceTarget
  39. def notPath: Seq[TargetToken]

    returns

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

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

    returns

    Returns the instance hierarchy path, if one exists

    Definition Classes
    ReferenceTarget → 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: 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
  46. def prettyPrint(tab: String = ""): String

    Pretty serialization, ideal for error messages.

    Pretty serialization, ideal for error messages. Cannot be deserialized.

    returns

    Human-readable serialization

    Definition Classes
    Target
  47. val ref: String
  48. def reset: ReferenceTarget

    returns

    The reset signal of this reference, must be to a firrtl.ir.DefRegister

  49. def serialize: String

    returns

    Human-readable serialization

    Definition Classes
    Target → Named
  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 targetParent: CompleteTarget

    returns

    Member's parent target

    Definition Classes
    ReferenceTarget → IsMember
  55. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    Target
  56. def toNamed: ComponentName

    returns

    Converts this Target into either a CircuitName, ModuleName, or ComponentName

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

    returns

    Target tokens

    Definition Classes
    IsComponent → Target
  60. def tryToComplete: Target

    returns

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

    Definition Classes
    Target
  61. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  63. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

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

Ungrouped