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, clockDomain: ClockDomain) 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: String): Component.this.type

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

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

    Permalink

    Add a new prePopTask

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

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

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

    Permalink
  12. final def asInstanceOf[T0]: T0

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

    Permalink

    Contains an array of all children Component

  14. val clockDomain: ClockDomain

    Permalink

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

  15. def clone(): AnyRef

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

    Permalink
    Definition Classes
    ContextUser
  17. val definition: SpinalTagReady

    Permalink
  18. var definitionName: String

    Permalink

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

  19. val dslBody: ScopeStatement

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

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

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

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

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

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

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

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

    Permalink

    Get a set of all IO available in the component

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

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

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

    Permalink
  31. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  32. def getMode: Byte

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

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

    Permalink
    Definition Classes
    Nameable
  35. def getOrdredNodeIo: List[BaseType]

    Permalink

    Sort all IO regarding instanceCounter

  36. 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
  37. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  38. 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
  39. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  40. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  41. def getScalaLocationShort: String

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  45. val globalData: GlobalData

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  51. def isEmptyOfTag: Boolean

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

    Permalink
    Definition Classes
    Any
  53. def isNamed: Boolean

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

    Permalink
    Definition Classes
    Nameable
  55. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  56. var localNamingScope: NamingScope

    Permalink

    Name allocation

  57. var name: String

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

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

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

    Permalink

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

  61. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  63. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

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

    Permalink
    Definition Classes
    Nameable
  65. def parent: Component

    Permalink

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

  66. var parentScope: ScopeStatement

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

    Permalink

    Return a list of all parents of the components

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

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

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

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

    Permalink
  72. def prePopEvent(): Unit

    Permalink
    Definition Classes
    ComponentStackable
  73. def propagateIo[T <: Data](childIo: T): T

    Permalink
  74. var pulledDataCache: Map[Data, Data]

    Permalink

    Reference owner type

  75. var refOwner: RefOwnerType

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

    Permalink
  77. def reflectNames(): Unit

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

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

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

    Permalink
  81. val scopeProperties: LinkedHashMap[ScopeProperty[Any], Any]

    Permalink

    Rework the component

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

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  88. def setDefinitionName(name: String): Component.this.type

    Permalink

    Set the definition name of the component

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  103. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Permalink
    Definition Classes
    Nameable
  106. val userCache: Map[AnyRef, Map[AnyRef, AnyRef]]

    Permalink

    Used to store arbitrary object related to the component

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  113. def withKeywords(): Unit

    Permalink
  114. def withoutKeywords(): Unit

    Permalink
  115. 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