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

t

firrtl.annotations

# IsModule

###

#### trait IsModule extends IsMember

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

Source
  Target.scala

Linear Supertypes
IsMember, CompleteTarget, Target, Named, AnyRef, Any
Known Subclasses
InstanceTarget, ModuleTarget
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. IsModule
2. IsMember
3. CompleteTarget
4. Target
5. Named
6. AnyRef
7. Any

Implicitly

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

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Abstract Value Members

1.  abstract def addHierarchy(root: String, inst: 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
     IsModule → 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 instOf(instance: String, of: String): InstanceTarget

   returns

     Creates a new Target, appending an instance and ofmodule

6.  abstract 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
     Target
7.  abstract def justPath: Seq[TargetToken]

   returns

     Tokens of just this member's path

   Definition Classes
     IsMember
8.  abstract def leafModule: String
   Definition Classes
     IsMember
9.  abstract def module: String

   returns

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

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

    returns

      Module name, if it exists

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

    returns

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

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

    returns

      Returns the instance hierarchy path, if one exists

    Definition Classes
      IsMember → Target
13.  abstract def pathTarget: CompleteTarget

    returns

      Member's path target

    Definition Classes
      IsMember
14.  abstract def pathlessTarget: IsMember

    returns

      Same target without a path

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

    returns

      Creates a new Target, appending a ref

16.  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
17.  abstract def targetParent: CompleteTarget

    returns

      Member's parent target

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

    returns

      Target tokens

    Definition Classes
      Target

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

   returns

     The CircuitTarget of this target's circuit

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

   returns

     Converts this Target into a CompleteTarget

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

    Checks whether this is inside of other

    Checks whether this is inside of other

    Definition Classes
      Target
11.  def encapsulatingModule: String

    returns

      The ModuleTarget of the module that directly contains this component

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

    returns

      If legal, convert this Target into a CompleteTarget

    Definition Classes
      CompleteTarget → Target
22.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
23.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
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.  def moduleTarget: ModuleTarget

    returns

      Member's top-level module target

    Definition Classes
      IsMember
26.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
27.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
28.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
29.  def pathAsTargets: Seq[InstanceTarget]

    returns

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

    Definition Classes
      IsMember
30.  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
31.  def serialize: String

    returns

      Human-readable serialization

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

    Share root module

    Share root module

    Definition Classes
      Target
33.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
34.  def toGenericTarget: GenericTarget

    returns

      Converts this Target into a GenericTarget

    Definition Classes
      Target
35.  def toNamed: Named

    returns

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

    Definition Classes
      Target
36.  def toString(): String
    Definition Classes
      CompleteTarget → AnyRef → Any
37.  def toTarget: CompleteTarget
    Definition Classes
      CompleteTarget → Named
38.  def tryToComplete: Target

    returns

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

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

         (isModule: 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 IsModule 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:

         (isModule: CompleteTarget).circuit

   Definition Classes
     CompleteTarget
3.  def circuitOpt: Option[String]

   returns

     Circuit name, if it exists

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

         (isModule: CompleteTarget).circuitOpt

   Definition Classes
     Target
4.  def circuitTarget: CircuitTarget

   returns

     The CircuitTarget of this target's circuit

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

         (isModule: CompleteTarget).circuitTarget

   Definition Classes
     CompleteTarget
5.  def complete: CompleteTarget

   returns

     Converts this Target into a CompleteTarget

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

         (isModule: CompleteTarget).complete

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

         (isModule: CompleteTarget).encapsulatedBy(other)

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

   returns

     If legal, convert this Target into a CompleteTarget

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

         (isModule: CompleteTarget).getComplete

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

         (isModule: CompleteTarget).isLocal

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

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

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

    returns

      Module name, if it exists

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

          (isModule: CompleteTarget).moduleOpt

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

    returns

      Returns the instance hierarchy path, if one exists

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

          (isModule: CompleteTarget).path

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

          (isModule: CompleteTarget).prettyPrint(tab)

    Definition Classes
      Target
13.  def serialize: String

    returns

      Human-readable serialization

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

          (isModule: CompleteTarget).serialize

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

          (isModule: Named).serialize

    Definition Classes
      Named
15.  def sharedRoot(other: Target): Boolean

    Share root module

    Share root module

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

          (isModule: CompleteTarget).sharedRoot(other)

    Definition Classes
      Target
16.  def toGenericTarget: GenericTarget

    returns

      Converts this Target into a GenericTarget

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

          (isModule: CompleteTarget).toGenericTarget

    Definition Classes
      Target
17.  def toNamed: Named

    returns

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

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

          (isModule: CompleteTarget).toNamed

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

          (isModule: CompleteTarget).toString()

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

          (isModule: CompleteTarget).toTarget

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

          (isModule: Named).toTarget

    Definition Classes
      Named
21.  def tokens: Seq[TargetToken]

    returns

      Target tokens

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

          (isModule: CompleteTarget).tokens

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

          (isModule: CompleteTarget).tryToComplete

    Definition Classes
      Target

### Deprecated Value Members

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

### Inherited from CompleteTarget

### Inherited from Target

### Inherited from Named

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion convertNamed2Target fromIsModule to CompleteTarget

### Inherited by implicit conversion convertTarget2Named fromIsModule to Named

### Inherited by implicit conversion any2stringadd fromIsModule to any2stringadd[IsModule]

### Inherited by implicit conversion StringFormat fromIsModule to StringFormat[IsModule]

### Inherited by implicit conversion Ensuring fromIsModule to Ensuring[IsModule]

### Inherited by implicit conversion ArrowAssoc fromIsModule to ArrowAssoc[IsModule]

### Ungrouped