Packages

abstract class Component extends NameableByComponent with ContextUser with ScalaLocated with PostInitCallback with Stackable with OwnableRef with SpinalTagReady with OverridedEqualsHashCode with ValCallbackRec

Abstract class used to create a new Component

Example: 

  1. class MyAndGate extends Component {
  val io = new Bundle{
    val a,b = in Bool
    val res = out Bool
  }
  io.res := io.a & io.b
}
See also

Component Documentation

Linear Supertypes
ValCallbackRec, ValCallback, OverridedEqualsHashCode, SpinalTagReady, Stackable, PostInitCallback, NameableByComponent, Nameable, ContextUser, ScalaLocated, GlobalDataUser, OwnableRef, AnyRef, Any
Known Subclasses
BlackBox, BlackBoxULogic, Ram_1w_1ra, Ram_1w_1rs, Ram_1wors, Ram_1wrs, Ram_2c_1w_1rs, Ram_2wrs
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Component
  2. ValCallbackRec
  3. ValCallback
  4. OverridedEqualsHashCode
  5. SpinalTagReady
  6. Stackable
  7. PostInitCallback
  8. NameableByComponent
  9. Nameable
  10. ContextUser
  11. ScalaLocated
  12. GlobalDataUser
  13. OwnableRef
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Component()

Type Members

  1. case class PrePopTask(task: () ⇒ Unit, clockDomain: ClockDomain) extends Product with Serializable

    Class used to create a task that must be executed after the creation of the component

  2. abstract type RefOwnerType
    Definition Classes
    OwnableRef

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. val _spinalTags: Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  5. def addAttribute(attribute: Attribute): Component.this.type
    Definition Classes
    Component → SpinalTagReady
  6. def addAttribute(name: String, value: String): Component.this.type
    Definition Classes
    SpinalTagReady
  7. def addAttribute(name: String): Component.this.type
    Definition Classes
    SpinalTagReady
  8. def addPrePopTask(task: () ⇒ Unit): ArrayBuffer[PrePopTask]

    Add a new prePopTask

  9. def addTag[T <: SpinalTag](spinalTag: T): Component.this.type
    Definition Classes
    SpinalTagReady
  10. def addTags[T <: SpinalTag](tags: Iterable[T]): Component.this.type
    Definition Classes
    SpinalTagReady
  11. def afterElaboration(body: ⇒ Unit): ArrayBuffer[PrePopTask]
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. val children: ArrayBuffer[Component]

    Contains an array of all children Component

  14. val clockDomain: ClockDomain

    Get the current clock domain (null if there is no clock domain already set )

  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  16. def component: Component
    Definition Classes
    ContextUser
  17. val definition: SpinalTagReady
  18. var definitionName: String

    Definition Name (name of the entity (VHDL) or module (Verilog))

  19. val dslBody: ScopeStatement
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  22. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean
    Definition Classes
    SpinalTagReady
  23. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  24. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  25. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit
    Definition Classes
    Nameable
  26. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  27. def getAllIo: Set[BaseType]

    Get a set of all IO available in the component

  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def getDisplayName(): String
    Definition Classes
    Component → Nameable
  30. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]
  31. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  32. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  33. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  34. def getName(): String
    Definition Classes
    Nameable
  35. def getOrdredNodeIo: List[BaseType]

    Sort all IO regarding instanceCounter

  36. def getParentsPath(sep: String = "/"): String

    Return the path of the parent

    Return the path of the parent

    Example: 

    1. toplevel/[myComponent1] // Current component is myComponent2
  37. def getPartialName(): String
    Definition Classes
    Nameable
  38. def getPath(sep: String = "/"): String

    Return the path of the component

    Return the path of the component

    Example: 

    1. toplevel/[myComponent1]/[myComponent2] // Current component is myComponent2
  39. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  40. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  41. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  42. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  43. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  44. def getTags(): Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  45. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  46. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  47. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  48. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  49. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  50. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  51. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  52. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  53. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  54. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  55. def isUnnamed: Boolean
    Definition Classes
    Nameable
  56. var localNamingScope: NamingScope

    Name allocation

  57. val name: String
    Attributes
    protected
    Definition Classes
    Nameable
  58. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  59. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  60. def noIoPrefix(): Component.this.type

    No "io_" prefix in front of the in/out signals

  61. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  62. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  63. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit
    Definition Classes
    SpinalTagReady
  64. def parent: Component

    Get the parent component (null if there is no parent)

  65. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  66. def parents(of: Component = this, list: List[Component] = Nil): List[Component]

    Return a list of all parents of the components

  67. def postInitCallback(): Component.this.type
    Definition Classes
    Component → PostInitCallback
  68. def postPopEvent(): Unit
    Definition Classes
    Stackable
  69. def postPushEvent(): Unit
    Definition Classes
    Component → Stackable
  70. def prePop(): Unit
  71. def prePopEvent(): Unit
    Definition Classes
    Component → Stackable
  72. var pulledDataCache: Map[Data, Data]

    Reference owner type

  73. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  74. def reflectBaseType(name: String): BaseType
  75. def reflectNames(): Unit
    Definition Classes
    Nameable
  76. def removeTag(spinalTag: SpinalTag): Component.this.type
    Definition Classes
    SpinalTagReady
  77. def removeTags(tags: Iterable[SpinalTag]): Component.this.type
    Definition Classes
    SpinalTagReady
  78. def rework[T](gen: ⇒ T): T
  79. val scopeProperties: LinkedHashMap[ScopeProperty[Any], Any]

    Rework the component

  80. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  81. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  82. def setCompositeName(nameable: Nameable, postfix: String): Component.this.type
    Definition Classes
    Nameable
  83. def setCompositeName(nameable: Nameable, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  84. def setCompositeName(nameable: Nameable, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  85. def setCompositeName(nameable: Nameable): Component.this.type
    Definition Classes
    Nameable
  86. def setDefinitionName(name: String): Component.this.type

    Set the definition name of the component

  87. def setName(name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  88. def setName(name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  89. def setName(name: String): Component.this.type
    Definition Classes
    Nameable
  90. def setNameAsWeak(): Component.this.type
    Definition Classes
    Nameable
  91. def setPartialName(name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  92. def setPartialName(name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  93. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Component.this.type
    Definition Classes
    Nameable
  94. def setPartialName(owner: Nameable, name: String, weak: Boolean): Component.this.type
    Definition Classes
    Nameable
  95. def setPartialName(name: String): Component.this.type
    Definition Classes
    Nameable
  96. def setPartialName(owner: Nameable, name: String): Component.this.type
    Definition Classes
    Nameable
  97. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  98. def setScalaLocated(source: ScalaLocated): Component.this.type
    Definition Classes
    ScalaLocated
  99. def setWeakName(name: String): Component.this.type
    Definition Classes
    Nameable
  100. def spinalTags: Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  101. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  102. def toString(): String
    Definition Classes
    Nameable → AnyRef → Any
  103. def unsetName(): Component.this.type
    Definition Classes
    Nameable
  104. val userCache: Map[AnyRef, Map[AnyRef, AnyRef]]

    Used to store arbitrary object related to the component

  105. def valCallback[T](ref: T, name: String): T
    Definition Classes
    ValCallbackRec → ValCallback
  106. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit
    Definition Classes
    ValCallbackRec
  107. def valCallbackRec(ref: Any, name: String): Unit
    Definition Classes
    Component → ValCallbackRec
  108. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  109. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  110. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  111. def withKeywords(): Unit
  112. def withoutKeywords(): Unit
  113. var withoutReservedKeywords: Boolean

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from ValCallbackRec

Inherited from ValCallback

Inherited from OverridedEqualsHashCode

Inherited from SpinalTagReady

Inherited from Stackable

Inherited from PostInitCallback

Inherited from NameableByComponent

Inherited from Nameable

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped