Class

firrtl.annotations

CircuitTarget

Related Doc: package annotations

Permalink

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
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CircuitTarget
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. CompleteTarget
  7. Target
  8. Named
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CircuitTarget(circuit: String)

    Permalink

    circuit

    Name of a FIRRTL circuit

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addHierarchy(root: String, instance: String): ReferenceTarget

    Permalink

    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
    CircuitTargetCompleteTarget
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val circuit: String

    Permalink

    Name of a FIRRTL circuit

    Name of a FIRRTL circuit

    Definition Classes
    CircuitTargetCompleteTarget
  7. def circuitOpt: Option[String]

    Permalink

    returns

    Circuit name, if it exists

    Definition Classes
    CircuitTargetTarget
  8. def circuitTarget: CircuitTarget

    Permalink

    returns

    The CircuitTarget of this target's circuit

    Definition Classes
    CompleteTarget
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def complete: CompleteTarget

    Permalink

    returns

    Converts this Target into a CompleteTarget

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

    Permalink

    Checks whether this is inside of other

    Checks whether this is inside of other

    Definition Classes
    Target
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def getComplete: Option[CompleteTarget]

    Permalink

    returns

    If legal, convert this Target into a CompleteTarget

    Definition Classes
    CompleteTargetTarget
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. def isLocal: Boolean

    Permalink

    Whether the target is directly instantiated in its root module

    Whether the target is directly instantiated in its root module

    Definition Classes
    CircuitTargetTarget
  18. def modify(circuitOpt: Option[String] = circuitOpt, moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget

    Permalink

    returns

    Returns a new GenericTarget with new values

    Definition Classes
    Target
  19. def module(m: String): ModuleTarget

    Permalink

    Creates a ModuleTarget of provided name and this circuit

  20. def moduleOpt: Option[String]

    Permalink

    returns

    Module name, if it exists

    Definition Classes
    CircuitTargetTarget
  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. def path: Seq[Nothing]

    Permalink

    returns

    Returns the instance hierarchy path, if one exists

    Definition Classes
    CircuitTargetTarget
  25. def prettyPrint(tab: String = ""): String

    Permalink

    Pretty serialization, ideal for error messages.

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

    returns

    Human-readable serialization

    Definition Classes
    Target
  26. def serialize: String

    Permalink

    returns

    Human-readable serialization

    Definition Classes
    TargetNamed
  27. def sharedRoot(other: Target): Boolean

    Permalink

    Share root module

    Share root module

    Definition Classes
    Target
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. def toGenericTarget: GenericTarget

    Permalink

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    Target
  30. def toNamed: CircuitName

    Permalink

    returns

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

    Definition Classes
    CircuitTargetTarget
  31. def toString(): String

    Permalink
    Definition Classes
    CompleteTarget → AnyRef → Any
  32. def toTarget: CompleteTarget

    Permalink
    Definition Classes
    CompleteTargetNamed
  33. def tokens: Nil.type

    Permalink

    returns

    Target tokens

    Definition Classes
    CircuitTargetTarget
  34. def tryToComplete: Target

    Permalink

    returns

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

    Definition Classes
    Target
  35. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CompleteTarget

Inherited from Target

Inherited from Named

Inherited from AnyRef

Inherited from Any

Ungrouped