Class

firrtl.annotations

ModuleTarget

Related Doc: package annotations

Permalink

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
Linear Supertypes
Type Hierarchy
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)

    Permalink

    circuit

    Circuit containing the module

    module

    Name of the module

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. def addHierarchy(root: String, instance: 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
    ModuleTargetIsModuleCompleteTarget
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def asPath: Nil.type

    Permalink

    returns

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

    Definition Classes
    ModuleTargetIsMember
  7. val circuit: String

    Permalink

    Circuit containing the module

    Circuit containing the module

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

    Permalink

    returns

    Circuit name, if it exists

    Definition Classes
    ModuleTargetTarget
  9. def circuitTarget: CircuitTarget

    Permalink

    returns

    The CircuitTarget of this target's circuit

    Definition Classes
    CompleteTarget
  10. def clone(): AnyRef

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

    Permalink

    returns

    Converts this Target into a CompleteTarget

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

    Permalink

    Checks whether this is inside of other

    Checks whether this is inside of other

    Definition Classes
    Target
  13. def encapsulatingModule: String

    Permalink

    returns

    The ModuleTarget of the module that directly contains this component

    Definition Classes
    IsMember
  14. def encapsulatingModuleTarget: ModuleTarget

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

    Permalink
    Definition Classes
    AnyRef
  16. def finalize(): Unit

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

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

    Permalink

    returns

    If legal, convert this Target into a CompleteTarget

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

    Permalink

    returns

    Creates a new Target, appending an instance and ofmodule

    Definition Classes
    ModuleTargetIsModule
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. 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
    ModuleTargetTarget
  22. def justPath: Seq[TargetToken]

    Permalink

    returns

    Tokens of just this member's path

    Definition Classes
    ModuleTargetIsMember
  23. def leafModule: String

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

    Permalink

    Name of the module

    Name of the module

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

    Permalink

    returns

    Module name, if it exists

    Definition Classes
    ModuleTargetTarget
  27. def moduleTarget: ModuleTarget

    Permalink

    returns

    Member's top-level module target

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

    Permalink
    Definition Classes
    AnyRef
  29. def notPath: Seq[TargetToken]

    Permalink

    returns

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

    Definition Classes
    ModuleTargetIsMember
  30. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  32. def path: Seq[(Instance, OfModule)]

    Permalink

    returns

    Returns the instance hierarchy path, if one exists

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

    Permalink

    returns

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

    Definition Classes
    IsMember
  34. def pathTarget: ModuleTarget

    Permalink

    returns

    Member's path target

    Definition Classes
    ModuleTargetIsMember
  35. def pathlessTarget: ModuleTarget

    Permalink

    returns

    Same target without a path

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

    Permalink

    returns

    Creates a new Target, appending a ref

    Definition Classes
    ModuleTargetIsModule
  38. def serialize: String

    Permalink

    returns

    Human-readable serialization

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

    Permalink

    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

    Permalink

    Share root module

    Share root module

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

    Permalink
    Definition Classes
    AnyRef
  42. def targetParent: CircuitTarget

    Permalink

    returns

    Member's parent target

    Definition Classes
    ModuleTargetIsMember
  43. def toGenericTarget: GenericTarget

    Permalink

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    Target
  44. def toNamed: ModuleName

    Permalink

    returns

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

    Definition Classes
    ModuleTargetTarget
  45. def toString(): String

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

    Permalink
    Definition Classes
    CompleteTargetNamed
  47. def tokens: Seq[TargetToken]

    Permalink

    returns

    Target tokens

    Definition Classes
    ModuleTargetTarget
  48. def tryToComplete: Target

    Permalink

    returns

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

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

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

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

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

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