trait IsModule extends IsMember
References a module-like target (e.g. a ModuleTarget or an InstanceTarget)
- Source
- Target.scala
- Alphabetic
- By Inheritance
- IsModule
- IsMember
- CompleteTarget
- Target
- Named
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
addHierarchy(root: String, inst: String): InstanceTarget
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
- IsModule → CompleteTarget
- abstract def asPath: Seq[(Instance, OfModule)]
-
abstract
def
circuit: String
- returns
The circuit of this target
- Definition Classes
- CompleteTarget
-
abstract
def
circuitOpt: Option[String]
- returns
Circuit name, if it exists
- Definition Classes
- Target
-
abstract
def
instOf(instance: String, of: String): InstanceTarget
- returns
Creates a new Target, appending an instance and ofmodule
-
abstract
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
- Target
-
abstract
def
justPath: Seq[TargetToken]
- returns
Tokens of just this member's path
- Definition Classes
- IsMember
-
abstract
def
module: String
- returns
Root module, e.g. top-level module of this target
- Definition Classes
- IsMember
-
abstract
def
moduleOpt: Option[String]
- returns
Module name, if it exists
- Definition Classes
- Target
-
abstract
def
notPath: Seq[TargetToken]
- returns
Local tokens of what this member points (not a path)
- Definition Classes
- IsMember
-
abstract
def
path: Seq[(Instance, OfModule)]
- returns
Returns the instance hierarchy path, if one exists
- Definition Classes
- IsMember
-
abstract
def
pathTarget: CompleteTarget
- returns
Member's path target
- Definition Classes
- IsMember
-
abstract
def
pathlessTarget: IsMember
- returns
Same target without a path
- Definition Classes
- IsMember
-
abstract
def
ref(value: String): ReferenceTarget
- returns
Creates a new Target, appending a ref
-
abstract
def
setPathTarget(newPath: IsModule): CompleteTarget
Resets this target to have a new path
Resets this target to have a new path
- Definition Classes
- IsMember
-
abstract
def
targetParent: CompleteTarget
- returns
Member's parent target
- Definition Classes
- IsMember
- abstract def tokens: Seq[TargetToken]
Concrete 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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
circuitTarget: CircuitTarget
- returns
The CircuitTarget of this target's circuit
- Definition Classes
- CompleteTarget
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
complete: CompleteTarget
- returns
Converts this Target into a CompleteTarget
- Definition Classes
- Target
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getComplete: Option[CompleteTarget]
- returns
If legal, convert this Target into a CompleteTarget
- Definition Classes
- CompleteTarget → Target
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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
-
def
moduleTarget: ModuleTarget
- returns
Member's top-level module target
- Definition Classes
- IsMember
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
pathAsTargets: Seq[InstanceTarget]
- returns
List of local Instance Targets refering to each instance/ofModule in this member's path
- Definition Classes
- IsMember
-
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 serialize: String
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toGenericTarget: GenericTarget
- returns
Converts this Target into a GenericTarget
- Definition Classes
- Target
-
def
toNamed: Named
- returns
Converts this Target into either a CircuitName, ModuleName, or ComponentName
- Definition Classes
- Target
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
toTarget: CompleteTarget
- Definition Classes
- CompleteTarget → Named
-
def
tryToComplete: Target
- returns
Converts this Target into a CompleteTarget, or if it can't, return original Target
- Definition Classes
- Target
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
This is the documentation for Firrtl.