c

firrtl.annotations

CircuitTarget

case class CircuitTarget(circuit: String) extends CompleteTarget with Product with Serializable

Target pointing to a FIRRTL firrtl.ir.Circuit

circuit

Name of a FIRRTL circuit

Source
Target.scala
Linear Supertypes
Serializable, Product, Equals, CompleteTarget, Target, Named, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CircuitTarget
  2. Serializable
  3. Product
  4. Equals
  5. CompleteTarget
  6. Target
  7. Named
  8. AnyRef
  9. Any
Implicitly
  1. by convertNamed2Target
  2. by convertTarget2Named
  3. by convertCircuitTarget2CircuitName
  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 CircuitTarget(circuit: String)

    circuit

    Name of a FIRRTL circuit

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

    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
    CircuitTarget → CompleteTarget
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val circuit: String

    returns

    The circuit of this target

    Definition Classes
    CircuitTarget → CompleteTarget
  9. def circuitOpt: Option[String]

    returns

    Circuit name, if it exists

    Definition Classes
    CircuitTarget → Target
  10. def circuitTarget: CircuitTarget

    returns

    The CircuitTarget of this target's circuit

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

    returns

    Converts this Target into a CompleteTarget

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

    Checks whether this is inside of other

    Checks whether this is inside of other

    Definition Classes
    Target
  14. def ensuring(cond: (CircuitTarget) => Boolean, msg: => Any): CircuitTarget
    Implicit
    This member is added by an implicit conversion from CircuitTarget toEnsuring[CircuitTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (CircuitTarget) => Boolean): CircuitTarget
    Implicit
    This member is added by an implicit conversion from CircuitTarget toEnsuring[CircuitTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): CircuitTarget
    Implicit
    This member is added by an implicit conversion from CircuitTarget toEnsuring[CircuitTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): CircuitTarget
    Implicit
    This member is added by an implicit conversion from CircuitTarget toEnsuring[CircuitTarget] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  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. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. 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
    CircuitTarget → Target
  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 module(m: String): ModuleTarget

    Creates a ModuleTarget of provided name and this circuit

  26. def moduleOpt: Option[String]

    returns

    Module name, if it exists

    Definition Classes
    CircuitTarget → Target
  27. val name: String
    Implicit
    This member is added by an implicit conversion from CircuitTarget toCircuitName performed by method convertCircuitTarget2CircuitName in firrtl.annotations.Target.
    Definition Classes
    CircuitName
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. def path: Seq[Nothing]

    returns

    Returns the instance hierarchy path, if one exists

    Definition Classes
    CircuitTarget → Target
  32. 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
  33. def productElementNames: Iterator[String]
    Definition Classes
    Product
  34. def serialize: String

    returns

    Human-readable serialization

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

    Share root module

    Share root module

    Definition Classes
    Target
  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  37. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    Target
  38. def toNamed: CircuitName

    returns

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

    Definition Classes
    CircuitTarget → Target
  39. def toString(): String
    Definition Classes
    CompleteTarget → AnyRef → Any
  40. def toTarget: CompleteTarget
    Definition Classes
    CompleteTarget → Named
  41. def tokens: Nil

    returns

    Target tokens

    Definition Classes
    CircuitTarget → Target
  42. def tryToComplete: Target

    returns

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

    Definition Classes
    Target
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. 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 CircuitTarget 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:
    (circuitTarget: 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 CircuitTarget 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:
    (circuitTarget: 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 CircuitTarget 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:
    (circuitTarget: 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 CircuitTarget 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:
    (circuitTarget: 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 CircuitTarget 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:
    (circuitTarget: 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 CircuitTarget 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:
    (circuitTarget: 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 CircuitTarget 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:
    (circuitTarget: 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 CircuitTarget 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:
    (circuitTarget: 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 CircuitTarget 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:
    (circuitTarget: 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 CircuitTarget 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:
    (circuitTarget: 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 CircuitTarget 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:
    (circuitTarget: 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 CircuitTarget 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:
    (circuitTarget: CompleteTarget).prettyPrint(tab)
    Definition Classes
    Target
  13. def productElementNames: Iterator[String]
    Implicit
    This member is added by an implicit conversion from CircuitTarget toCircuitName performed by method convertCircuitTarget2CircuitName 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:
    (circuitTarget: CircuitName).productElementNames
    Definition Classes
    Product
  14. def serialize: String

    returns

    Human-readable serialization

    Implicit
    This member is added by an implicit conversion from CircuitTarget 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:
    (circuitTarget: CompleteTarget).serialize
    Definition Classes
    Target → Named
  15. def serialize: String
    Implicit
    This member is added by an implicit conversion from CircuitTarget 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:
    (circuitTarget: Named).serialize
    Definition Classes
    Named
  16. def serialize: String
    Implicit
    This member is added by an implicit conversion from CircuitTarget toCircuitName performed by method convertCircuitTarget2CircuitName 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:
    (circuitTarget: CircuitName).serialize
    Definition Classes
    CircuitName → Named
  17. def sharedRoot(other: Target): Boolean

    Share root module

    Share root module

    Implicit
    This member is added by an implicit conversion from CircuitTarget 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:
    (circuitTarget: CompleteTarget).sharedRoot(other)
    Definition Classes
    Target
  18. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

    Implicit
    This member is added by an implicit conversion from CircuitTarget 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:
    (circuitTarget: CompleteTarget).toGenericTarget
    Definition Classes
    Target
  19. def toNamed: Named

    returns

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

    Implicit
    This member is added by an implicit conversion from CircuitTarget 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:
    (circuitTarget: CompleteTarget).toNamed
    Definition Classes
    Target
  20. def toString(): String
    Implicit
    This member is added by an implicit conversion from CircuitTarget 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:
    (circuitTarget: CompleteTarget).toString()
    Definition Classes
    CompleteTarget → AnyRef → Any
  21. def toTarget: CompleteTarget
    Implicit
    This member is added by an implicit conversion from CircuitTarget 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:
    (circuitTarget: CompleteTarget).toTarget
    Definition Classes
    CompleteTarget → Named
  22. def toTarget: CompleteTarget
    Implicit
    This member is added by an implicit conversion from CircuitTarget 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:
    (circuitTarget: Named).toTarget
    Definition Classes
    Named
  23. def toTarget: CircuitTarget
    Implicit
    This member is added by an implicit conversion from CircuitTarget toCircuitName performed by method convertCircuitTarget2CircuitName 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:
    (circuitTarget: CircuitName).toTarget
    Definition Classes
    CircuitName → Named
  24. def tokens: Seq[TargetToken]

    returns

    Target tokens

    Implicit
    This member is added by an implicit conversion from CircuitTarget 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:
    (circuitTarget: CompleteTarget).tokens
    Definition Classes
    Target
  25. 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 CircuitTarget 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:
    (circuitTarget: CompleteTarget).tryToComplete
    Definition Classes
    Target

Deprecated Value Members

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

Inherited from Target

Inherited from Named

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion convertNamed2Target fromCircuitTarget to CompleteTarget

Inherited by implicit conversion convertTarget2Named fromCircuitTarget to Named

Inherited by implicit conversion convertCircuitTarget2CircuitName fromCircuitTarget to CircuitName

Inherited by implicit conversion any2stringadd fromCircuitTarget to any2stringadd[CircuitTarget]

Inherited by implicit conversion StringFormat fromCircuitTarget to StringFormat[CircuitTarget]

Inherited by implicit conversion Ensuring fromCircuitTarget to Ensuring[CircuitTarget]

Inherited by implicit conversion ArrowAssoc fromCircuitTarget to ArrowAssoc[CircuitTarget]

Ungrouped