t

firrtl.annotations

IsComponent

trait IsComponent extends IsMember

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

Source
Target.scala
Linear Supertypes
IsMember, CompleteTarget, Target, Named, AnyRef, Any
Known Subclasses
InstanceTarget, ReferenceTarget
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IsComponent
  2. IsMember
  3. CompleteTarget
  4. Target
  5. Named
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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

    returns

    The circuit of this target

    Definition Classes
    CompleteTarget
  4. abstract def circuitOpt: Option[String]

    returns

    Circuit name, if it exists

    Definition Classes
    Target
  5. abstract def leafModule: String
    Definition Classes
    IsMember
  6. abstract def module: String

    returns

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

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

    returns

    Module name, if it exists

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

    returns

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

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

    returns

    Returns the instance hierarchy path, if one exists

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

    returns

    Same target without a path

    Definition Classes
    IsMember
  11. 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
  12. 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

  13. abstract def targetParent: CompleteTarget

    returns

    Member's parent target

    Definition Classes
    IsMember

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def circuitTarget: CircuitTarget

    returns

    The CircuitTarget of this target's circuit

    Definition Classes
    CompleteTarget
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def complete: CompleteTarget

    returns

    Converts this Target into a CompleteTarget

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

    Checks whether this is inside of other

    Checks whether this is inside of other

    Definition Classes
    Target
  9. def encapsulatingModule: String

    returns

    The ModuleTarget of the module that directly contains this component

    Definition Classes
    IsMember
  10. def encapsulatingModuleTarget: ModuleTarget
    Definition Classes
    IsMember
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def getComplete: Option[CompleteTarget]

    returns

    If legal, convert this Target into a CompleteTarget

    Definition Classes
    CompleteTarget → Target
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. 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
  18. def justPath: Seq[TargetToken]

    returns

    Tokens of just this member's path

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

    returns

    Returns a new GenericTarget with new values

    Definition Classes
    Target
  20. def moduleTarget: ModuleTarget

    returns

    Member's top-level module target

    Definition Classes
    IsMember
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def pathAsTargets: Seq[InstanceTarget]

    returns

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

    Definition Classes
    IsMember
  25. def pathTarget: IsModule

    returns

    Member's path target

    Definition Classes
    IsComponent → IsMember
  26. def prettyPrint(tab: String = ""): String

    Pretty serialization, ideal for error messages.

    Pretty serialization, ideal for error messages. Cannot be deserialized.

    returns

    Human-readable serialization

    Definition Classes
    Target
  27. def serialize: String

    returns

    Human-readable serialization

    Definition Classes
    Target → Named
  28. def sharedRoot(other: Target): Boolean

    Share root module

    Share root module

    Definition Classes
    Target
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    Target
  31. def toNamed: ComponentName

    returns

    Converts this Target into either a CircuitName, ModuleName, or ComponentName

    Definition Classes
    IsComponent → Target
  32. def toString(): String
    Definition Classes
    CompleteTarget → AnyRef → Any
  33. def toTarget: CompleteTarget
    Definition Classes
    CompleteTarget → Named
  34. def tokens: Seq[TargetToken]

    returns

    Target tokens

    Definition Classes
    IsComponent → Target
  35. def tryToComplete: Target

    returns

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

    Definition Classes
    Target
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from IsMember

Inherited from CompleteTarget

Inherited from Target

Inherited from Named

Inherited from AnyRef

Inherited from Any

Ungrouped