Class/Object

spinal.core

Component

Related Docs: object Component | package core

Permalink

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

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
OverridedEqualsHashCode, SpinalTagReady, Stackable, DelayedInit, 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. OverridedEqualsHashCode
  3. SpinalTagReady
  4. Stackable
  5. DelayedInit
  6. NameableByComponent
  7. Nameable
  8. ContextUser
  9. ScalaLocated
  10. GlobalDataUser
  11. OwnableRef
  12. AnyRef
  13. 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: Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  5. def addAttribute(attribute: Attribute): Component.this.type

    Permalink
    Definition Classes
    Component → SpinalTagReady

  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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  12. val children: ArrayBuffer[Component]

    Permalink

    Contains an array of all children Component

  13. val clockDomain: ClockDomain

    Permalink

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

  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  15. def component: Component

    Permalink
    Definition Classes
    ContextUser

  16. var definitionName: String

    Permalink

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

  17. def delayedInit(body: ⇒ Unit): Unit

    Permalink

    Initialization class delay

    Initialization class delay

    Definition Classes
    Component → DelayedInit

  18. val dslBody: ScopeStatement

    Permalink

  19. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

  21. def existsTag(cond: (SpinalTag) ⇒ Boolean): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  22. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  23. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  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 getAllIo: Set[BaseType]

    Permalink

    Get a set of all IO available in the component

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

    Permalink
    Definition Classes
    AnyRef → Any

  28. def getDisplayName(): String

    Permalink
    Definition Classes
    Component → Nameable

  29. def getGroupedIO(ioBundleBypass: Boolean): Seq[Data]

    Permalink

  30. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser

  31. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  32. def getName(default: String): String

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  33. def getName(): String

    Permalink
    Definition Classes
    Nameable

  34. def getOrdredNodeIo: List[BaseType]

    Permalink

    Sort all IO regarding instanceCounter

  35. 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

  36. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable

  37. 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

  38. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef

  39. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated

  40. def getScalaLocationShort: String

    Permalink
    Definition Classes
    ScalaLocated

  41. def getScalaTrace(): Throwable

    Permalink
    Definition Classes
    ScalaLocated

  42. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]

    Permalink
    Definition Classes
    SpinalTagReady

  43. def getTags(): Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  44. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser

  45. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  46. def hasTag(spinalTag: SpinalTag): Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  47. def hashCode(): Int

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any

  48. def instanceAttributes(language: Language): Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  49. def instanceAttributes: Iterable[Attribute]

    Permalink
    Definition Classes
    SpinalTagReady

  50. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady

  51. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  52. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponent → Nameable

  53. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable

  54. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable

  55. var localNamingScope: NamingScope

    Permalink

    Name allocation

  56. var name: String

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable

  57. def nameElements(): Unit

    Permalink

    Name all Nameable object

  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

  62. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  63. def onEachAttributes(doIt: (Attribute) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady

  64. def parent: Component

    Permalink

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

  65. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser

  66. def parents(of: Component = this, list: List[Component] = Nil): List[Component]

    Permalink

    Return a list of all parents of the components

  67. def postPopEvent(): Unit

    Permalink
    Definition Classes
    Stackable

  68. def postPushEvent(): Unit

    Permalink
    Definition Classes
    Component → Stackable

  69. def prePop(): Unit

    Permalink

  70. def prePopEvent(): Unit

    Permalink
    Definition Classes
    Component → Stackable

  71. var pulledDataCache: Map[Data, Data]

    Permalink

    Reference owner type

  72. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

  73. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable

  74. def removeTag(spinalTag: SpinalTag): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  75. def removeTags(tags: Iterable[SpinalTag]): Component.this.type

    Permalink
    Definition Classes
    SpinalTagReady

  76. def rework[T](gen: ⇒ T): T

    Permalink

    Rework the component

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

    Permalink
    Definition Classes
    Nameable

  78. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Component.this.type

    Permalink
    Definition Classes
    Nameable

  79. def setCompositeName(nameable: Nameable, postfix: String): Component.this.type

    Permalink
    Definition Classes
    Nameable

  80. def setCompositeName(nameable: Nameable, namePriority: Byte): Component.this.type

    Permalink
    Definition Classes
    Nameable

  81. def setCompositeName(nameable: Nameable, weak: Boolean): Component.this.type

    Permalink
    Definition Classes
    Nameable

  82. def setCompositeName(nameable: Nameable): Component.this.type

    Permalink
    Definition Classes
    Nameable

  83. def setDefinitionName(name: String): Component.this.type

    Permalink

    Set the definition name of the component

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

    Permalink
    Definition Classes
    Nameable

  85. def setName(name: String, weak: Boolean): Component.this.type

    Permalink
    Definition Classes
    Nameable

  86. def setName(name: String): Component.this.type

    Permalink
    Definition Classes
    Nameable

  87. def setPartialName(name: String, namePriority: Byte): Component.this.type

    Permalink
    Definition Classes
    Nameable

  88. def setPartialName(name: String, weak: Boolean): Component.this.type

    Permalink
    Definition Classes
    Nameable

  89. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Component.this.type

    Permalink
    Definition Classes
    Nameable

  90. def setPartialName(owner: Nameable, name: String, weak: Boolean): Component.this.type

    Permalink
    Definition Classes
    Nameable

  91. def setPartialName(name: String): Component.this.type

    Permalink
    Definition Classes
    Nameable

  92. def setPartialName(owner: Nameable, name: String): Component.this.type

    Permalink
    Definition Classes
    Nameable

  93. def setRefOwner(that: Any): Unit

    Permalink
    Definition Classes
    OwnableRef

  94. def setScalaLocated(source: ScalaLocated): Component.this.type

    Permalink
    Definition Classes
    ScalaLocated

  95. def setWeakName(name: String): Component.this.type

    Permalink
    Definition Classes
    Nameable

  96. def spinalTags: Set[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady

  97. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  98. def toString(): String

    Permalink
    Definition Classes
    Nameable → AnyRef → Any

  99. def unsetName(): Component.this.type

    Permalink
    Definition Classes
    Nameable

  100. val userCache: Map[AnyRef, Map[AnyRef, AnyRef]]

    Permalink

    Used to store arbitrary object related to the component

  101. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  102. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  103. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from OverridedEqualsHashCode

Inherited from SpinalTagReady

Inherited from Stackable

Inherited from DelayedInit

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