Packages

trait IsComponent extends IsMember

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

Annotations
@deprecated
Deprecated

(Since version Chisel 7.0.0) All APIs in package firrtl are deprecated.

Source
Target.scala
Linear Supertypes
IsMember, CompleteTarget, Target, Named, AnyRef, Any
Known Subclasses
InstanceTarget, ReferenceTarget
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IsComponent
  2. IsMember
  3. CompleteTarget
  4. Target
  5. Named
  6. AnyRef
  7. Any
Implicitly
  1. by convertNamed2Target
  2. by convertTarget2Named
  3. by convertIsComponent2ComponentName
  4. by any2stringadd
  5. by StringFormat
  6. by Ensuring
  7. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract 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

    Definition Classes
    CompleteTarget
  2. abstract def asPath: Seq[(Instance, OfModule)]

    returns

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

    Definition Classes
    IsMember
  3. abstract def leafModule: String
    Definition Classes
    IsMember
  4. abstract def module: String

    returns

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

    Definition Classes
    IsMember
  5. abstract def moduleOpt: Option[String]

    returns

    Module name, if it exists

    Definition Classes
    Target
  6. abstract def notPath: Seq[TargetToken]

    returns

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

    Definition Classes
    IsMember
  7. abstract def path: Seq[(Instance, OfModule)]

    returns

    Returns the instance hierarchy path, if one exists

    Definition Classes
    IsMember → Target
  8. abstract def pathlessTarget: IsMember

    returns

    Same target without a path

    Definition Classes
    IsMember
  9. abstract def setPathTarget(newPath: IsModule): CompleteTarget

    Resets this target to have a new path

    Resets this target to have a new path

    Definition Classes
    IsMember
  10. abstract 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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from IsComponent toany2stringadd[IsComponent] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (IsComponent, B)
    Implicit
    This member is added by an implicit conversion from IsComponent toArrowAssoc[IsComponent] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def complete: CompleteTarget

    returns

    Converts this Target into a CompleteTarget

    Definition Classes
    Target
  9. def encapsulatedBy(other: IsModule): Boolean

    Checks whether this is inside of other

    Checks whether this is inside of other

    Definition Classes
    Target
  10. def encapsulatingModule: String

    returns

    The ModuleTarget of the module that directly contains this component

    Definition Classes
    IsMember
  11. def encapsulatingModuleTarget: ModuleTarget
    Definition Classes
    IsMember
  12. def ensuring(cond: (IsComponent) => Boolean, msg: => Any): IsComponent
    Implicit
    This member is added by an implicit conversion from IsComponent toEnsuring[IsComponent] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (IsComponent) => Boolean): IsComponent
    Implicit
    This member is added by an implicit conversion from IsComponent toEnsuring[IsComponent] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): IsComponent
    Implicit
    This member is added by an implicit conversion from IsComponent toEnsuring[IsComponent] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): IsComponent
    Implicit
    This member is added by an implicit conversion from IsComponent toEnsuring[IsComponent] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. def expr: Expression
    Implicit
    This member is added by an implicit conversion from IsComponent toComponentName performed by method convertIsComponent2ComponentName in firrtl.annotations.Target.
    Definition Classes
    ComponentName
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getComplete: Option[CompleteTarget]

    returns

    If legal, convert this Target into a CompleteTarget

    Definition Classes
    CompleteTarget → Target
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def isLocal: Boolean

    Whether the target is directly instantiated in its root module

    Whether the target is directly instantiated in its root module

    Definition Classes
    IsComponent → Target
  25. def justPath: Seq[TargetToken]

    returns

    Tokens of just this member's path

    Definition Classes
    IsComponent → IsMember
  26. def modify(moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget

    returns

    Returns a new GenericTarget with new values

    Definition Classes
    Target
  27. def moduleTarget: ModuleTarget

    returns

    Member's top-level module target

    Definition Classes
    IsMember
  28. val name: String
    Implicit
    This member is added by an implicit conversion from IsComponent toComponentName performed by method convertIsComponent2ComponentName in firrtl.annotations.Target.
    Definition Classes
    ComponentName
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. def pathAsTargets: Seq[InstanceTarget]

    returns

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

    Definition Classes
    IsMember
  33. def pathTarget: IsModule

    returns

    Member's path target

    Definition Classes
    IsComponent → IsMember
  34. def productElementNames: Iterator[String]
    Implicit
    This member is added by an implicit conversion from IsComponent toComponentName performed by method convertIsComponent2ComponentName in firrtl.annotations.Target.
    Definition Classes
    Product
  35. def serialize: String

    returns

    Human-readable serialization

    Definition Classes
    Target
  36. def sharedRoot(other: Target): Boolean

    Share root module

    Share root module

    Definition Classes
    Target
  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    Target
  39. def toNamed: ComponentName

    returns

    Converts this Target into either a ModuleName, or ComponentName

    Definition Classes
    IsComponent → Target
  40. def toString(): String
    Definition Classes
    CompleteTarget → AnyRef → Any
  41. def toTarget: CompleteTarget
    Definition Classes
    CompleteTarget → Named
  42. def tokens: Seq[TargetToken]

    returns

    Target tokens

    Definition Classes
    IsComponent → Target
  43. def tryToComplete: Target

    returns

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

    Definition Classes
    Target
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Shadowed Implicit Value Members

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

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).addHierarchy(root, instance)
    Definition Classes
    CompleteTarget
  2. def complete: CompleteTarget

    returns

    Converts this Target into a CompleteTarget

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).complete
    Definition Classes
    Target
  3. def encapsulatedBy(other: IsModule): Boolean

    Checks whether this is inside of other

    Checks whether this is inside of other

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).encapsulatedBy(other)
    Definition Classes
    Target
  4. def getComplete: Option[CompleteTarget]

    returns

    If legal, convert this Target into a CompleteTarget

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).getComplete
    Definition Classes
    CompleteTarget → Target
  5. def isLocal: Boolean

    Whether the target is directly instantiated in its root module

    Whether the target is directly instantiated in its root module

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).isLocal
    Definition Classes
    Target
  6. def modify(moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget

    returns

    Returns a new GenericTarget with new values

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).modify(moduleOpt, tokens)
    Definition Classes
    Target
  7. val module: ModuleName
    Implicit
    This member is added by an implicit conversion from IsComponent toComponentName performed by method convertIsComponent2ComponentName in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: ComponentName).module
    Definition Classes
    ComponentName
  8. def moduleOpt: Option[String]

    returns

    Module name, if it exists

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).moduleOpt
    Definition Classes
    Target
  9. def path: Seq[(Instance, OfModule)]

    returns

    Returns the instance hierarchy path, if one exists

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).path
    Definition Classes
    Target
  10. def serialize: String

    returns

    Human-readable serialization

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).serialize
    Definition Classes
    Target
  11. def sharedRoot(other: Target): Boolean

    Share root module

    Share root module

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).sharedRoot(other)
    Definition Classes
    Target
  12. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).toGenericTarget
    Definition Classes
    Target
  13. def toNamed: Named

    returns

    Converts this Target into either a ModuleName, or ComponentName

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).toNamed
    Definition Classes
    Target
  14. def toString(): String
    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).toString()
    Definition Classes
    CompleteTarget → AnyRef → Any
  15. def toTarget: CompleteTarget
    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).toTarget
    Definition Classes
    CompleteTarget → Named
  16. def toTarget: CompleteTarget
    Implicit
    This member is added by an implicit conversion from IsComponent toNamed performed by method convertTarget2Named in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: Named).toTarget
    Definition Classes
    Named
  17. def toTarget: ReferenceTarget
    Implicit
    This member is added by an implicit conversion from IsComponent toComponentName performed by method convertIsComponent2ComponentName in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: ComponentName).toTarget
    Definition Classes
    ComponentName → Named
  18. def tokens: Seq[TargetToken]

    returns

    Target tokens

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).tokens
    Definition Classes
    Target
  19. def tryToComplete: Target

    returns

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

    Implicit
    This member is added by an implicit conversion from IsComponent toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (isComponent: CompleteTarget).tryToComplete
    Definition Classes
    Target

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from IsComponent toStringFormat[IsComponent] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (IsComponent, B)
    Implicit
    This member is added by an implicit conversion from IsComponent toArrowAssoc[IsComponent] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from IsMember

Inherited from CompleteTarget

Inherited from Target

Inherited from Named

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion convertNamed2Target fromIsComponent to CompleteTarget

Inherited by implicit conversion convertTarget2Named fromIsComponent to Named

Inherited by implicit conversion convertIsComponent2ComponentName fromIsComponent to ComponentName

Inherited by implicit conversion any2stringadd fromIsComponent to any2stringadd[IsComponent]

Inherited by implicit conversion StringFormat fromIsComponent to StringFormat[IsComponent]

Inherited by implicit conversion Ensuring fromIsComponent to Ensuring[IsComponent]

Inherited by implicit conversion ArrowAssoc fromIsComponent to ArrowAssoc[IsComponent]

Ungrouped