chisel
7.9.0+2-5294dafe-SNAPSHOT
API
Generated with
chisel/firrtl/firrtl.annotations/CompleteTarget

CompleteTarget

firrtl.annotations.CompleteTarget
trait CompleteTarget extends Target

Concretely points to a FIRRTL target, no generic selectors IsLegal

Attributes

Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
Target.scala
Graph
Supertypes
trait Target
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

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

Attributes

Source
Target.scala

Concrete methods

def getComplete: Option[CompleteTarget]

Attributes

Returns

If legal, convert this Target into a CompleteTarget

Source
Target.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Source
Target.scala
override def toTarget: CompleteTarget

Attributes

Definition Classes
Source
Target.scala

Inherited methods

def complete: CompleteTarget

Attributes

Returns

Converts this Target into a CompleteTarget

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

Checks whether this is inside of other

Checks whether this is inside of other

Attributes

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

Attributes

Returns

Returns a new GenericTarget with new values

Inherited from:
Target
Source
Target.scala
def serialize: String

Attributes

Returns

Human-readable serialization

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

Share root module

Share root module

Attributes

Inherited from:
Target
Source
Target.scala
def toGenericTarget: GenericTarget

Attributes

Returns

Converts this Target into a GenericTarget

Inherited from:
Target
Source
Target.scala
def toNamed: Named

Attributes

Returns

Converts this Target into either a ModuleName, or ComponentName

Inherited from:
Target
Source
Target.scala
def tryToComplete: Target

Attributes

Returns

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

Inherited from:
Target
Source
Target.scala

Inherited and Abstract methods

def isLocal: Boolean

Whether the target is directly instantiated in its root module

Whether the target is directly instantiated in its root module

Attributes

Inherited from:
Target
Source
Target.scala
def moduleOpt: Option[String]

Attributes

Returns

Module name, if it exists

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

Attributes

Returns

Returns the instance hierarchy path, if one exists

Inherited from:
Target
Source
Target.scala
def tokens: Seq[TargetToken]

Attributes

Returns

Target tokens

Inherited from:
Target
Source
Target.scala
Generated with