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
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])

    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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def add(token: TargetToken): GenericTarget

    Appends a target token to tokens, asserts legality

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. lazy val astModule: Option[String]
  7. val circuitOpt: Option[String]

    returns

    Circuit name, if it exists

    Definition Classes
    GenericTargetTarget
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getComplete: Option[CompleteTarget]

    returns

    If legal, convert this Target into a CompleteTarget

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

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

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

    If complete, return this GenericTarget's path

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

    If complete and a reference, return the reference and subcomponents

  18. def isCircuitTarget: Boolean
  19. 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(_)

  20. def isComponentTarget: Boolean
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isLegal: Boolean

    Checks whether the component is legal (incomplete is ok)

  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
    GenericTargetTarget
  24. def isModuleTarget: Boolean
  25. 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
  26. val moduleOpt: Option[String]

    returns

    Module name, if it exists

    Definition Classes
    GenericTargetTarget
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. def optAdd(token: TargetToken): Option[Target]

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

  31. lazy val parentModule: Option[String]
  32. def path: Vector[(Instance, OfModule)]

    returns

    Returns the instance hierarchy path, if one exists

    Definition Classes
    GenericTargetTarget
  33. 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
  34. def remove(n: Int): GenericTarget

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

  35. def serialize: String

    returns

    Human-readable serialization

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

    Share root module

    Share root module

    Definition Classes
    Target
  37. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  38. def toGenericTarget: GenericTarget

    returns

    Converts this Target into a GenericTarget

    Definition Classes
    GenericTargetTarget
  39. def toNamed: Named

    returns

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

    Definition Classes
    GenericTargetTarget
  40. def toTarget: CompleteTarget
    Definition Classes
    GenericTargetNamed
  41. val tokens: Vector[TargetToken]

    returns

    Target tokens

    Definition Classes
    GenericTargetTarget
  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( ... )
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

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