trait IsModule extends IsMember
References a module-like target (e.g. a ModuleTarget or an InstanceTarget)
- Source
- Target.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- IsModule
- IsMember
- CompleteTarget
- Target
- Named
- AnyRef
- Any
Implicitly
- by convertNamed2Target
- by convertTarget2Named
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
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 leafModule: String
- 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)]
- 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
- def +(other: String): String
- def ->[B](y: B): (IsModule, B)
- 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(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- def encapsulatingModule: String
- returns
The ModuleTarget of the module that directly contains this component
- Definition Classes
- IsMember
- def encapsulatingModuleTarget: ModuleTarget
- Definition Classes
- IsMember
- def ensuring(cond: (IsModule) => Boolean, msg: => Any): IsModule
- def ensuring(cond: (IsModule) => Boolean): IsModule
- def ensuring(cond: Boolean, msg: => Any): IsModule
- def ensuring(cond: Boolean): IsModule
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- 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
- 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
- Target
- def toNamed: Named
- returns
Converts this Target into either a CircuitName, ModuleName, or ComponentName
- Definition Classes
- Target
- def toString(): String
- Definition Classes
- CompleteTarget → 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(classOf[java.lang.InterruptedException])
- 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()
Shadowed Implicit Value Members
- def addHierarchy(root: String, instance: String): IsComponent
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
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).addHierarchy(root, instance)
- Definition Classes
- CompleteTarget
- def circuit: String
- returns
The circuit of this target
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).circuit
- Definition Classes
- CompleteTarget
- def circuitOpt: Option[String]
- returns
Circuit name, if it exists
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).circuitOpt
- Definition Classes
- Target
- def circuitTarget: CircuitTarget
- returns
The CircuitTarget of this target's circuit
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).circuitTarget
- Definition Classes
- CompleteTarget
- def complete: CompleteTarget
- returns
Converts this Target into a CompleteTarget
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).complete
- Definition Classes
- Target
- def encapsulatedBy(other: IsModule): Boolean
Checks whether this is inside of other
Checks whether this is inside of other
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).encapsulatedBy(other)
- Definition Classes
- Target
- def getComplete: Option[CompleteTarget]
- returns
If legal, convert this Target into a CompleteTarget
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).getComplete
- Definition Classes
- CompleteTarget → Target
- def isLocal: Boolean
Whether the target is directly instantiated in its root module
Whether the target is directly instantiated in its root module
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).isLocal
- Definition Classes
- Target
- def modify(circuitOpt: Option[String] = circuitOpt, moduleOpt: Option[String] = moduleOpt, tokens: Seq[TargetToken] = tokens): GenericTarget
- returns
Returns a new GenericTarget with new values
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).modify(circuitOpt, moduleOpt, tokens)
- Definition Classes
- Target
- def moduleOpt: Option[String]
- returns
Module name, if it exists
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).moduleOpt
- Definition Classes
- Target
- def path: Seq[(Instance, OfModule)]
- returns
Returns the instance hierarchy path, if one exists
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).path
- Definition Classes
- 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
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).prettyPrint(tab)
- Definition Classes
- Target
- def serialize: String
- returns
Human-readable serialization
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).serialize
- Definition Classes
- Target → Named
- def serialize: String
- Implicit
- This member is added by an implicit conversion from IsModule toNamed performed by method convertTarget2Named in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: Named).serialize
- Definition Classes
- Named
- def sharedRoot(other: Target): Boolean
Share root module
Share root module
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).sharedRoot(other)
- Definition Classes
- Target
- def toGenericTarget: GenericTarget
- returns
Converts this Target into a GenericTarget
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).toGenericTarget
- Definition Classes
- Target
- def toNamed: Named
- returns
Converts this Target into either a CircuitName, ModuleName, or ComponentName
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).toNamed
- Definition Classes
- Target
- def toString(): String
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).toString()
- Definition Classes
- CompleteTarget → AnyRef → Any
- def toTarget: CompleteTarget
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).toTarget
- Definition Classes
- CompleteTarget → Named
- def toTarget: CompleteTarget
- Implicit
- This member is added by an implicit conversion from IsModule toNamed performed by method convertTarget2Named in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: Named).toTarget
- Definition Classes
- Named
- def tokens: Seq[TargetToken]
- returns
Target tokens
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).tokens
- Definition Classes
- Target
- def tryToComplete: Target
- returns
Converts this Target into a CompleteTarget, or if it can't, return original Target
- Implicit
- This member is added by an implicit conversion from IsModule toCompleteTarget performed by method convertNamed2Target in firrtl.annotations.Target.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(isModule: CompleteTarget).tryToComplete
- Definition Classes
- Target
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from IsModule toStringFormat[IsModule] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (IsModule, B)
- Implicit
- This member is added by an implicit conversion from IsModule toArrowAssoc[IsModule] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.