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
- Alphabetic
- By Inheritance
- GenericTarget
- Serializable
- Product
- Equals
- Target
- Named
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def add(token: TargetToken): GenericTarget
Appends a target token to tokens, asserts legality
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- lazy val astModule: Option[String]
- val circuitOpt: Option[String]
- returns
Circuit name, if it exists
- Definition Classes
- GenericTarget → Target
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def complete: CompleteTarget
- returns
Converts this Target into a CompleteTarget
- Definition Classes
- Target
- def encapsulatedBy(other: IsModule): Boolean
Checks whether this is inside of other
Checks whether this is inside of other
- Definition Classes
- Target
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getComplete: Option[CompleteTarget]
- returns
If legal, convert this Target into a CompleteTarget
- Definition Classes
- GenericTarget → Target
- def getInstanceOf: Option[(String, String)]
If complete and an instance target, return the instance and ofmodule
- def getPath: Option[Seq[(Instance, OfModule)]]
If complete, return this GenericTarget's path
- def getRef: Option[(String, Seq[TargetToken])]
If complete and a reference, return the reference and subcomponents
- def isCircuitTarget: Boolean
- 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(_)
- def isComponentTarget: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isLegal: Boolean
Checks whether the component is legal (incomplete is ok)
- 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
- def isModuleTarget: Boolean
- 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
- val moduleOpt: Option[String]
- returns
Module name, if it exists
- Definition Classes
- GenericTarget → Target
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def optAdd(token: TargetToken): Option[Target]
Optionally tries to append token to tokens, fails return is not a legal Target
- lazy val parentModule: Option[String]
- def path: Vector[(Instance, OfModule)]
- returns
Returns the instance hierarchy path, if one exists
- Definition Classes
- GenericTarget → Target
- 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
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def remove(n: Int): GenericTarget
Removes n number of target tokens from the right side of tokens
- def serialize: String
- def sharedRoot(other: Target): Boolean
Share root module
Share root module
- Definition Classes
- Target
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toGenericTarget: GenericTarget
- returns
Converts this Target into a GenericTarget
- Definition Classes
- GenericTarget → Target
- def toNamed: Named
- returns
Converts this Target into either a CircuitName, ModuleName, or ComponentName
- Definition Classes
- GenericTarget → Target
- def toTarget: CompleteTarget
- Definition Classes
- GenericTarget → Named
- val tokens: Vector[TargetToken]
- returns
Target tokens
- Definition Classes
- GenericTarget → Target
- def tryToComplete: Target
- returns
Converts this Target into a CompleteTarget, or if it can't, return original Target
- Definition Classes
- Target
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
This is the documentation for Firrtl.