c

firrtl.annotations

InstanceTarget

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

circuit

Encapsulating circuit

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

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

Instance Constructors

  1. new InstanceTarget(circuit: String, module: String, path: Seq[(Instance, OfModule)], instance: String, ofModule: String)

    circuit

    Encapsulating circuit

    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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. 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
    InstanceTargetIsModuleCompleteTarget
  5. def addReference(rt: ReferenceTarget): ReferenceTarget

    returns

    a ReferenceTarget referring to given reference within this instance

  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
    InstanceTargetIsMember
  8. def asReference: ReferenceTarget

    returns

    a ReferenceTarget referring to this declaration of this instance

  9. val circuit: String

    returns

    The circuit of this target

    Definition Classes
    InstanceTargetCompleteTarget
  10. def circuitOpt: Option[String]

    returns

    Circuit name, if it exists

    Definition Classes
    InstanceTargetTarget
  11. def circuitTarget: CircuitTarget

    returns

    The CircuitTarget of this target's circuit

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

    returns

    Converts this Target into a CompleteTarget

    Definition Classes
    Target
  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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def getComplete: Option[CompleteTarget]

    returns

    If legal, convert this Target into a CompleteTarget

    Definition Classes
    CompleteTargetTarget
  21. def instOf(inst: String, of: String): InstanceTarget

    returns

    Creates a new Target, appending an instance and ofmodule

    Definition Classes
    InstanceTargetIsModule
  22. val instance: String
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. 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
    IsComponentTarget
  25. def justPath: Seq[TargetToken]

    returns

    Tokens of just this member's path

    Definition Classes
    IsComponentIsMember
  26. def leafModule: String
    Definition Classes
    InstanceTargetIsMember
  27. 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
  28. val module: String

    returns

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

    Definition Classes
    InstanceTargetIsMember
  29. def moduleOpt: Option[String]

    returns

    Module name, if it exists

    Definition Classes
    InstanceTargetTarget
  30. def moduleTarget: ModuleTarget

    returns

    Member's top-level module target

    Definition Classes
    IsMember
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def notPath: Seq[Product with Serializable with TargetToken { def value: String }]

    returns

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

    Definition Classes
    InstanceTargetIsMember
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. val ofModule: String
  36. def ofModuleTarget: ModuleTarget

    returns

    a ModuleTarget referring to declaration of this ofModule

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

    returns

    Returns the instance hierarchy path, if one exists

    Definition Classes
    InstanceTargetIsMemberTarget
  38. def pathAsTargets: Seq[InstanceTarget]

    returns

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

    Definition Classes
    IsMember
  39. def pathTarget: IsModule

    returns

    Member's path target

    Definition Classes
    IsComponentIsMember
  40. 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
    InstanceTargetIsMember
  41. 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
  42. def ref(value: String): ReferenceTarget

    returns

    Creates a new Target, appending a ref

    Definition Classes
    InstanceTargetIsModule
  43. def serialize: String

    returns

    Human-readable serialization

    Definition Classes
    TargetNamed
  44. def setPathTarget(newPath: IsModule): InstanceTarget

    Resets this target to have a new path

    Resets this target to have a new path

    Definition Classes
    InstanceTargetIsMember
  45. def sharedRoot(other: Target): Boolean

    Share root module

    Share root module

    Definition Classes
    Target
  46. 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
    InstanceTargetIsComponent
  47. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  48. def targetParent: IsModule

    returns

    Member's parent target

    Definition Classes
    InstanceTargetIsMember
  49. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    Target
  50. def toNamed: ComponentName

    returns

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

    Definition Classes
    IsComponentTarget
  51. def toString(): String
    Definition Classes
    CompleteTarget → AnyRef → Any
  52. def toTarget: CompleteTarget
    Definition Classes
    CompleteTargetNamed
  53. def tokens: Seq[TargetToken]

    returns

    Target tokens

    Definition Classes
    IsComponentTarget
  54. def tryToComplete: Target

    returns

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

    Definition Classes
    Target
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

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

Ungrouped