Class

firrtl.annotations

GenericTarget

Related Doc: package annotations

Permalink

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

Instance Constructors

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

    Permalink

    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

    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 add(token: TargetToken): GenericTarget

    Permalink

    Appends a target token to tokens, asserts legality

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val circuitOpt: Option[String]

    Permalink

    Optional circuit name

    Optional circuit name

    Definition Classes
    GenericTargetTarget
  7. def clone(): AnyRef

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

    Permalink

    returns

    Converts this Target into a CompleteTarget

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

    Permalink
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  11. def getComplete: Option[CompleteTarget]

    Permalink

    returns

    If legal, convert this Target into a CompleteTarget

    Definition Classes
    GenericTargetTarget
  12. def getInstanceOf: Option[(String, String)]

    Permalink

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

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

    Permalink

    If complete, return this GenericTarget's path

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

    Permalink

    If complete and a reference, return the reference and subcomponents

  15. def isCircuitTarget: Boolean

    Permalink
  16. def isComplete: Boolean

    Permalink

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

  17. def isComponentTarget: Boolean

    Permalink
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. def isLegal: Boolean

    Permalink

    Checks whether the component is legal (incomplete is ok)

  20. 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
    GenericTargetTarget
  21. def isModuleTarget: Boolean

    Permalink
  22. 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
  23. val moduleOpt: Option[String]

    Permalink

    Optional module name

    Optional module name

    Definition Classes
    GenericTargetTarget
  24. final def ne(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  27. def optAdd(token: TargetToken): Option[Target]

    Permalink

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

  28. 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
  29. def remove(n: Int): GenericTarget

    Permalink

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

  30. def serialize: String

    Permalink

    returns

    Human-readable serialization

    Definition Classes
    TargetNamed
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. def toGenericTarget: GenericTarget

    Permalink

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    GenericTargetTarget
  33. def toNamed: Named

    Permalink

    returns

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

    Definition Classes
    GenericTargetTarget
  34. def toTarget: CompleteTarget

    Permalink
    Definition Classes
    GenericTargetNamed
  35. val tokens: Vector[TargetToken]

    Permalink

    TargetTokens to represent the target in a circuit and module

    TargetTokens to represent the target in a circuit and module

    Definition Classes
    GenericTargetTarget
  36. def tryToComplete: Target

    Permalink

    returns

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

    Definition Classes
    Target
  37. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(): Unit

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

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Target

Inherited from Named

Inherited from AnyRef

Inherited from Any

Ungrouped