spinal.core

Component

Related Docs: object Component | package core

abstract class Component extends NameableByComponent with GlobalDataUser with ScalaLocated with DelayedInit with Stackable with OwnableRef

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
Stackable, DelayedInit, ScalaLocated, NameableByComponent, GlobalDataUser, Nameable, 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. Stackable
  3. DelayedInit
  4. ScalaLocated
  5. NameableByComponent
  6. GlobalDataUser
  7. Nameable
  8. OwnableRef
  9. AnyRef
  10. 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. def addPrePopTask(task: () ⇒ Unit): ArrayBuffer[PrePopTask]

    Add a new prePopTask

  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  6. val children: ArrayBuffer[Component]

    Contains an array of all children Component

  7. val clockDomain: ClockDomain

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

  8. def clone(): AnyRef

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

  9. var definitionName: String

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

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

    Initialization class delay

    Initialization class delay

    Definition Classes
    Component → DelayedInit

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

    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  13. def finalize(): Unit

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

  14. def forEachNameables(doThat: (Any) ⇒ Unit): Unit

    Definition Classes
    Nameable

  15. def getAdditionalNodesRoot: Set[Node]

  16. def getAllIo: Set[BaseType]

    Get a set of all IO available in the component

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

    Definition Classes
    AnyRef → Any

  18. def getDisplayName(): String

    Definition Classes
    Component → Nameable

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

  20. def getName(): String

    Definition Classes
    NameableByComponent → Nameable

  21. def getName(default: String): String

    Definition Classes
    Nameable

  22. def getOrdredNodeIo: List[BaseType]

    Sort all IO regarding instanceCounter

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

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

  25. def getRefOwnersChain(): List[Any]

    Definition Classes
    OwnableRef

  26. def getScalaLocationLong: String

    Definition Classes
    ScalaLocated

  27. def getScalaLocationShort: String

    Definition Classes
    ScalaLocated

  28. val globalData: GlobalData

    Definition Classes
    GlobalDataUser

  29. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  30. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  31. def isNamed: Boolean

    Definition Classes
    Nameable

  32. def isUnnamed: Boolean

    Definition Classes
    Nameable

  33. def nameElements(): Unit

    Name all Nameable object

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

    Definition Classes
    AnyRef

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

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

  36. var nodes: ArrayBuffer[Node]

    Contains all nodes of the components

  37. final def notify(): Unit

    Definition Classes
    AnyRef

  38. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  39. val parent: Component

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

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

    Return a list of all parents of the components

  41. def postPopEvent(): Unit

    Definition Classes
    Stackable

  42. def postPushEvent(): Unit

    Definition Classes
    Component → Stackable

  43. def prePopEvent(): Unit

    Definition Classes
    Component → Stackable

  44. var refOwner: RefOwnerType

    Definition Classes
    OwnableRef

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

    Rework the component

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Set the definition name of the component

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

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

    Definition Classes
    Nameable

  56. def setRefOwner(that: Any): Unit

    Definition Classes
    OwnableRef

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

    Definition Classes
    Nameable

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

    Definition Classes
    AnyRef

  59. def toString(): String

    Definition Classes
    Nameable → AnyRef → Any

  60. def unsetName(): Unit

    Definition Classes
    Nameable

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

    Used to store arbitrary object related to the component

  62. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Stackable

Inherited from DelayedInit

Inherited from ScalaLocated

Inherited from NameableByComponent

Inherited from GlobalDataUser

Inherited from Nameable

Inherited from OwnableRef

Inherited from AnyRef

Inherited from Any

Ungrouped