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

# CompleteTarget

###

#### trait CompleteTarget extends Target

Concretely points to a FIRRTL target, no generic selectors IsLegal

Source
  Target.scala

Linear Supertypes
Target, Named, AnyRef, Any
Known Subclasses
CircuitTarget, InstanceTarget, IsComponent, IsMember, IsModule, ModuleTarget, ReferenceTarget
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. CompleteTarget
2. Target
3. Named
4. AnyRef
5. Any

Implicitly

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

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Abstract Value Members

1.  abstract 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

2.  abstract def circuit: String

   returns

     The circuit of this target

3.  abstract def circuitOpt: Option[String]

   returns

     Circuit name, if it exists

   Definition Classes
     Target
4.  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
5.  abstract def moduleOpt: Option[String]

   returns

     Module name, if it exists

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

   returns

     Returns the instance hierarchy path, if one exists

   Definition Classes
     Target
7.  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 CompleteTarget toany2stringadd[CompleteTarget] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (CompleteTarget, B)
   Implicit
     This member is added by an implicit conversion from CompleteTarget toArrowAssoc[CompleteTarget] 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

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

    returns

      If legal, convert this Target into a CompleteTarget

    Definition Classes
      CompleteTarget → Target
20.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
21.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
22.  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
23.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
24.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
25.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
26.  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
27.  def serialize: String

    returns

      Human-readable serialization

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

    Share root module

    Share root module

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

    returns

      Converts this Target into a GenericTarget

    Definition Classes
      Target
31.  def toNamed: Named

    returns

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

    Definition Classes
      Target
32.  def toString(): String
    Definition Classes
      CompleteTarget → AnyRef → Any
33.  def toTarget: CompleteTarget
    Definition Classes
      CompleteTarget → Named
34.  def tryToComplete: Target

    returns

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

    Definition Classes
      Target
35.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
36.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
37.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Shadowed Implicit Value Members

1.  def serialize: String
   Implicit
     This member is added by an implicit conversion from CompleteTarget 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:

         (completeTarget: Named).serialize

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

         (completeTarget: Named).toTarget

   Definition Classes
     Named

### Deprecated Value Members

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

### Inherited from Named

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion convertTarget2Named fromCompleteTarget to Named

### Inherited by implicit conversion any2stringadd fromCompleteTarget to any2stringadd[CompleteTarget]

### Inherited by implicit conversion StringFormat fromCompleteTarget to StringFormat[CompleteTarget]

### Inherited by implicit conversion Ensuring fromCompleteTarget to Ensuring[CompleteTarget]

### Inherited by implicit conversion ArrowAssoc fromCompleteTarget to ArrowAssoc[CompleteTarget]

### Ungrouped