Class

spinal.core

MultiData

Related Doc: package core

Permalink

abstract class MultiData extends Data

Base class for multi data like Vec, Bundle

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MultiData
  2. Data
  3. InComponent
  4. OverridedEqualsHashCode
  5. SpinalTagReady
  6. Assignable
  7. NameableByComponent
  8. Nameable
  9. OwnableRef
  10. ContextUser
  11. ScalaLocated
  12. GlobalDataUser
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MultiData()

    Permalink

Type Members

  1. abstract type RefOwnerType

    Permalink
    Definition Classes
    OwnableRef

Abstract Value Members

  1. abstract def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Assignable
  2. abstract def elements: ArrayBuffer[(String, Data)]

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Permalink

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits

    Permalink
    Definition Classes
    Data
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def IFparent: Data

    Permalink
    Definition Classes
    Data
  7. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  8. def addAttribute(attribute: Attribute): MultiData.this.type

    Permalink
    Definition Classes
    DataSpinalTagReady
  9. def addAttribute(name: String, value: Int): MultiData.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  10. def addAttribute(name: String, value: String): MultiData.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  11. def addAttribute(name: String): MultiData.this.type

    Permalink
    Definition Classes
    SpinalTagReady
  12. def addTag[T <: SpinalTag](spinalTag: T): MultiData.this.type

    Permalink
    Definition Classes
    MultiDataSpinalTagReady
  13. def addTags(h: SpinalTag, tail: SpinalTag*): MultiData.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  15. def allowDirectionLessIo(): MultiData.this.type

    Permalink

    Allow a Data of an io Bundle to be directionless

    Allow a Data of an io Bundle to be directionless

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/iobundle.html

    Definition Classes
    Data
  16. def allowOverride(): MultiData.this.type

    Permalink

    Allow a Data to be overriden

    Allow a Data to be overriden

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/assignment_overlap.html

    Definition Classes
    Data
  17. def allowPartialyAssigned(): MultiData.this.type

    Permalink

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  18. def allowPruning(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  19. def allowSimplifyIt(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  20. def allowUnsetRegToAvoidLatch(): MultiData.this.type

    Permalink

    Allow a register to have only an init (no assignments)

    Allow a register to have only an init (no assignments)

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/unassigned_register.html#register-with-only-init

    Definition Classes
    Data
  21. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  22. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiDataData
  23. def asData: Data

    Permalink
    Definition Classes
    Data
  24. def asInOut(): MultiData.this.type

    Permalink

    set a data as inout

    set a data as inout

    Definition Classes
    MultiDataData
  25. def asInput(): MultiData.this.type

    Permalink

    Set a data as input

    Set a data as input

    Definition Classes
    MultiDataData
  26. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  27. def asOutput(): MultiData.this.type

    Permalink

    Set a data as output

    Set a data as output

    Definition Classes
    MultiDataData
  28. def assignDontCare(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  29. def assignDontCareToUnasigned(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  30. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    MultiDataData
  31. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Data
  32. def assignFromBits(bits: Bits, hi: Int, lo: Int): Unit

    Permalink
    Definition Classes
    MultiDataData
  33. def assignFromBits(bits: Bits): Unit

    Permalink
    Definition Classes
    MultiDataData
  34. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit

    Permalink
    Definition Classes
    Data
  35. def assignUnassignedByName(that: MultiData): Unit

    Permalink
  36. def clearAll(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  37. def clone(): Data

    Permalink
    Definition Classes
    Data → AnyRef
  38. def component: Component

    Permalink
    Definition Classes
    ContextUser
  39. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit

    Permalink
    Definition Classes
    Assignable
  40. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable
  41. def copyDirectionOfImpl(that: Data): MultiData.this.type

    Permalink
    Definition Classes
    MultiDataData
  42. def dirString(): String

    Permalink
    Definition Classes
    Data
  43. def dontSimplifyIt(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  44. def elementsString: String

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  49. def find(name: String): Data

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

    Permalink
    Definition Classes
    SpinalTagReady
  51. def flatten: Seq[BaseType]

    Permalink
    Definition Classes
    MultiDataData
  52. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

    Permalink
    Definition Classes
    MultiDataData
  53. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    MultiDataData
  54. def flip(): MultiData.this.type

    Permalink

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    MultiDataData
  55. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

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

    Permalink
    Definition Classes
    SpinalTagReady
  57. def freeze(): MultiData.this.type

    Permalink
    Definition Classes
    MultiDataData
  58. def getAheadValue(): MultiData.this.type

    Permalink

    For a register, get the value it will have at the next clock, as a combinational signal.

    For a register, get the value it will have at the next clock, as a combinational signal.

    Definition Classes
    Data
  59. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

    Definition Classes
    MultiDataData
  60. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  61. def getComponent(): Component

    Permalink
    Definition Classes
    DataInComponentNameableByComponent
  62. def getComponents(): Seq[Component]

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  63. def getDirection: IODirection

    Permalink
    Definition Classes
    Data
  64. def getDisplayName(): String

    Permalink
    Definition Classes
    Nameable
  65. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  66. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  67. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]

    Permalink
    Definition Classes
    Data
  68. def getName(default: String): String

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

    Permalink
    Definition Classes
    NameableByComponentNameable
  70. def getPartialName(): String

    Permalink
    Definition Classes
    Nameable
  71. def getPath(from: Component, to: Component): Seq[Component]

    Permalink
    Definition Classes
    NameableByComponent
  72. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  73. def getRealSourceNoRec: Any

    Permalink
    Definition Classes
    DataAssignable
  74. def getRefOwnersChain(): List[Any]

    Permalink
    Definition Classes
    OwnableRef
  75. def getRootParent: Data

    Permalink
    Definition Classes
    Data
  76. def getRtlPath(separator: String = "/"): String

    Permalink
    Definition Classes
    Data
  77. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  78. def getScalaLocationShort: String

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  82. def getZero: MultiData.this.type

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiDataData
  83. var globalData: GlobalData

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

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

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

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  87. final def initFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    Data
  88. def instanceAttributes(language: Language): Iterable[Attribute]

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

    Permalink
    Definition Classes
    SpinalTagReady
  90. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  91. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  92. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  93. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  94. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  95. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  96. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  97. def isInputOrInOut: Boolean

    Permalink
    Definition Classes
    Data
  98. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  99. final def isNamed: Boolean

    Permalink
    Definition Classes
    Nameable
  100. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  101. def isOutputOrInOut: Boolean

    Permalink
    Definition Classes
    Data
  102. def isPriorityApplicable(namePriority: Byte): Boolean

    Permalink
    Definition Classes
    Nameable
  103. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  104. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data
  105. def isUnnamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  106. var name: String

    Permalink
    Definition Classes
    Nameable
  107. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  109. def noBackendCombMerge(): MultiData.this.type

    Permalink

    Put the combinatorial logic driving this signal in a separate process

    Put the combinatorial logic driving this signal in a separate process

    Definition Classes
    Data
  110. def noCombLoopCheck(): MultiData.this.type

    Permalink

    Disable combinatorial loop checking for this Data

    Disable combinatorial loop checking for this Data

    See https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Design%20errors/combinatorial_loop.html

    Definition Classes
    Data
  111. final def notify(): Unit

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  114. def overrideLocalName(name: String): MultiData.this.type

    Permalink
    Definition Classes
    Nameable
  115. var parent: Data

    Permalink
    Definition Classes
    Data
  116. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  117. def pull(propagateName: Boolean): MultiData.this.type

    Permalink
    Definition Classes
    Data
  118. def pull(): MultiData.this.type

    Permalink

    Pull a signal to the top level (use for debugging)

    Pull a signal to the top level (use for debugging)

    Definition Classes
    Data
  119. def purify(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  120. def randBoot(u: Unit): MultiData.this.type

    Permalink

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Useful for register that doesn't need a reset value in RTL, but need a random value for simulation (avoid x-propagation)

    Definition Classes
    Data
  121. var refOwner: RefOwnerType

    Permalink
    Definition Classes
    OwnableRef
  122. def reflectNames(): Unit

    Permalink
    Definition Classes
    Nameable
  123. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): MultiData.this.type

    Permalink
    Definition Classes
    Data
  124. def removeDataAssignments(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  125. def removeInitAssignments(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  126. def removeTag(spinalTag: SpinalTag): MultiData.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  128. def resized: MultiData.this.type

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  129. def rootIF(): Interface

    Permalink

    root interface

    root interface

    Definition Classes
    Data
  130. def rootIFList(): List[Interface]

    Permalink
    Definition Classes
    Data
  131. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]

    Permalink
    Definition Classes
    Data
  132. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  133. def setAll(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  134. def setAsAnalog(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  135. def setAsComb(): MultiData.this.type

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiDataData
  136. def setAsDirectionLess(): MultiData.this.type

    Permalink

    remove the direction (in,out,inout) to a data

    remove the direction (in,out,inout) to a data

    Definition Classes
    MultiDataData
  137. def setAsReg(): MultiData.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    MultiDataData
  138. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): MultiData.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  143. def setCompositeName(nameable: Nameable): MultiData.this.type

    Permalink
    Definition Classes
    Nameable
  144. def setLambdaName(isNameBody: ⇒ Boolean)(nameGen: ⇒ String): MultiData.this.type

    Permalink
    Definition Classes
    Nameable
  145. def setName(name: String, namePriority: Byte): MultiData.this.type

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

    Permalink
    Definition Classes
    Nameable
  147. def setName(name: String): MultiData.this.type

    Permalink
    Definition Classes
    Nameable
  148. def setNameAsWeak(): MultiData.this.type

    Permalink
    Definition Classes
    Nameable
  149. def setOutputAsReg(): MultiData.this.type

    Permalink

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  150. def setPartialName(name: String, namePriority: Byte, owner: Any): MultiData.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  155. def setPartialName(name: String): MultiData.this.type

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

    Permalink
    Definition Classes
    Nameable
  157. def setPartialName(owner: Nameable): MultiData.this.type

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

    Permalink
    Definition Classes
    OwnableRef
  159. def setScalaLocated(source: ScalaLocated): MultiData.this.type

    Permalink
    Definition Classes
    ScalaLocated
  160. def setWeakName(name: String): MultiData.this.type

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

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

    Permalink
    Definition Classes
    AnyRef
  163. def toIo(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  164. def toMuxInput[T <: Data](muxOutput: T): T

    Permalink
    Definition Classes
    Data
  165. def toString(): String

    Permalink
    Definition Classes
    Nameable → AnyRef → Any
  166. def unfreeze(): MultiData.this.type

    Permalink
    Definition Classes
    MultiDataData
  167. def unsetName(): MultiData.this.type

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  171. def wrapNext(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  172. def zipByName(that: MultiData, rec: ArrayBuffer[(BaseType, BaseType)] = ArrayBuffer()): ArrayBuffer[(BaseType, BaseType)]

    Permalink

Deprecated Value Members

  1. def asDirectionLess(): MultiData.this.type

    Permalink
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

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

  3. def genIf(cond: Boolean): MultiData.this.type

    Permalink

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    does not work with <>, use 'someBool generate Type()' or 'if(condition) Type() else null' instead

Inherited from Data

Inherited from InComponent

Inherited from OverridedEqualsHashCode

Inherited from SpinalTagReady

Inherited from Assignable

Inherited from NameableByComponent

Inherited from Nameable

Inherited from OwnableRef

Inherited from ContextUser

Inherited from ScalaLocated

Inherited from GlobalDataUser

Inherited from AnyRef

Inherited from Any

Ungrouped