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 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. var _spinalTags: LinkedHashSet[SpinalTag]

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  13. 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
  14. 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
  15. def allowPartialyAssigned(): MultiData.this.type

    Permalink

    Allow a register to be partially assigned

    Allow a register to be partially assigned

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

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

    Permalink
    Definition Classes
    Data
  18. 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
  19. def as[T <: Data](dataType: HardType[T]): T

    Permalink
    Definition Classes
    Data
  20. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    MultiDataData
  21. def asData: Data

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

    Permalink

    set a data as inout

    set a data as inout

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

    Permalink

    Set a data as input

    Set a data as input

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

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

    Permalink

    Set a data as output

    Set a data as output

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

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

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

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

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

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

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

    Permalink
  33. def clone(): Data

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

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

    Permalink
    Definition Classes
    Assignable
  36. var compositeAssign: Assignable

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

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

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

    Permalink
    Definition Classes
    Data
  40. def elementsString: String

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

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

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

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

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

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

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

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

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

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

    Permalink

    flip the direction of the data

    flip the direction of the data

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

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

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

    Permalink
    Definition Classes
    MultiDataData
  54. def genIf(cond: Boolean): MultiData.this.type

    Permalink

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  55. def getAheadValue(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  56. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

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

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

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

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  60. def getDirection: IODirection

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

    Permalink
    Definition Classes
    Nameable
  62. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  63. def getMode: Byte

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

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

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

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

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

    Permalink
    Definition Classes
    NameableByComponent
  69. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  70. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  72. def getRootParent: Data

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

    Permalink
    Definition Classes
    Data
  74. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  75. def getScalaLocationShort: String

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

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

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

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

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    MultiDataData
  80. val globalData: GlobalData

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

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

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

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

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  87. def isAnalog: Boolean

    Permalink
    Definition Classes
    Data
  88. def isComb: Boolean

    Permalink
    Definition Classes
    Data
  89. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  90. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  91. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  92. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  93. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  94. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  96. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  97. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  98. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  100. def isReg: Boolean

    Permalink
    Definition Classes
    Data
  101. def isRegOnAssign: Boolean

    Permalink
    Definition Classes
    Data
  102. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  103. var name: String

    Permalink
    Definition Classes
    Nameable
  104. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  106. 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
  107. 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
  108. final def notify(): Unit

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

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

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

    Permalink
    Definition Classes
    Nameable
  112. var parent: Data

    Permalink
    Definition Classes
    Data
  113. var parentScope: ScopeStatement

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

    Permalink
    Definition Classes
    Data
  115. 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
  116. def purify(): MultiData.this.type

    Permalink
    Definition Classes
    Data
  117. 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
  118. var refOwner: RefOwnerType

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

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

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

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

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

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

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

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  126. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  127. def setAsAnalog(): MultiData.this.type

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

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    MultiDataData
  129. 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
  130. def setAsReg(): MultiData.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Data
  164. 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.

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