Trait

firrtl.annotations

IsModule

Related Doc: package annotations

Permalink

trait IsModule extends IsMember

References a module-like target (e.g. a ModuleTarget or an InstanceTarget)

Source
Target.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IsModule
  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, inst: String): InstanceTarget

    Permalink

    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
    IsModuleCompleteTarget
  2. abstract def asPath: Seq[(Instance, OfModule)]

    Permalink

    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

    Permalink

    returns

    The circuit of this target

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

    Permalink

    returns

    Circuit name, if it exists

    Definition Classes
    Target
  5. abstract def instOf(instance: String, of: String): InstanceTarget

    Permalink

    returns

    Creates a new Target, appending an instance and ofmodule

  6. abstract def isLocal: Boolean

    Permalink

    Whether the target is directly instantiated in its root module

    Whether the target is directly instantiated in its root module

    Definition Classes
    Target
  7. abstract def justPath: Seq[TargetToken]

    Permalink

    returns

    Tokens of just this member's path

    Definition Classes
    IsMember
  8. abstract def leafModule: String

    Permalink
    Definition Classes
    IsMember
  9. abstract def module: String

    Permalink

    returns

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

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

    Permalink

    returns

    Module name, if it exists

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

    Permalink

    returns

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

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

    Permalink

    returns

    Returns the instance hierarchy path, if one exists

    Definition Classes
    IsMemberTarget
  13. abstract def pathTarget: CompleteTarget

    Permalink

    returns

    Member's path target

    Definition Classes
    IsMember
  14. abstract def pathlessTarget: IsMember

    Permalink

    returns

    Same target without a path

    Definition Classes
    IsMember
  15. abstract def ref(value: String): ReferenceTarget

    Permalink

    returns

    Creates a new Target, appending a ref

  16. abstract def setPathTarget(newPath: IsModule): CompleteTarget

    Permalink

    Resets this target to have a new path

    Resets this target to have a new path

    Definition Classes
    IsMember
  17. abstract def targetParent: CompleteTarget

    Permalink

    returns

    Member's parent target

    Definition Classes
    IsMember
  18. abstract def tokens: Seq[TargetToken]

    Permalink

    returns

    Target tokens

    Definition Classes
    Target

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def circuitTarget: CircuitTarget

    Permalink

    returns

    The CircuitTarget of this target's circuit

    Definition Classes
    CompleteTarget
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def complete: CompleteTarget

    Permalink

    returns

    Converts this Target into a CompleteTarget

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

    Permalink

    Checks whether this is inside of other

    Checks whether this is inside of other

    Definition Classes
    Target
  9. def encapsulatingModule: String

    Permalink

    returns

    The ModuleTarget of the module that directly contains this component

    Definition Classes
    IsMember
  10. def encapsulatingModuleTarget: ModuleTarget

    Permalink
    Definition Classes
    IsMember
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def getComplete: Option[CompleteTarget]

    Permalink

    returns

    If legal, convert this Target into a CompleteTarget

    Definition Classes
    CompleteTargetTarget
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. def modify(circuitOpt: Option[String] = circuitOpt, moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget

    Permalink

    returns

    Returns a new GenericTarget with new values

    Definition Classes
    Target
  19. def moduleTarget: ModuleTarget

    Permalink

    returns

    Member's top-level module target

    Definition Classes
    IsMember
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. def pathAsTargets: Seq[InstanceTarget]

    Permalink

    returns

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

    Definition Classes
    IsMember
  24. def prettyPrint(tab: String = ""): String

    Permalink

    Pretty serialization, ideal for error messages.

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

    returns

    Human-readable serialization

    Definition Classes
    Target
  25. def serialize: String

    Permalink

    returns

    Human-readable serialization

    Definition Classes
    TargetNamed
  26. def sharedRoot(other: Target): Boolean

    Permalink

    Share root module

    Share root module

    Definition Classes
    Target
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toGenericTarget: GenericTarget

    Permalink

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    Target
  29. def toNamed: Named

    Permalink

    returns

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

    Definition Classes
    Target
  30. def toString(): String

    Permalink
    Definition Classes
    CompleteTarget → AnyRef → Any
  31. def toTarget: CompleteTarget

    Permalink
    Definition Classes
    CompleteTargetNamed
  32. def tryToComplete: Target

    Permalink

    returns

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

    Definition Classes
    Target
  33. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from IsMember

Inherited from CompleteTarget

Inherited from Target

Inherited from Named

Inherited from AnyRef

Inherited from Any

Ungrouped