spinal.core

Component

Related Docs: object Component | package core

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

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
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. SpinalTagReady
  3. Stackable
  4. DelayedInit
  5. NameableByComponent
  6. Nameable
  7. ContextUser
  8. ScalaLocated
  9. GlobalDataUser
  10. OwnableRef
  11. AnyRef
  12. Any
  1. Hide All
  2. Show all
Learn more about member selection
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. type RefOwnerType = Component

    Reference owner type

    Reference owner type

    Definition Classes
    Component → 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. var _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(spinalTag: SpinalTag): Component.this.type

    Definition Classes
    SpinalTagReady

  10. def addTags(tags: Iterable[SpinalTag]): 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
    @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(arg0: Any): Boolean

    Definition Classes
    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 finalize(): Unit

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

  24. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

    Definition Classes
    SpinalTagReady

  25. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Definition Classes
    Nameable

  26. def getAllIo: Set[BaseType]

    Get a set of all IO available in the component

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

    Definition Classes
    AnyRef → Any

  28. def getDisplayName(): String

    Definition Classes
    Component → Nameable

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

  30. def getInstanceCounter: Int

    Definition Classes
    ContextUser

  31. def getName(): String

    Definition Classes
    NameableByComponent → Nameable

  32. def getName(default: String): String

    Definition Classes
    Nameable

  33. def getOrdredNodeIo: List[BaseType]

    Sort all IO regarding instanceCounter

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

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

  36. def getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef

  37. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated

  38. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated

  39. def getScalaTrace(): Throwable

    Definition Classes
    ContextUser → ScalaLocated

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

    Definition Classes
    SpinalTagReady

  41. val globalData: GlobalData

    Definition Classes
    GlobalDataUser

  42. def hasTag(spinalTag: SpinalTag): Boolean

    Definition Classes
    SpinalTagReady

  43. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    SpinalTagReady

  45. def instanceAttributes: Iterable[Attribute]

    Definition Classes
    SpinalTagReady

  46. def isEmptyOfTag: Boolean

    Definition Classes
    SpinalTagReady

  47. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  48. def isNamed: Boolean

    Definition Classes
    Nameable

  49. def isUnnamed: Boolean

    Definition Classes
    Nameable

  50. var localNamingScope: NamingScope

    Name allocation

  51. def nameElements(): Unit

    Name all Nameable object

  52. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  53. def noIoPrefix(): Component.this.type

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

  54. final def notify(): Unit

    Definition Classes
    AnyRef

  55. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    SpinalTagReady

  57. def parent: Component

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

  58. var parentScope: ScopeStatement

    Definition Classes
    ContextUser

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

    Return a list of all parents of the components

  60. def postPopEvent(): Unit

    Definition Classes
    Stackable

  61. def postPushEvent(): Unit

    Definition Classes
    Component → Stackable

  62. def prePop(): Unit

  63. def prePopEvent(): Unit

    Definition Classes
    Component → Stackable

  64. var pulledDataCache: Map[Data, Data]

  65. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef

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

    Definition Classes
    SpinalTagReady

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

    Definition Classes
    SpinalTagReady

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

    Rework the component

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Set the definition name of the component

  74. def setName(name: String, weak: Boolean = false): Component.this.type

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

  79. def setRefOwner(that: Any): Unit

    Definition Classes
    OwnableRef

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

    Definition Classes
    ScalaLocated

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

    Definition Classes
    Nameable

  82. def spinalTags: Set[SpinalTag]

    Definition Classes
    SpinalTagReady

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

    Definition Classes
    AnyRef

  84. def toString(): String

    Definition Classes
    Nameable → AnyRef → Any

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

    Definition Classes
    Nameable

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

    Used to store arbitrary object related to the component

  87. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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