Packages

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

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. val children: ArrayBuffer[Component]

    Contains an array of all children Component

  13. val clockDomain: ClockDomain

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

  14. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  15. def component: Component
    Definition Classes
    ContextUser
  16. var definitionName: String

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

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

    Initialization class delay

    Initialization class delay

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

    Get a set of all IO available in the component

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

    Sort all IO regarding instanceCounter

  35. 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
  36. def getPartialName(): String
    Definition Classes
    Nameable
  37. 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
  38. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  39. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  40. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  41. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  42. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  43. def getTags(): Set[SpinalTag]
    Definition Classes
    SpinalTagReady
  44. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  45. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  46. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  47. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  48. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  49. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  50. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  51. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  52. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  53. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  54. def isUnnamed: Boolean
    Definition Classes
    Nameable
  55. var localNamingScope: NamingScope

    Name allocation

  56. val name: String
    Attributes
    protected
    Definition Classes
    Nameable
  57. def nameElements(): Unit

    Name all Nameable object

  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 postPopEvent(): Unit
    Definition Classes
    Stackable
  68. def postPushEvent(): Unit
    Definition Classes
    Component → Stackable
  69. def prePop(): Unit
  70. def prePopEvent(): Unit
    Definition Classes
    Component → Stackable
  71. var pulledDataCache: Map[Data, Data]

    Reference owner type

  72. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  73. def reflectNames(): Unit
    Definition Classes
    Nameable
  74. def removeTag(spinalTag: SpinalTag): Component.this.type
    Definition Classes
    SpinalTagReady
  75. def removeTags(tags: Iterable[SpinalTag]): Component.this.type
    Definition Classes
    SpinalTagReady
  76. def rework[T](gen: ⇒ T): T

    Rework the component

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

    Set the definition name of the component

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

    Used to store arbitrary object related to the component

  101. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  102. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  103. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    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 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