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

GenericTarget

firrtl.annotations.GenericTarget
case class GenericTarget(moduleOpt: Option[String], tokens: Vector[TargetToken]) extends Target

Represents incomplete or non-standard Targets

Value parameters

moduleOpt

Optional module name

tokens

TargetTokens to represent the target in a module

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 Target
trait Named
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def add(token: TargetToken): GenericTarget

Appends a target token to tokens, asserts legality

Appends a target token to tokens, asserts legality

Attributes

Source
Target.scala
def astModule: Option[String]

Attributes

Source
Target.scala
override def getComplete: Option[CompleteTarget]

Attributes

Returns

If legal, convert this Target into a CompleteTarget

Definition Classes
Source
Target.scala
def getInstanceOf: Option[(String, String)]

If complete and an instance target, return the instance and ofmodule

If complete and an instance target, return the instance and ofmodule

Attributes

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

If complete, return this GenericTarget's path

If complete, return this GenericTarget's path

Attributes

Source
Target.scala
def getRef: Option[(String, Seq[TargetToken])]

If complete and a reference, return the reference and subcomponents

If complete and a reference, return the reference and subcomponents

Attributes

Source
Target.scala
def isComplete: Boolean

Checks whether the component is legal and complete, meaning the moduleOpt is nonEmpty and all Instance() are followed by OfModule()

Checks whether the component is legal and complete, meaning the moduleOpt is nonEmpty and all Instance() are followed by OfModule()

Attributes

Source
Target.scala
def isComponentTarget: Boolean

Attributes

Source
Target.scala
def isLegal: Boolean

Checks whether the component is legal (incomplete is ok)

Checks whether the component is legal (incomplete is ok)

Attributes

Source
Target.scala
override def isLocal: Boolean

Whether the target is directly instantiated in its root module

Whether the target is directly instantiated in its root module

Attributes

Definition Classes
Source
Target.scala
def isModuleTarget: Boolean

Attributes

Source
Target.scala
def optAdd(token: TargetToken): Option[Target]

Optionally tries to append token to tokens, fails return is not a legal Target

Optionally tries to append token to tokens, fails return is not a legal Target

Attributes

Source
Target.scala
def parentModule: Option[String]

Attributes

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

Attributes

Returns

Returns the instance hierarchy path, if one exists

Source
Target.scala
def remove(n: Int): GenericTarget

Removes n number of target tokens from the right side of tokens

Removes n number of target tokens from the right side of tokens

Attributes

Source
Target.scala
override def toGenericTarget: GenericTarget

Attributes

Returns

Converts this Target into a GenericTarget

Definition Classes
Source
Target.scala
override def toNamed: Named

Attributes

Returns

Converts this Target into either a ModuleName, or ComponentName

Definition Classes
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 productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
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 tryToComplete: Target

Attributes

Returns

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

Inherited from:
Target
Source
Target.scala
Generated with