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

# GenericTarget

###

#### case class GenericTarget(circuitOpt: Option[String], moduleOpt: Option[String], tokens: Vector[TargetToken]) extends Target with Product with Serializable

Represents incomplete or non-standard Targets

circuitOpt

  Optional circuit name

moduleOpt

  Optional module name

tokens

  TargetTokens to represent the target in a circuit and module

Source
  Target.scala

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

1. Alphabetic
2. By Inheritance

Inherited

1. GenericTarget
2. Serializable
3. Product
4. Equals
5. Target
6. Named
7. AnyRef
8. 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

### Instance Constructors

1.  new GenericTarget(circuitOpt: Option[String], moduleOpt: Option[String], tokens: Vector[TargetToken])

   circuitOpt

     Optional circuit name

   moduleOpt

     Optional module name

   tokens

     TargetTokens to represent the target in a circuit and 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 GenericTarget toany2stringadd[GenericTarget] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (GenericTarget, B)
   Implicit
     This member is added by an implicit conversion from GenericTarget toArrowAssoc[GenericTarget] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  def add(token: TargetToken): GenericTarget

   Appends a target token to tokens, asserts legality

7.  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 GenericTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
   Definition Classes
     CompleteTarget
8.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
9.  lazy val astModule: Option[String]
10.  def circuit: String

    returns

      The circuit of this target

    Implicit
      This member is added by an implicit conversion from GenericTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Definition Classes
      CompleteTarget
11.  val circuitOpt: Option[String]

    returns

      Circuit name, if it exists

    Definition Classes
      GenericTarget → Target
12.  def circuitTarget: CircuitTarget

    returns

      The CircuitTarget of this target's circuit

    Implicit
      This member is added by an implicit conversion from GenericTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Definition Classes
      CompleteTarget
13.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
14.  def complete: CompleteTarget

    returns

      Converts this Target into a CompleteTarget

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

    Checks whether this is inside of other

    Checks whether this is inside of other

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

    returns

      If legal, convert this Target into a CompleteTarget

    Definition Classes
      GenericTarget → Target
24.  def getInstanceOf: Option[(String, String)]

    If complete and an instance target, return the instance and ofmodule

25.  def getPath: Option[Seq[(Instance, OfModule)]]

    If complete, return this GenericTarget's path

26.  def getRef: Option[(String, Seq[TargetToken])]

    If complete and a reference, return the reference and subcomponents

27.  def isCircuitTarget: Boolean
28.  def isComplete: Boolean

    Checks whether the component is legal and complete, meaning the circuitOpt and moduleOpt are nonEmpty and all Instance(_) are followed by OfModule(_)

29.  def isComponentTarget: Boolean
30.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
31.  def isLegal: Boolean

    Checks whether the component is legal (incomplete is ok)

32.  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
      GenericTarget → Target
33.  def isModuleTarget: Boolean
34.  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
35.  val moduleOpt: Option[String]

    returns

      Module name, if it exists

    Definition Classes
      GenericTarget → Target
36.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
37.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
38.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
39.  def optAdd(token: TargetToken): Option[Target]

    Optionally tries to append token to tokens, fails return is not a legal Target

40.  lazy val parentModule: Option[String]
41.  def path: Vector[(Instance, OfModule)]

    returns

      Returns the instance hierarchy path, if one exists

    Definition Classes
      GenericTarget → Target
42.  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
43.  def productElementNames: Iterator[String]
    Definition Classes
      Product
44.  def remove(n: Int): GenericTarget

    Removes n number of target tokens from the right side of tokens

45.  def serialize: String

    returns

      Human-readable serialization

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

    Share root module

    Share root module

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

    returns

      Converts this Target into a GenericTarget

    Definition Classes
      GenericTarget → Target
49.  def toNamed: Named

    returns

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

    Definition Classes
      GenericTarget → Target
50.  def toString(): String
    Implicit
      This member is added by an implicit conversion from GenericTarget toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
    Definition Classes
      CompleteTarget → AnyRef → Any
51.  def toTarget: CompleteTarget
    Definition Classes
      GenericTarget → Named
52.  val tokens: Vector[TargetToken]

    returns

      Target tokens

    Definition Classes
      GenericTarget → Target
53.  def tryToComplete: Target

    returns

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

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

### Shadowed Implicit Value Members

1.  def circuitOpt: Option[String]

   returns

     Circuit name, if it exists

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

         (genericTarget: CompleteTarget).circuitOpt

   Definition Classes
     Target
2.  def complete: CompleteTarget

   returns

     Converts this Target into a CompleteTarget

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

         (genericTarget: CompleteTarget).complete

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

         (genericTarget: CompleteTarget).encapsulatedBy(other)

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

   returns

     If legal, convert this Target into a CompleteTarget

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

         (genericTarget: CompleteTarget).getComplete

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

         (genericTarget: CompleteTarget).isLocal

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

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

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

   returns

     Module name, if it exists

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

         (genericTarget: CompleteTarget).moduleOpt

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

   returns

     Returns the instance hierarchy path, if one exists

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

         (genericTarget: CompleteTarget).path

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

         (genericTarget: CompleteTarget).prettyPrint(tab)

   Definition Classes
     Target
10.  def serialize: String

    returns

      Human-readable serialization

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

          (genericTarget: CompleteTarget).serialize

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

          (genericTarget: Named).serialize

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

    Share root module

    Share root module

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

          (genericTarget: CompleteTarget).sharedRoot(other)

    Definition Classes
      Target
13.  def toGenericTarget: GenericTarget

    returns

      Converts this Target into a GenericTarget

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

          (genericTarget: CompleteTarget).toGenericTarget

    Definition Classes
      Target
14.  def toNamed: Named

    returns

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

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

          (genericTarget: CompleteTarget).toNamed

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

          (genericTarget: CompleteTarget).toTarget

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

          (genericTarget: Named).toTarget

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

    returns

      Target tokens

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

          (genericTarget: CompleteTarget).tokens

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

          (genericTarget: CompleteTarget).tryToComplete

    Definition Classes
      Target

### Deprecated Value Members

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

### Inherited from Named

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion convertNamed2Target fromGenericTarget to CompleteTarget

### Inherited by implicit conversion convertTarget2Named fromGenericTarget to Named

### Inherited by implicit conversion any2stringadd fromGenericTarget to any2stringadd[GenericTarget]

### Inherited by implicit conversion StringFormat fromGenericTarget to StringFormat[GenericTarget]

### Inherited by implicit conversion Ensuring fromGenericTarget to Ensuring[GenericTarget]

### Inherited by implicit conversion ArrowAssoc fromGenericTarget to ArrowAssoc[GenericTarget]

### Ungrouped