c

firrtl.annotations

ModuleTarget

case class ModuleTarget(circuit: String, module: String) extends IsModule with Product with Serializable

Target pointing to a FIRRTL firrtl.ir.DefModule

circuit

Circuit containing the module

module

Name of the module

Source
Target.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ModuleTarget
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. IsModule
  7. IsMember
  8. CompleteTarget
  9. Target
  10. Named
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ModuleTarget(circuit: String, module: String)

    circuit

    Circuit containing the module

    module

    Name of the module

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. def addHierarchy(root: String, instance: String): InstanceTarget

    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
    ModuleTargetIsModuleCompleteTarget
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def asPath: Nil.type

    returns

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

    Definition Classes
    ModuleTargetIsMember
  7. val circuit: String

    returns

    The circuit of this target

    Definition Classes
    ModuleTargetCompleteTarget
  8. def circuitOpt: Option[String]

    returns

    Circuit name, if it exists

    Definition Classes
    ModuleTargetTarget
  9. def circuitTarget: CircuitTarget

    returns

    The CircuitTarget of this target's circuit

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

    returns

    Converts this Target into a CompleteTarget

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

    Checks whether this is inside of other

    Checks whether this is inside of other

    Definition Classes
    Target
  13. def encapsulatingModule: String

    returns

    The ModuleTarget of the module that directly contains this component

    Definition Classes
    IsMember
  14. def encapsulatingModuleTarget: ModuleTarget
    Definition Classes
    IsMember
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def getComplete: Option[CompleteTarget]

    returns

    If legal, convert this Target into a CompleteTarget

    Definition Classes
    CompleteTargetTarget
  19. def instOf(instance: String, of: String): InstanceTarget

    returns

    Creates a new Target, appending an instance and ofmodule

    Definition Classes
    ModuleTargetIsModule
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. 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
    ModuleTargetTarget
  22. def justPath: Seq[TargetToken]

    returns

    Tokens of just this member's path

    Definition Classes
    ModuleTargetIsMember
  23. def leafModule: String
    Definition Classes
    ModuleTargetIsMember
  24. 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
  25. val module: String

    returns

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

    Definition Classes
    ModuleTargetIsMember
  26. def moduleOpt: Option[String]

    returns

    Module name, if it exists

    Definition Classes
    ModuleTargetTarget
  27. def moduleTarget: ModuleTarget

    returns

    Member's top-level module target

    Definition Classes
    IsMember
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def notPath: Seq[TargetToken]

    returns

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

    Definition Classes
    ModuleTargetIsMember
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. def path: Seq[(Instance, OfModule)]

    returns

    Returns the instance hierarchy path, if one exists

    Definition Classes
    ModuleTargetIsMemberTarget
  33. def pathAsTargets: Seq[InstanceTarget]

    returns

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

    Definition Classes
    IsMember
  34. def pathTarget: ModuleTarget

    returns

    Member's path target

    Definition Classes
    ModuleTargetIsMember
  35. def pathlessTarget: ModuleTarget

    returns

    Same target without a path

    Definition Classes
    ModuleTargetIsMember
  36. 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
  37. def ref(value: String): ReferenceTarget

    returns

    Creates a new Target, appending a ref

    Definition Classes
    ModuleTargetIsModule
  38. def serialize: String

    returns

    Human-readable serialization

    Definition Classes
    TargetNamed
  39. def setPathTarget(newPath: IsModule): IsModule

    Resets this target to have a new path

    Resets this target to have a new path

    Definition Classes
    ModuleTargetIsMember
  40. def sharedRoot(other: Target): Boolean

    Share root module

    Share root module

    Definition Classes
    Target
  41. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  42. def targetParent: CircuitTarget

    returns

    Member's parent target

    Definition Classes
    ModuleTargetIsMember
  43. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    Target
  44. def toNamed: ModuleName

    returns

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

    Definition Classes
    ModuleTargetTarget
  45. def toString(): String
    Definition Classes
    CompleteTarget → AnyRef → Any
  46. def toTarget: CompleteTarget
    Definition Classes
    CompleteTargetNamed
  47. def tokens: Seq[TargetToken]

    returns

    Target tokens

    Definition Classes
    ModuleTargetTarget
  48. def tryToComplete: Target

    returns

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

    Definition Classes
    Target
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from IsModule

Inherited from IsMember

Inherited from CompleteTarget

Inherited from Target

Inherited from Named

Inherited from AnyRef

Inherited from Any

Ungrouped