chisel/firrtl/firrtl.annotations/InstanceTarget

InstanceTarget

firrtl.annotations.InstanceTarget

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

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

Value parameters

instance: Name of the instance
module: Root module (e.g. the base module of this target)
ofModule: Name of the instance's module
path: Path through instance/ofModules

Attributes

Deprecated: [Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source: Target.scala
Graph
Supertypes: trait Serializable

trait Product

trait Equals

trait IsComponent

trait IsModule

trait IsMember

trait CompleteTarget

trait Target

trait Named

class Object

trait Matchable

class Any
Show all

Members list

Value members

Concrete methods

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

Attributes

Definition Classes: IsModule -> CompleteTarget
Source: Target.scala

Attributes

Returns: a ReferenceTarget referring to given reference within this instance
Source: Target.scala

Attributes

Returns: Creates a path, assuming all Instance and OfModules in this IsMember is used as a path
Definition Classes: IsMember
Source: Target.scala

Attributes

Returns: a ReferenceTarget referring to this declaration of this instance
Source: Target.scala

Attributes

Returns: Creates a new Target, appending an instance and ofmodule
Definition Classes: IsModule
Source: Target.scala

Attributes

Definition Classes: IsMember
Source: Target.scala

Attributes

Returns: Module name, if it exists
Definition Classes: Target
Source: Target.scala

Attributes

Returns: Local tokens of what this member points (not a path)
Definition Classes: IsMember
Source: Target.scala

Attributes

Returns: a ModuleTarget referring to declaration of this ofModule
Source: Target.scala

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).

Attributes

Definition Classes: IsMember
Source: Target.scala

Attributes

Returns: Creates a new Target, appending a ref
Definition Classes: IsModule
Source: Target.scala

Resets this target to have a new path

Attributes

Definition Classes: IsMember
Source: Target.scala

Removes n levels of instance hierarchy

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

Attributes

Definition Classes: IsComponent
Source: Target.scala

Inherited methods

Attributes

Returns: Converts this Target into a CompleteTarget
Inherited from:: Target
Source: Target.scala

Checks whether this is inside of other

Attributes

Inherited from:: Target
Source: Target.scala

Attributes

Returns: The ModuleTarget of the module that directly contains this component
Inherited from:: IsMember
Source: Target.scala

Attributes

Inherited from:: IsMember
Source: Target.scala

Attributes

Returns: If legal, convert this Target into a CompleteTarget
Inherited from:: CompleteTarget
Source: Target.scala

Whether the target is directly instantiated in its root module

Attributes

Definition Classes: IsComponent -> Target
Inherited from:: IsComponent
Source: Target.scala

Attributes

Returns: Tokens of just this member's path
Definition Classes: IsComponent -> IsMember
Inherited from:: IsComponent
Source: Target.scala

Attributes

Returns: Returns a new GenericTarget with new values
Inherited from:: Target
Source: Target.scala

Attributes

Returns: Member's top-level module target
Inherited from:: IsMember
Source: Target.scala

Attributes

Returns: List of local Instance Targets refering to each instance/ofModule in this member's path
Inherited from:: IsMember
Source: Target.scala

Attributes

Returns: Member's path target
Definition Classes: IsComponent -> IsMember
Inherited from:: IsComponent
Source: Target.scala

Attributes

Inherited from:: Product

Attributes

Inherited from:: Product

Attributes

Returns: Human-readable serialization
Inherited from:: Target
Source: Target.scala

Share root module

Attributes

Inherited from:: Target
Source: Target.scala

Attributes

Returns: Converts this Target into a GenericTarget
Inherited from:: Target
Source: Target.scala

Attributes

Returns: Converts this Target into either a ModuleName, or ComponentName
Definition Classes: IsComponent -> Target
Inherited from:: IsComponent
Source: Target.scala

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns: a string representation of the object.
Definition Classes: CompleteTarget -> Any
Inherited from:: CompleteTarget
Source: Target.scala

Attributes

Definition Classes: CompleteTarget -> Named
Inherited from:: CompleteTarget
Source: Target.scala

Attributes

Returns: Target tokens
Definition Classes: IsComponent -> Target
Inherited from:: IsComponent
Source: Target.scala

Attributes

Returns: Converts this Target into a CompleteTarget, or if it can't, return original Target
Inherited from:: Target
Source: Target.scala

In this article

Generated with