Target

firrtl.annotations.Target
See theTarget companion object
sealed trait Target extends Named

Refers to something in a FIRRTL firrtl.ir.Circuit. Used for Annotation targets.

Can be in various states of completion/resolved:

  • Legal: TargetToken's in tokens are in an order that makes sense
  • Complete: moduleOpt is non-empty, and all Instance() are followed by OfModule()
  • Local: tokens does not refer to things through an instance hierarchy (no Instance() or OfModule() tokens)

Attributes

Companion
object
Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
Target.scala
Graph
Supertypes
trait Named
class Object
trait Matchable
class Any
Known subtypes
trait IsMember
trait IsComponent
trait IsModule
class ModuleTarget
Show all

Members list

Value members

Abstract methods

Attributes

Returns

If legal, convert this Target into a CompleteTarget

Source
Target.scala
def isLocal: Boolean

Whether the target is directly instantiated in its root module

Whether the target is directly instantiated in its root module

Attributes

Source
Target.scala
def moduleOpt: Option[String]

Attributes

Returns

Module name, if it exists

Source
Target.scala
def path: Seq[(Instance, OfModule)]

Attributes

Returns

Returns the instance hierarchy path, if one exists

Source
Target.scala
Implicitly added by convertTarget2Named

Attributes

Source
Target.scala
def tokens: Seq[TargetToken]

Attributes

Returns

Target tokens

Source
Target.scala

Concrete methods

Attributes

Returns

Converts this Target into a CompleteTarget

Source
Target.scala
def encapsulatedBy(other: IsModule): Boolean

Checks whether this is inside of other

Checks whether this is inside of other

Attributes

Source
Target.scala
def modify(moduleOpt: Option[String] = ..., tokens: Seq[TargetToken] = ...): GenericTarget

Attributes

Returns

Returns a new GenericTarget with new values

Source
Target.scala
def serialize: String

Attributes

Returns

Human-readable serialization

Source
Target.scala
def sharedRoot(other: Target): Boolean

Share root module

Share root module

Attributes

Source
Target.scala

Attributes

Returns

Converts this Target into a GenericTarget

Source
Target.scala
def toNamed: Named

Attributes

Returns

Converts this Target into either a ModuleName, or ComponentName

Source
Target.scala

Attributes

Returns

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

Source
Target.scala

Inherited and Abstract methods

Attributes

Inherited from:
Named
Source
Target.scala