Class/Object

spinal.core

Component

Related Docs: object Component | package core

Permalink

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
Known Subclasses
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()

    Permalink

Type Members

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

    Permalink

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

  2. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  5. def addAttribute(attribute: Attribute): Component.this.type

    Permalink
    Definition Classes
    ComponentSpinalTagReady
  6. def addAttribute(name: String, value: Int): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  7. def addAttribute(name: String, value: String): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  8. def addAttribute(name: String): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  9. def addPrePopTask(task: () ⇒ Unit): ArrayBuffer[PrePopTask]

    Permalink

    Add a new prePopTask

  10. def addTag[T <: SpinalTag](spinalTag: T): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  11. def addTags[T <: SpinalTag](tags: Iterable[T]): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  12. def afterElaboration(body: ⇒ Unit): ArrayBuffer[PrePopTask]

    Permalink
  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  14. val children: ArrayBuffer[Component]

    Permalink

    Contains an array of all children Component

  15. val clockDomain: Handle[ClockDomain]

    Permalink

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

  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  17. def component: Component

    Permalink
    Definition Classes
    ContextUser
  18. val definition: SpinalTagReady

    Permalink
  19. var definitionName: String

    Permalink

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

  20. var definitionNameNoMerge: Boolean

    Permalink
  21. val dslBody: ScopeStatement

    Permalink
  22. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  24. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  25. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  26. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  27. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  28. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  29. def getAllIo: Set[BaseType]

    Permalink

    Get a set of all IO available in the component

  30. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  31. def getDisplayName(): String

    Permalink
    Definition Classes
    ComponentNameable
  32. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]

    Permalink
  33. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  34. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  35. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  36. def getName(): String

    Permalink
    Definition Classes
    NameableByComponentNameable
  37. def getOrdredNodeIo: List[BaseType]

    Permalink

    Sort all IO regarding instanceCounter

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

    Permalink

    Return the path of the parent

    Return the path of the parent

    Example:
    1. toplevel/[myComponent1] // Current component is myComponent2
  39. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  40. def getPath(sep: String = "/"): String

    Permalink

    Return the path of the component

    Return the path of the component

    Example:
    1. toplevel/[myComponent1]/[myComponent2] // Current component is myComponent2
  41. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  42. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  43. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated
  44. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated
  45. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Permalink
    Definition Classes
    SpinalTagReady
  46. def getTags(): LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  47. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  48. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  49. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  50. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  51. def instanceAttributes(language: Language): Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  52. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady
  53. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  54. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  55. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  56. def isLogicLess: Boolean

    Permalink
  57. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  58. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  59. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  60. var localNamingScope: NamingScope

    Permalink

    Name allocation

  61. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  62. var nameableRef: Nameable

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  63. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  64. def noIoPrefix(): Component.this.type

    Permalink

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

  65. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  66. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  67. def onBody[T](body: ⇒ T): T

    Permalink
  68. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  69. def overrideLocalName(name: String): Component.this.type

    Permalink
    Definition Classes
    Nameable
  70. def parent: Component

    Permalink

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

  71. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  72. def parents(of: Component = this, list: List[Component] = Nil): List[Component]

    Permalink

    Return a list of all parents of the components

  73. def postInitCallback(): Component.this.type

    Permalink
    Definition Classes
    Component → PostInitCallback
  74. def postPopEvent(): Unit

    Permalink
    Definition Classes
    Stackable
  75. def postPushEvent(): Unit

    Permalink
    Definition Classes
    ComponentStackable
  76. def prePop(): Unit

    Permalink
  77. def prePopEvent(): Unit

    Permalink
    Definition Classes
    ComponentStackable
  78. var pulledDataCache: Map[Data, Data]

    Permalink

    Reference owner type

  79. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  80. def reflectBaseType(name: String): BaseType

    Permalink
  81. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  82. def removeTag(spinalTag: SpinalTag): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  83. def removeTags(tags: Iterable[SpinalTag]): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  84. def rework[T](gen: ⇒ T): T

    Permalink
  85. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  86. val scopeProperties: Capture

    Permalink

    Rework the component

  87. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Component.this.type

    Permalink
    Definition Classes
    Nameable
  88. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Component.this.type

    Permalink
    Definition Classes
    Nameable
  89. def setCompositeName(nameable: Nameable, postfix: String): Component.this.type

    Permalink
    Definition Classes
    Nameable
  90. def setCompositeName(nameable: Nameable, namePriority: Byte): Component.this.type

    Permalink
    Definition Classes
    Nameable
  91. def setCompositeName(nameable: Nameable, weak: Boolean): Component.this.type

    Permalink
    Definition Classes
    Nameable
  92. def setCompositeName(nameable: Nameable): Component.this.type

    Permalink
    Definition Classes
    Nameable
  93. def setDefinitionName(name: String, noMerge: Boolean = true): Component.this.type

    Permalink

    Set the definition name of the component

  94. def setName(name: String, namePriority: Byte): Component.this.type

    Permalink
    Definition Classes
    Nameable
  95. def setName(name: String, weak: Boolean): Component.this.type

    Permalink
    Definition Classes
    Nameable
  96. def setName(name: String): Component.this.type

    Permalink
    Definition Classes
    Nameable
  97. def setNameAsWeak(): Component.this.type

    Permalink
    Definition Classes
    Nameable
  98. def setPartialName(name: String, namePriority: Byte): Component.this.type

    Permalink
    Definition Classes
    Nameable
  99. def setPartialName(name: String, weak: Boolean): Component.this.type

    Permalink
    Definition Classes
    Nameable
  100. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Component.this.type

    Permalink
    Definition Classes
    Nameable
  101. def setPartialName(owner: Nameable, name: String, weak: Boolean): Component.this.type

    Permalink
    Definition Classes
    Nameable
  102. def setPartialName(name: String): Component.this.type

    Permalink
    Definition Classes
    Nameable
  103. def setPartialName(owner: Nameable, name: String): Component.this.type

    Permalink
    Definition Classes
    Nameable
  104. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef
  105. def setScalaLocated(source: ScalaLocated): Component.this.type

    Permalink
    Definition Classes
    ScalaLocated
  106. def setWeakName(name: String): Component.this.type

    Permalink
    Definition Classes
    Nameable
  107. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  108. def stub(): Component.this.type

    Permalink

    Empty Component, remove logic in component and assign zero on output port as stub

    Empty Component, remove logic in component and assign zero on output port as stub

    Example:
    1. val dut = (new MyComponent).stub()
  109. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  110. def toString(): String

    Permalink
    Definition Classes
    Nameable → AnyRef → Any
  111. def unsetName(): Component.this.type

    Permalink
    Definition Classes
    Nameable
  112. val userCache: Map[Any, Any]

    Permalink

    Used to store arbitrary object related to the component

  113. def valCallback[T](ref: T, name: String): T

    Permalink
    Definition Classes
    ValCallbackRec → ValCallback
  114. def valCallbackOn(ref: Any, name: String, refs: Set[Any]): Unit

    Permalink
    Definition Classes
    ValCallbackRec
  115. def valCallbackRec(ref: Any, name: String): Unit

    Permalink
    Definition Classes
    ComponentValCallbackRec
  116. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  117. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  118. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  119. def walkComponents(body: (Component) ⇒ Unit): Unit

    Permalink
  120. def withKeywords(): Unit

    Permalink
  121. def withoutKeywords(): Unit

    Permalink
  122. var withoutReservedKeywords: Boolean

    Permalink

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    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