chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package firrtl
  Definition Classes
    root
-  package annotations
  Definition Classes
    firrtl
- Annotation
- AnnotationClassNotFoundException
- AnnotationException
- AnnotationFileNotFoundException
- AnnotationUtils
- CircuitName
- CircuitTarget
- CompleteTarget
- ComponentName
- GenericTarget
- HasSerializationHints
- InstanceTarget
- InvalidAnnotationFileException
- InvalidAnnotationJSONException
- IsComponent
- IsMember
- IsModule
- JsonProtocol
- LoadMemoryAnnotation
- MemoryFileInlineAnnotation
- MemoryInitAnnotation
- MemoryLoadFileType
- ModuleName
- ModuleTarget
- Named
- NoTargetAnnotation
- ReferenceTarget
- SingleTargetAnnotation
- Target
- TargetToken
- UnrecogizedAnnotationsException
- UnrecognizedAnnotation
- UnserializableAnnotationException
- UnserializeableAnnotation

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

Linear Supertypes
Serializable, Product, Equals, IsModule, IsMember, CompleteTarget, Target, Named, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ModuleTarget
2. Serializable
3. Product
4. Equals
5. IsModule
6. IsMember
7. CompleteTarget
8. Target
9. Named
10. AnyRef
11. Any

Implicitly

1. by convertNamed2Target
2. by convertTarget2Named
3. by convertModuleTarget2ModuleName
4. by any2stringadd
5. by StringFormat
6. by Ensuring
7. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### 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.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from ModuleTarget toany2stringadd[ModuleTarget] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (ModuleTarget, B)
   Implicit
     This member is added by an implicit conversion from ModuleTarget toArrowAssoc[ModuleTarget] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  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
     ModuleTarget → IsModule → CompleteTarget
7.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
8.  def asPath: Nil

   returns

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

   Definition Classes
     ModuleTarget → IsMember
9.  val circuit: String

   returns

     The circuit of this target

   Definition Classes
     ModuleTarget → CompleteTarget
10.  def circuitOpt: Option[String]

    returns

      Circuit name, if it exists

    Definition Classes
      ModuleTarget → Target
11.  def circuitTarget: CircuitTarget

    returns

      The CircuitTarget of this target's circuit

    Definition Classes
      CompleteTarget
12.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
13.  def complete: CompleteTarget

    returns

      Converts this Target into a CompleteTarget

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

    Checks whether this is inside of other

    Checks whether this is inside of other

    Definition Classes
      Target
15.  def encapsulatingModule: String

    returns

      The ModuleTarget of the module that directly contains this component

    Definition Classes
      IsMember
16.  def encapsulatingModuleTarget: ModuleTarget
    Definition Classes
      IsMember
17.  def ensuring(cond: (ModuleTarget) => Boolean, msg: => Any): ModuleTarget
    Implicit
      This member is added by an implicit conversion from ModuleTarget toEnsuring[ModuleTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
18.  def ensuring(cond: (ModuleTarget) => Boolean): ModuleTarget
    Implicit
      This member is added by an implicit conversion from ModuleTarget toEnsuring[ModuleTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
19.  def ensuring(cond: Boolean, msg: => Any): ModuleTarget
    Implicit
      This member is added by an implicit conversion from ModuleTarget toEnsuring[ModuleTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
20.  def ensuring(cond: Boolean): ModuleTarget
    Implicit
      This member is added by an implicit conversion from ModuleTarget toEnsuring[ModuleTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
21.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
22.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
23.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
24.  def getComplete: Option[CompleteTarget]

    returns

      If legal, convert this Target into a CompleteTarget

    Definition Classes
      CompleteTarget → Target
25.  def instOf(instance: String, of: String): InstanceTarget

    returns

      Creates a new Target, appending an instance and ofmodule

    Definition Classes
      ModuleTarget → IsModule
26.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
27.  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
      ModuleTarget → Target
28.  def justPath: Seq[TargetToken]

    returns

      Tokens of just this member's path

    Definition Classes
      ModuleTarget → IsMember
29.  def leafModule: String
    Definition Classes
      ModuleTarget → IsMember
30.  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
31.  val module: String

    returns

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

    Definition Classes
      ModuleTarget → IsMember
32.  def moduleOpt: Option[String]

    returns

      Module name, if it exists

    Definition Classes
      ModuleTarget → Target
33.  def moduleTarget: ModuleTarget

    returns

      Member's top-level module target

    Definition Classes
      IsMember
34.  val name: String
    Implicit
      This member is added by an implicit conversion from ModuleTarget toModuleName performed by method convertModuleTarget2ModuleName in firrtl.annotations.Target.
    Definition Classes
      ModuleName
35.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
36.  def notPath: Seq[TargetToken]

    returns

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

    Definition Classes
      ModuleTarget → IsMember
37.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
38.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
39.  def path: Seq[(Instance, OfModule)]

    returns

      Returns the instance hierarchy path, if one exists

    Definition Classes
      ModuleTarget → IsMember → Target
40.  def pathAsTargets: Seq[InstanceTarget]

    returns

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

    Definition Classes
      IsMember
41.  def pathTarget: ModuleTarget

    returns

      Member's path target

    Definition Classes
      ModuleTarget → IsMember
42.  def pathlessTarget: ModuleTarget

    returns

      Same target without a path

    Definition Classes
      ModuleTarget → IsMember
43.  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
44.  def productElementNames: Iterator[String]
    Definition Classes
      Product
45.  def ref(value: String): ReferenceTarget

    returns

      Creates a new Target, appending a ref

    Definition Classes
      ModuleTarget → IsModule
46.  def serialize: String

    returns

      Human-readable serialization

    Definition Classes
      Target → Named
47.  def setPathTarget(newPath: IsModule): IsModule

    Resets this target to have a new path

    Resets this target to have a new path

    Definition Classes
      ModuleTarget → IsMember
48.  def sharedRoot(other: Target): Boolean

    Share root module

    Share root module

    Definition Classes
      Target
49.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
50.  def targetParent: CircuitTarget

    returns

      Member's parent target

    Definition Classes
      ModuleTarget → IsMember
51.  def toGenericTarget: GenericTarget

    returns

      Converts this Target into a GenericTarget

    Definition Classes
      Target
52.  def toNamed: ModuleName

    returns

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

    Definition Classes
      ModuleTarget → Target
53.  def toString(): String
    Definition Classes
      CompleteTarget → AnyRef → Any
54.  def toTarget: CompleteTarget
    Definition Classes
      CompleteTarget → Named
55.  def tokens: Seq[TargetToken]

    returns

      Target tokens

    Definition Classes
      ModuleTarget → Target
56.  def tryToComplete: Target

    returns

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

    Definition Classes
      Target
57.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
58.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
59.  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 ModuleTarget 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:

         (moduleTarget: CompleteTarget).addHierarchy(root, instance)

   Definition Classes
     CompleteTarget
2.  def circuit: String

   returns

     The circuit of this target

   Implicit
     This member is added by an implicit conversion from ModuleTarget 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:

         (moduleTarget: CompleteTarget).circuit

   Definition Classes
     CompleteTarget
3.  val circuit: CircuitName
   Implicit
     This member is added by an implicit conversion from ModuleTarget toModuleName performed by method convertModuleTarget2ModuleName 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:

         (moduleTarget: ModuleName).circuit

   Definition Classes
     ModuleName
4.  def circuitOpt: Option[String]

   returns

     Circuit name, if it exists

   Implicit
     This member is added by an implicit conversion from ModuleTarget 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:

         (moduleTarget: CompleteTarget).circuitOpt

   Definition Classes
     Target
5.  def circuitTarget: CircuitTarget

   returns

     The CircuitTarget of this target's circuit

   Implicit
     This member is added by an implicit conversion from ModuleTarget 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:

         (moduleTarget: CompleteTarget).circuitTarget

   Definition Classes
     CompleteTarget
6.  def complete: CompleteTarget

   returns

     Converts this Target into a CompleteTarget

   Implicit
     This member is added by an implicit conversion from ModuleTarget 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:

         (moduleTarget: CompleteTarget).complete

   Definition Classes
     Target
7.  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 ModuleTarget 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:

         (moduleTarget: CompleteTarget).encapsulatedBy(other)

   Definition Classes
     Target
8.  def getComplete: Option[CompleteTarget]

   returns

     If legal, convert this Target into a CompleteTarget

   Implicit
     This member is added by an implicit conversion from ModuleTarget 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:

         (moduleTarget: CompleteTarget).getComplete

   Definition Classes
     CompleteTarget → Target
9.  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 ModuleTarget 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:

         (moduleTarget: CompleteTarget).isLocal

   Definition Classes
     Target
10.  def modify(circuitOpt: Option[String] = circuitOpt, 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 ModuleTarget 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:

          (moduleTarget: CompleteTarget).modify(circuitOpt, moduleOpt, tokens)

    Definition Classes
      Target
11.  def moduleOpt: Option[String]

    returns

      Module name, if it exists

    Implicit
      This member is added by an implicit conversion from ModuleTarget 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:

          (moduleTarget: CompleteTarget).moduleOpt

    Definition Classes
      Target
12.  def path: Seq[(Instance, OfModule)]

    returns

      Returns the instance hierarchy path, if one exists

    Implicit
      This member is added by an implicit conversion from ModuleTarget 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:

          (moduleTarget: CompleteTarget).path

    Definition Classes
      Target
13.  def prettyPrint(tab: String = ""): String

    Pretty serialization, ideal for error messages.

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

    returns

      Human-readable serialization

    Implicit
      This member is added by an implicit conversion from ModuleTarget 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:

          (moduleTarget: CompleteTarget).prettyPrint(tab)

    Definition Classes
      Target
14.  def productElementNames: Iterator[String]
    Implicit
      This member is added by an implicit conversion from ModuleTarget toModuleName performed by method convertModuleTarget2ModuleName 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:

          (moduleTarget: ModuleName).productElementNames

    Definition Classes
      Product
15.  def serialize: String

    returns

      Human-readable serialization

    Implicit
      This member is added by an implicit conversion from ModuleTarget 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:

          (moduleTarget: CompleteTarget).serialize

    Definition Classes
      Target → Named
16.  def serialize: String
    Implicit
      This member is added by an implicit conversion from ModuleTarget 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:

          (moduleTarget: Named).serialize

    Definition Classes
      Named
17.  def serialize: String
    Implicit
      This member is added by an implicit conversion from ModuleTarget toModuleName performed by method convertModuleTarget2ModuleName 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:

          (moduleTarget: ModuleName).serialize

    Definition Classes
      ModuleName → Named
18.  def sharedRoot(other: Target): Boolean

    Share root module

    Share root module

    Implicit
      This member is added by an implicit conversion from ModuleTarget 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:

          (moduleTarget: CompleteTarget).sharedRoot(other)

    Definition Classes
      Target
19.  def toGenericTarget: GenericTarget

    returns

      Converts this Target into a GenericTarget

    Implicit
      This member is added by an implicit conversion from ModuleTarget 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:

          (moduleTarget: CompleteTarget).toGenericTarget

    Definition Classes
      Target
20.  def toNamed: Named

    returns

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

    Implicit
      This member is added by an implicit conversion from ModuleTarget 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:

          (moduleTarget: CompleteTarget).toNamed

    Definition Classes
      Target
21.  def toString(): String
    Implicit
      This member is added by an implicit conversion from ModuleTarget 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:

          (moduleTarget: CompleteTarget).toString()

    Definition Classes
      CompleteTarget → AnyRef → Any
22.  def toTarget: CompleteTarget
    Implicit
      This member is added by an implicit conversion from ModuleTarget 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:

          (moduleTarget: CompleteTarget).toTarget

    Definition Classes
      CompleteTarget → Named
23.  def toTarget: CompleteTarget
    Implicit
      This member is added by an implicit conversion from ModuleTarget 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:

          (moduleTarget: Named).toTarget

    Definition Classes
      Named
24.  def toTarget: ModuleTarget
    Implicit
      This member is added by an implicit conversion from ModuleTarget toModuleName performed by method convertModuleTarget2ModuleName 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:

          (moduleTarget: ModuleName).toTarget

    Definition Classes
      ModuleName → Named
25.  def tokens: Seq[TargetToken]

    returns

      Target tokens

    Implicit
      This member is added by an implicit conversion from ModuleTarget 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:

          (moduleTarget: CompleteTarget).tokens

    Definition Classes
      Target
26.  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 ModuleTarget 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:

          (moduleTarget: CompleteTarget).tryToComplete

    Definition Classes
      Target

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from ModuleTarget toStringFormat[ModuleTarget] 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): (ModuleTarget, B)
   Implicit
     This member is added by an implicit conversion from ModuleTarget toArrowAssoc[ModuleTarget] 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 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

### Inherited by implicit conversion convertNamed2Target fromModuleTarget to CompleteTarget

### Inherited by implicit conversion convertTarget2Named fromModuleTarget to Named

### Inherited by implicit conversion convertModuleTarget2ModuleName fromModuleTarget to ModuleName

### Inherited by implicit conversion any2stringadd fromModuleTarget to any2stringadd[ModuleTarget]

### Inherited by implicit conversion StringFormat fromModuleTarget to StringFormat[ModuleTarget]

### Inherited by implicit conversion Ensuring fromModuleTarget to Ensuring[ModuleTarget]

### Inherited by implicit conversion ArrowAssoc fromModuleTarget to ArrowAssoc[ModuleTarget]

### Ungrouped