Packages

class Bool extends BaseType with DataPrimitives[Bool] with BaseTypePrimitives[Bool] with BitwiseOp[Bool]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bool
  2. BitwiseOp
  3. BaseTypePrimitives
  4. DataPrimitives
  5. BaseType
  6. Expression
  7. StatementDoubleLinkedContainer
  8. DoubleLinkedContainer
  9. DeclarationStatement
  10. LeafStatement
  11. Statement
  12. BaseNode
  13. ExpressionContainer
  14. Data
  15. InComponent
  16. OverridedEqualsHashCode
  17. SpinalTagReady
  18. Assignable
  19. NameableByComponent
  20. Nameable
  21. OwnableRef
  22. ContextUser
  23. ScalaLocated
  24. GlobalDataUser
  25. AnyRef
  26. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Bool()

Type Members

  1. class MuxBuilder[T <: Data] extends AnyRef

    Class used to write conditional operation on Data value

    Class used to write conditional operation on Data value

    Example:

    1. val res = myBool ? myBits1 | myBits2
  2. case class MuxBuilderEnum[T <: SpinalEnum](whenTrue: SpinalEnumCraft[T]) extends Product with Serializable

    Class used to write conditional operation on Enumeration value

    Class used to write conditional operation on Enumeration value

    Example:

    1. val res = myBool ? myEnum1 | myEnum2
    Note

    implicit conversion is used to send SpinalEnumElement

  3. abstract type RefOwnerType
    Definition Classes
    OwnableRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. def ##(right: Data): Bits

    Concatenation between two data

    Concatenation between two data

    Definition Classes
    Data
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. def #*(count: Int): Bits
    Definition Classes
    Data
  5. def &(b: Bool): Bool

    Bitwise AND operator

    Bitwise AND operator

    Definition Classes
    Bool → BitwiseOp
  6. def &&(b: Bool): Bool

    Logical AND

    Logical AND

    returns

    a Bool assign with the AND result

    Example:

    1. val result = myBool1 && myBool2
  7. def :=(that: Bool)(implicit loc: Location): Unit

    Assign a data to this

    Assign a data to this

    Definition Classes
    DataPrimitives
  8. def <>(that: Bool)(implicit loc: Location): Unit

    Auto connection between two data

    Auto connection between two data

    Definition Classes
    DataPrimitives
  9. def =/=(that: MaskedBoolean): Bool

    BitVector is not equal to MaskedLiteral

  10. def =/=(that: Bool): Bool
    Definition Classes
    DataPrimitives
  11. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def ===(that: MaskedBoolean): Bool
  13. def ===(that: Bool): Bool

    Comparison between two data

    Comparison between two data

    Definition Classes
    DataPrimitives
  14. def ?[T <: SpinalEnum](whenTrue: SpinalEnumCraft[T]): MuxBuilderEnum[T]

    Conditional operation for Enumeration value

  15. def ?[T <: Data](whenTrue: T): MuxBuilder[T]

    Conditional operation for Data value

  16. def \(that: Bool): Bool

    Use as \= to have the same behavioral as VHDL variable

    Use as \= to have the same behavioral as VHDL variable

    Definition Classes
    DataPrimitives
  17. def ^(b: Bool): Bool

    Bitwise XOR operator

    Bitwise XOR operator

    Definition Classes
    Bool → BitwiseOp
  18. val _spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  19. def addAttribute(attribute: Attribute): Bool.this.type
    Definition Classes
    BaseType → Data → SpinalTagReady
  20. def addAttribute(name: String, value: Int): Bool.this.type
    Definition Classes
    SpinalTagReady
  21. def addAttribute(name: String, value: String): Bool.this.type
    Definition Classes
    SpinalTagReady
  22. def addAttribute(name: String): Bool.this.type
    Definition Classes
    SpinalTagReady
  23. def addTag[T <: SpinalTag](spinalTag: T): Bool.this.type
    Definition Classes
    SpinalTagReady
  24. def addTags(h: SpinalTag, tail: SpinalTag*): Bool.this.type
    Definition Classes
    SpinalTagReady
  25. def addTags[T <: SpinalTag](tags: Iterable[T]): Bool.this.type
    Definition Classes
    SpinalTagReady
  26. val algoIncrementale: Int
    Definition Classes
    BaseNode
  27. val algoInt: Int
    Definition Classes
    BaseNode
  28. def allowDirectionLessIo(): Bool.this.type

    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
  29. def allowOutOfRangeLiterals: Bool.this.type
  30. def allowOverride(): Bool.this.type

    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
  31. def allowPartialyAssigned(): Bool.this.type

    Allow a register to be partially assigned

    Allow a register to be partially assigned

    Definition Classes
    Data
  32. def allowPruning(): Bool.this.type
    Definition Classes
    Data
  33. def allowSimplifyIt(): Bool.this.type
    Definition Classes
    BaseType → Data
  34. def allowUnsetRegToAvoidLatch(): Bool.this.type

    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
  35. def as[T <: Data](dataType: HardType[T]): T
    Definition Classes
    Data
  36. def asBits: Bits

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    Bool → Data
  37. def asBits(bitCount: BitCount): Bits

    Cast a Bool to an Bits of a given width

    Cast a Bool to an Bits of a given width

    bitCount

    the width of the Bits

    returns

    a Bits data of a given length initialize to this

  38. def asData: Data
    Definition Classes
    Data
  39. def asInOut(): Bool.this.type

    set a data as inout

    set a data as inout

    Definition Classes
    BaseType → Data
  40. def asInput(): Bool.this.type

    Set a data as input

    Set a data as input

    Definition Classes
    BaseType → Data
  41. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  42. def asOutput(): Bool.this.type

    Set a data as output

    Set a data as output

    Definition Classes
    BaseType → Data
  43. def asSInt(bitCount: BitCount): SInt
  44. def asSInt: SInt

    Cast a Bool to an SInt

    Cast a Bool to an SInt

    returns

    a SInt data

    Example:

    1. mySInt := myBool.asSInt
  45. def asUInt(bitCount: BitCount): UInt

    Cast a Bool to an UInt of a given width

    Cast a Bool to an UInt of a given width

    bitCount

    the width of the UInt

    returns

    an UInt data of a given length initialize to this

    Example:

    1. myUInt := myBool.asUInt(8 bits)
  46. def asUInt: UInt

    Cast a Bool to an UInt

    Cast a Bool to an UInt

    returns

    an UInt data

    Example:

    1. myUInt := myBool.asUInt
  47. def assignDontCare(): Bool.this.type
    Definition Classes
    Bool → Data
  48. def assignDontCareToUnasigned(): Bool.this.type
    Definition Classes
    Data
  49. def assignFormalRandom(kind: RandomExpKind): Unit
    Definition Classes
    Bool → Data
  50. final def assignFrom(that: AnyRef, target: AnyRef = this)(implicit loc: Location): Unit
    Definition Classes
    Data
  51. def assignFromBits(bits: Bits, hi: Int, low: Int): Unit
    Definition Classes
    Bool → Data
  52. def assignFromBits(bits: Bits): Unit
    Definition Classes
    Bool → Data
  53. def assignFromBits(bits: Bits, offset: Int, bitCount: BitCount): Unit
    Definition Classes
    Data
  54. def assignFromImpl(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Attributes
    protected
    Definition Classes
    BaseType → Assignable
  55. def cldCount: Int
    Definition Classes
    DoubleLinkedContainer
  56. def clear(): Unit

    this is assigned to False

  57. def clearAll(): Bool.this.type

    Set to False.

    Set to False.

    Direct call to clear() to reduce the number of nodes in the netlist.

    Definition Classes
    Bool → Data
  58. def clearWhen(cond: Bool)(implicit loc: Location): Bool

    this is assigned to False when cond is True

  59. var clockDomain: ClockDomain
    Definition Classes
    BaseType
  60. def clone(): Bool.this.type
    Definition Classes
    BaseType → Data → AnyRef
  61. def component: Component
    Definition Classes
    ContextUser
  62. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef)(implicit loc: Location): Unit
    Definition Classes
    Assignable
  63. val compositeAssign: Assignable
    Definition Classes
    Assignable
  64. def copyDirectionOf(that: Bool): Unit
    Definition Classes
    DataPrimitives
  65. def copyDirectionOfImpl(that: Data): Bool.this.type
    Definition Classes
    BaseType → Data
  66. def default(that: => Bool): Bool

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  67. def dirString(): String
    Definition Classes
    Data
  68. def dlcAppend(that: AssignmentStatement): Bool.this.type
    Definition Classes
    DoubleLinkedContainer
  69. def dlcForeach[T >: AssignmentStatement](func: (T) => Unit): Unit
    Definition Classes
    DoubleLinkedContainer
  70. def dlcHasOnlyOne: Boolean
    Definition Classes
    DoubleLinkedContainer
  71. val dlcHead: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  72. def dlcIsEmpty: Boolean
    Definition Classes
    DoubleLinkedContainer
  73. val dlcLast: AssignmentStatement
    Definition Classes
    DoubleLinkedContainer
  74. def dlcPrepend(that: AssignmentStatement): Bool.this.type
    Definition Classes
    DoubleLinkedContainer
  75. def dontSimplifyIt(): Bool.this.type
    Definition Classes
    BaseType → Data
  76. def edge(): Bool

    Edge detection

  77. def edge(initAt: Bool): Bool

    Edge detection of this with an initial value

    Edge detection of this with an initial value

    initAt

    the initial value

    returns

    a Bool

    Example:

    1. val res = myBool.edge(False)
  78. def edges(): BoolEdges

    Edge detection without intial value

  79. def edges(initAt: Bool): BoolEdges

    Detect all edges (falling, rising, toogling)

    Detect all edges (falling, rising, toogling)

    initAt

    the initial value

    returns

    a BoolEdges

    Example:

    1. val res = myBool.edges()
when(res.fall){...}
when(res.rise){...}
when(res.toggle){...}
  80. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  81. def equals(obj: Any): Boolean
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  82. def existsTag(cond: (SpinalTag) => Boolean): Boolean
    Definition Classes
    SpinalTagReady
  83. def fall(): Bool

    Falling edge detection

  84. def fall(initAt: Bool): Bool

    Falling edge detection of this with an initial value

    Falling edge detection of this with an initial value

    initAt

    the initial value

    returns

    a Bool

    Example:

    1. val res = myBool.fall(False)
  85. def fallWhen(cond: Bool)(implicit loc: Location): Bool

    this is assigned to False when cond is True and the current value of this is True.

    this is assigned to False when cond is True and the current value of this is True. see riseWhen()

  86. def filterTag(cond: (SpinalTag) => Boolean): Iterable[SpinalTag]
    Definition Classes
    SpinalTagReady
  87. def findTag(cond: (SpinalTag) => Boolean): Option[SpinalTag]
    Definition Classes
    SpinalTagReady
  88. def flatten: Seq[BaseType]
    Definition Classes
    BaseType → Data
  89. def flattenForeach(body: (BaseType) => Unit): Unit
    Definition Classes
    BaseType → Data
  90. def flattenLocalName: Seq[String]
    Definition Classes
    BaseType → Data
  91. def flip(): Bool.this.type

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  92. def foreachClockDomain(func: (ClockDomain) => Unit): Unit
    Definition Classes
    BaseType → Statement
  93. def foreachDrivingExpression(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  94. def foreachExpression(func: (Expression) => Unit): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  95. def foreachReflectableNameables(doThat: (Any) => Unit): Unit
    Definition Classes
    Nameable
  96. def foreachStatements(func: (AssignmentStatement) => Unit): Unit
    Definition Classes
    StatementDoubleLinkedContainer
  97. def foreachTag(body: (SpinalTag) => Unit): Unit
    Definition Classes
    SpinalTagReady
  98. def freeze(): Bool.this.type
    Definition Classes
    BaseType → Data
  99. def getAheadValue(): Bool.this.type
    Definition Classes
    BaseType → Data
  100. def getBitsWidth: Int

    Return the width of the data

    Return the width of the data

    Definition Classes
    Bool → Data
  101. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  102. def getComponent(): Component
    Definition Classes
    Data → InComponent → NameableByComponent
  103. def getComponents(): Seq[Component]

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  104. def getDirection: IODirection
    Definition Classes
    Data
  105. def getDisplayName(): String
    Definition Classes
    Nameable
  106. def getDrivingReg(reportError: Boolean = true): Bool.this.type
    Definition Classes
    BaseType
  107. def getInstanceCounter: Int
    Definition Classes
    ContextUser
  108. def getMode: Byte
    Attributes
    protected
    Definition Classes
    Nameable
  109. def getMuxType[T <: Data](list: TraversableOnce[T]): HardType[T]
    Definition Classes
    Data
  110. def getName(default: String): String
    Definition Classes
    NameableByComponent → Nameable
  111. def getName(): String
    Definition Classes
    NameableByComponent → Nameable
  112. def getPartialName(): String
    Definition Classes
    Nameable
  113. def getPath(from: Component, to: Component): Seq[Component]
    Definition Classes
    NameableByComponent
  114. def getRealSource: Any
    Definition Classes
    Assignable
  115. def getRealSourceNoRec: Any
    Definition Classes
    Data → Assignable
  116. def getRefOwnersChain(): List[Any]
    Definition Classes
    OwnableRef
  117. def getRootParent: Data
    Definition Classes
    Data
  118. def getRtlPath(separator: String = "/"): String
    Definition Classes
    Data
  119. def getScalaLocationLong: String
    Definition Classes
    ScalaLocated
  120. def getScalaLocationShort: String
    Definition Classes
    ScalaLocated
  121. def getScalaTrace(): Throwable
    Definition Classes
    ScalaLocated
  122. def getSingleDriver: Option[Bool.this.type]
    Definition Classes
    BaseType
  123. def getTag[T <: SpinalTag](clazz: Class[T]): Option[T]
    Definition Classes
    SpinalTagReady
  124. def getTags(): LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  125. def getTypeObject: TypeBool
    Definition Classes
    Bool → Expression
  126. def getZero: Bool.this.type

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    Bool → Data
  127. val globalData: GlobalData
    Definition Classes
    GlobalDataUser
  128. def hasAssignement: Boolean
    Definition Classes
    BaseType
  129. def hasDataAssignment: Boolean
    Definition Classes
    BaseType
  130. def hasInit: Boolean

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  131. def hasOnlyOneStatement: Boolean
    Definition Classes
    StatementDoubleLinkedContainer
  132. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean
    Definition Classes
    SpinalTagReady
  133. def hasTag(spinalTag: SpinalTag): Boolean
    Definition Classes
    SpinalTagReady
  134. def hashCode(): Int
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  135. def head: AssignmentStatement
    Definition Classes
    StatementDoubleLinkedContainer
  136. def init(value: Boolean): Bool
  137. def init(that: Bool): Bool

    Set initial value to a data

    Set initial value to a data

    Definition Classes
    DataPrimitives
  138. final def initFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    Data
  139. def initial(that: Bool): Bool
    Definition Classes
    BaseTypePrimitives
  140. def initialFrom(that: AnyRef, target: AnyRef = this): Unit
    Definition Classes
    BaseType
  141. def insertNext(s: Statement): Unit
    Definition Classes
    Statement
  142. def instanceAttributes(language: Language): Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  143. def instanceAttributes: Iterable[Attribute]
    Definition Classes
    SpinalTagReady
  144. def isAnalog: Boolean
    Definition Classes
    BaseType → Data
  145. def isComb: Boolean
    Definition Classes
    BaseType → Data
  146. def isCompletelyUnnamed: Boolean
    Definition Classes
    Nameable
  147. def isDirectionLess: Boolean
    Definition Classes
    Data
  148. def isEmptyOfTag: Boolean
    Definition Classes
    SpinalTagReady
  149. def isFrozen(): Boolean
    Definition Classes
    BaseType
  150. def isInOut: Boolean
    Definition Classes
    Data
  151. def isInput: Boolean
    Definition Classes
    Data
  152. def isInputOrInOut: Boolean
    Definition Classes
    Data
  153. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  154. def isNamed: Boolean
    Definition Classes
    NameableByComponent → Nameable
  155. def isOutput: Boolean
    Definition Classes
    Data
  156. def isOutputOrInOut: Boolean
    Definition Classes
    Data
  157. def isPriorityApplicable(namePriority: Byte): Boolean
    Definition Classes
    Nameable
  158. def isReg: Boolean
    Definition Classes
    BaseType → Data
  159. def isRegOnAssign: Boolean
    Definition Classes
    Data
  160. def isTypeNode: Boolean

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  161. def isUnknown: Bool
  162. def isUnnamed: Boolean
    Definition Classes
    Nameable
  163. def isUsingResetSignal: Boolean

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  164. def isUsingSoftResetSignal: Boolean

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  165. def isVital: Boolean

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  166. val lastScopeStatement: Statement
    Definition Classes
    Statement
  167. def mux[T <: SpinalEnum](t: SpinalEnumElement[T], f: SpinalEnumElement[T]): SpinalEnumCraft[T]
  168. def mux[T <: Data](t: T, f: T): T
  169. def mux[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  170. def muxDc[T2 <: Data](mappings: (Any, T2)*): T2
    Definition Classes
    BaseType
  171. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  172. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  173. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2
    Definition Classes
    BaseType
  174. val name: String
    Definition Classes
    Nameable
  175. val nameableRef: Nameable
    Attributes
    protected
    Definition Classes
    Nameable
    Annotations
    @DontName()
  176. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  177. val nextScopeStatement: Statement
    Definition Classes
    Statement
  178. def noBackendCombMerge(): Bool.this.type

    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
  179. def noCombLoopCheck(): Bool.this.type

    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
  180. def normalizeInputs: Unit
    Definition Classes
    BaseType → ExpressionContainer
  181. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  182. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  183. def onEachAttributes(doIt: (Attribute) => Unit): Unit
    Definition Classes
    SpinalTagReady
  184. def opName: String
    Definition Classes
    Bool → Expression
  185. def overrideLocalName(name: String): Bool.this.type
    Definition Classes
    Nameable
  186. val parent: Data
    Definition Classes
    Data
  187. val parentScope: ScopeStatement
    Definition Classes
    ContextUser
  188. def pull(propagateName: Boolean): Bool.this.type
    Definition Classes
    Data
  189. def pull(): Bool.this.type

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

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

    Definition Classes
    Data
  190. def purify(): Bool.this.type
    Definition Classes
    Data
  191. def randBoot(u: Unit): Bool.this.type

    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
  192. val refOwner: RefOwnerType
    Definition Classes
    OwnableRef
    Annotations
    @DontName()
  193. def reflectNames(): Unit
    Definition Classes
    Nameable
  194. def remapClockDomain(func: (ClockDomain) => ClockDomain): Unit
    Definition Classes
    BaseType → Statement
  195. def remapDrivingExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    ExpressionContainer
  196. def remapExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    DeclarationStatement → ExpressionContainer
  197. def removeAssignments(data: Boolean = true, init: Boolean = true, initial: Boolean = true): Bool.this.type

    Remove all assignments of the base type

    Remove all assignments of the base type

    Definition Classes
    BaseType → Data
  198. def removeDataAssignments(): Bool.this.type
    Definition Classes
    Data
  199. def removeInitAssignments(): Bool.this.type
    Definition Classes
    Data
  200. def removeStatement(): Unit
    Definition Classes
    BaseType → Statement
  201. def removeStatementFromScope(): Unit
    Definition Classes
    Statement
  202. def removeTag(spinalTag: SpinalTag): Bool.this.type
    Definition Classes
    SpinalTagReady
  203. def removeTags(tags: Iterable[SpinalTag]): Bool.this.type
    Definition Classes
    SpinalTagReady
  204. def resized: Bool.this.type

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  205. def rise(): Bool

    Rising edge detection

  206. def rise(initAt: Bool): Bool

    Rising edge detection of this with an initial value

    Rising edge detection of this with an initial value

    initAt

    the initial value

    returns

    a Bool

    Example:

    1. val res = myBool.rise(False)
  207. def riseWhen(cond: Bool)(implicit loc: Location): Bool

    this is assigned to True when cond is True and the current value of this is False.

    this is assigned to True when cond is True and the current value of this is False. Useful for coding a simple boolean state machine. riseWhen() is typically paired with fallWhen() but also works together with setWhen() and clearWhen().

    cond

    a Bool condition

    returns

    this is rising when cond is True

    Example:

    1. val active = RegInit(False) riseWhen(request) fallWhen(acknowledge)
  208. def rootIF(): Interface

    root interface

    root interface

    Definition Classes
    Data
  209. def rootIFList(): List[Interface]
    Definition Classes
    Data
  210. def rootIFrec(now: Data, lastRoot: List[Interface]): List[Interface]
    Definition Classes
    Data
  211. def rootScopeStatement: ScopeStatement
    Definition Classes
    BaseType → Statement
  212. val scalaTrace: Throwable
    Definition Classes
    ScalaLocated
  213. def set(): Unit

    this is assigned to True

  214. def setAll(): Bool.this.type

    Set to True.

    Set to True.

    Direct call to set() to reduce the number of nodes in the netlist.

    Definition Classes
    Bool → Data
  215. def setAsAnalog(): Bool.this.type
    Definition Classes
    BaseType → Data
  216. def setAsComb(): Bool.this.type

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseType → Data
  217. def setAsDirectionLess(): Bool.this.type

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

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

    Definition Classes
    BaseType → Data
  218. def setAsReg(): Bool.this.type

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseType → Data
  219. def setAsTypeNode(): Bool.this.type

    Set baseType to Node

    Set baseType to Node

    Definition Classes
    BaseType
  220. def setAsVital(): Bool.this.type

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  221. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Bool.this.type
    Definition Classes
    Nameable
  222. def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): Bool.this.type
    Definition Classes
    Nameable
  223. def setCompositeName(nameable: Nameable, postfix: String): Bool.this.type
    Definition Classes
    Nameable
  224. def setCompositeName(nameable: Nameable, namePriority: Byte): Bool.this.type
    Definition Classes
    Nameable
  225. def setCompositeName(nameable: Nameable, weak: Boolean): Bool.this.type
    Definition Classes
    Nameable
  226. def setCompositeName(nameable: Nameable): Bool.this.type
    Definition Classes
    Nameable
  227. def setLambdaName(isNameBody: => Boolean)(nameGen: => String): Bool.this.type
    Definition Classes
    Nameable
  228. def setName(name: String, namePriority: Byte): Bool.this.type
    Definition Classes
    Nameable
  229. def setName(name: String, weak: Boolean): Bool.this.type
    Definition Classes
    Nameable
  230. def setName(name: String): Bool.this.type
    Definition Classes
    Nameable
  231. def setNameAsWeak(): Bool.this.type
    Definition Classes
    Nameable
  232. def setOutputAsReg(): Bool.this.type

    Recursively set baseType to reg only for output

    Recursively set baseType to reg only for output

    Definition Classes
    Data
  233. def setPartialName(name: String, namePriority: Byte, owner: Any): Bool.this.type
    Definition Classes
    Nameable
  234. def setPartialName(name: String, namePriority: Byte): Bool.this.type
    Definition Classes
    Nameable
  235. def setPartialName(name: String, weak: Boolean): Bool.this.type
    Definition Classes
    Nameable
  236. def setPartialName(owner: Nameable, name: String, namePriority: Byte): Bool.this.type
    Definition Classes
    Nameable
  237. def setPartialName(owner: Nameable, name: String, weak: Boolean): Bool.this.type
    Definition Classes
    Nameable
  238. def setPartialName(name: String): Bool.this.type
    Definition Classes
    Nameable
  239. def setPartialName(owner: Nameable, name: String): Bool.this.type
    Definition Classes
    Nameable
  240. def setPartialName(owner: Nameable): Bool.this.type
    Definition Classes
    Nameable
  241. def setRefOwner(that: Any): Unit
    Definition Classes
    OwnableRef
  242. def setScalaLocated(source: ScalaLocated): Bool.this.type
    Definition Classes
    ScalaLocated
  243. def setWeakName(name: String): Bool.this.type
    Definition Classes
    Nameable
  244. def setWhen(cond: Bool)(implicit loc: Location): Bool

    this is assigned to True when cond is True

    this is assigned to True when cond is True

    cond

    a Bool condition

    returns

    this is assigned to True when cond is True

    Example:

    1. myBool.setWhen(cond)
  245. def simplifyNode: Expression
    Definition Classes
    Expression
  246. def spinalTags: LinkedHashSet[SpinalTag]
    Definition Classes
    SpinalTagReady
  247. def stabilized(func: (Expression) => Expression, seed: Expression): Expression
    Definition Classes
    ExpressionContainer
  248. def switchAssign[T2 <: BaseType](sel: T2)(mappings: (Any, Bool)*): Unit
    Definition Classes
    DataPrimitives
  249. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  250. def toIo(): Bool.this.type
    Definition Classes
    Data
  251. def toMuxInput[T <: Data](muxOutput: T): T
    Definition Classes
    Data
  252. def toString(): String
    Definition Classes
    BaseType → Expression → Nameable → AnyRef → Any
  253. def toStringMultiLine(): String
    Definition Classes
    BaseNode
  254. def toStringRec(level: Int = 1): String
    Definition Classes
    Expression
  255. def toggleWhen(cond: Bool)(implicit loc: Location): Bool

    this is inverted when cond is True

    this is inverted when cond is True

    cond

    a Bool condition

    returns

    this is inverted when cond is True

    Example:

    1. mybool.toggleWhen(request)
  256. def unary_!: Bool

    Logical NOT

    Logical NOT

    returns

    a Bool assign with the NOT result

    Example:

    1. val result = !myBool1
  257. def unary_~: Bool

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    Bool → BitwiseOp
  258. def unfreeze(): Bool.this.type
    Definition Classes
    BaseType → Data
  259. def unsetName(): Bool.this.type
    Definition Classes
    Nameable
  260. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  261. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  262. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  263. def walkDrivingExpressions(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  264. def walkExpression(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  265. def walkExpressionPostorder(func: (Expression) => Unit): Unit
    Definition Classes
    ExpressionContainer
  266. def walkParentTreeStatements(func: (TreeStatement) => Unit): Unit
    Definition Classes
    Statement
  267. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) => Unit): Unit
    Definition Classes
    Statement
  268. def walkRemapDrivingExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    ExpressionContainer
  269. def walkRemapExpressions(func: (Expression) => Expression): Unit
    Definition Classes
    ExpressionContainer
  270. def wrapCast[T <: BaseType](result: T, node: Cast): T
    Definition Classes
    BaseType
  271. def wrapNext(): Bool.this.type
    Definition Classes
    Data
  272. def |(b: Bool): Bool

    Bitwise OR operator

    Bitwise OR operator

    Definition Classes
    Bool → BitwiseOp
  273. def ||(b: Bool): Bool

    Logical OR

    Logical OR

    returns

    a Bool assign with the OR result

    Example:

    1. val result = myBool1 || myBool2

Deprecated Value Members

  1. def asDirectionLess(): Bool.this.type
    Definition Classes
    Data
    Annotations
    @deprecated
    Deprecated

    (Since version ???) use setAsDirectionLess instead

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

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

    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 BitwiseOp[Bool]

Inherited from BaseTypePrimitives[Bool]

Inherited from DataPrimitives[Bool]

Inherited from BaseType

Inherited from Expression

Inherited from StatementDoubleLinkedContainer[BaseType, AssignmentStatement]

Inherited from DoubleLinkedContainer[BaseType, AssignmentStatement]

Inherited from DeclarationStatement

Inherited from LeafStatement

Inherited from Statement

Inherited from BaseNode

Inherited from ExpressionContainer

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