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

IsComponent

firrtl.annotations.IsComponent
trait IsComponent extends IsMember

A component of a FIRRTL Module (e.g. cannot point to a ModuleTarget)

Attributes

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

Members list

Value members

Abstract methods

def stripHierarchy(n: Int): IsMember

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

Attributes

Source
Target.scala

Concrete methods

def expr: Expression
Implicitly added by convertIsComponent2ComponentName

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
override def justPath: Seq[TargetToken]

Attributes

Returns

Tokens of just this member's path

Definition Classes
Source
Target.scala
override def pathTarget: IsModule

Attributes

Returns

Member's path target

Definition Classes
Source
Target.scala
override def toNamed: ComponentName

Attributes

Returns

Converts this Target into either a ModuleName, or ComponentName

Definition Classes
Source
Target.scala
def toTarget: ReferenceTarget
Implicitly added by convertIsComponent2ComponentName

Attributes

Source
Target.scala
override def tokens: Seq[TargetToken]

Attributes

Returns

Target tokens

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 encapsulatingModule: String

Attributes

Returns

The ModuleTarget of the module that directly contains this component

Inherited from:
IsMember
Source
Target.scala
def encapsulatingModuleTarget: ModuleTarget

Attributes

Inherited from:
IsMember
Source
Target.scala
def getComplete: Option[CompleteTarget]

Attributes

Returns

If legal, convert this Target into a CompleteTarget

Inherited from:
CompleteTarget
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 moduleTarget: ModuleTarget

Attributes

Returns

Member's top-level module target

Inherited from:
IsMember
Source
Target.scala
def pathAsTargets: Seq[InstanceTarget]

Attributes

Returns

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

Inherited from:
IsMember
Source
Target.scala
def productElementNames: Iterator[String]
Implicitly added by convertIsComponent2ComponentName

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]
Implicitly added by convertIsComponent2ComponentName

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 toGenericTarget: GenericTarget

Attributes

Returns

Converts this Target into a GenericTarget

Inherited from:
Target
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
Inherited from:
CompleteTarget
Source
Target.scala
override def toTarget: CompleteTarget

Attributes

Definition Classes
Inherited from:
CompleteTarget
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 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

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

Attributes

Returns

Creates a path, assuming all Instance and OfModules in this IsMember is used as a path

Inherited from:
IsMember
Source
Target.scala
def leafModule: String

Attributes

Inherited from:
IsMember
Source
Target.scala
def module: String

Attributes

Returns

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

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

Attributes

Returns

Module name, if it exists

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

Attributes

Returns

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

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

Attributes

Returns

Returns the instance hierarchy path, if one exists

Inherited from:
IsMember
Source
Target.scala
def pathlessTarget: IsMember

Attributes

Returns

Same target without a path

Inherited from:
IsMember
Source
Target.scala
def setPathTarget(newPath: IsModule): CompleteTarget

Resets this target to have a new path

Resets this target to have a new path

Attributes

Inherited from:
IsMember
Source
Target.scala
Generated with