Class

spinal.core

Bool

Related Doc: package core

Permalink

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

The Bool type corresponds to a boolean value (True or False)

Example:
  1. val myBool = Bool()
    myBool := False
    myBool := Bool(false)
See also

Bool Documentation

Linear Supertypes
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. All

Instance Constructors

  1. new Bool()

    Permalink

Type Members

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

    Permalink

    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

    Permalink

    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

    Permalink
    Definition Classes
    OwnableRef

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 &(b: Bool): Bool

    Permalink

    Logical AND operator

    Logical AND operator

    Definition Classes
    BoolBitwiseOp
  5. def &&(b: Bool): Bool

    Permalink

    Logical AND

    Logical AND

    returns

    a Bool assign with the AND result

    Example:
    1. val result = myBool1 && myBool2
  6. def :=(that: Bool): Unit

    Permalink

    Assign a data to this

    Assign a data to this

    Definition Classes
    DataPrimitives
  7. def <>(that: Bool): Unit

    Permalink

    Auto connection between two data

    Auto connection between two data

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

    Permalink

    BitVector is not equal to MaskedLiteral

  9. def =/=(that: Bool): Bool

    Permalink
    Definition Classes
    DataPrimitives
  10. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def ===(that: MaskedBoolean): Bool

    Permalink
  12. def ===(that: Bool): Bool

    Permalink

    Comparison between two data

    Comparison between two data

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

    Permalink

    Conditional operation for Enumeration value

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

    Permalink

    Conditional operation for Data value

  15. def \(that: Bool): Bool

    Permalink

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

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

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

    Permalink

    Logical XOR operator

    Logical XOR operator

    Definition Classes
    BoolBitwiseOp
  17. var _spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  18. def addAttribute(attribute: Attribute): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeDataSpinalTagReady
  19. def addAttribute(name: String, value: Int): Bool.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  21. def addAttribute(name: String): Bool.this.type

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  24. var algoIncrementale: Int

    Permalink
    Definition Classes
    BaseNode
  25. var algoInt: Int

    Permalink
    Definition Classes
    BaseNode
  26. def allowDirectionLessIo: Bool.this.type

    Permalink
    Definition Classes
    Data
  27. def allowOverride: Bool.this.type

    Permalink

    Allow a data to be overrided

    Allow a data to be overrided

    Definition Classes
    Data
  28. def allowPartialyAssigned: Bool.this.type

    Permalink
    Definition Classes
    Data
  29. def allowPruning(): Bool.this.type

    Permalink
    Definition Classes
    Data
  30. def allowSimplifyIt(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  31. def allowUnsetRegToAvoidLatch: Bool.this.type

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

    Permalink
    Definition Classes
    Data
  33. def asBits: Bits

    Permalink

    Cast data to Bits

    Cast data to Bits

    Definition Classes
    BoolData
  34. def asBits(bitCount: BitCount): Bits

    Permalink

    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

  35. def asData: Data

    Permalink
    Definition Classes
    Data
  36. def asInOut(): Bool.this.type

    Permalink

    set a data as inout

    set a data as inout

    Definition Classes
    BaseTypeData
  37. def asInput(): Bool.this.type

    Permalink

    Set a data as input

    Set a data as input

    Definition Classes
    BaseTypeData
  38. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  39. def asOutput(): Bool.this.type

    Permalink

    Set a data as output

    Set a data as output

    Definition Classes
    BaseTypeData
  40. def asSInt(bitCount: BitCount): SInt

    Permalink
  41. def asSInt: SInt

    Permalink

    Cast a Bool to an SInt

    Cast a Bool to an SInt

    returns

    a SInt data

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

    Permalink

    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)
  43. def asUInt: UInt

    Permalink

    Cast a Bool to an UInt

    Cast a Bool to an UInt

    returns

    an UInt data

    Example:
    1. myUInt := myBool.asUInt
  44. def assignDontCare(): Bool.this.type

    Permalink
    Definition Classes
    BoolData
  45. def assignFormalRandom(kind: RandomExpKind): Unit

    Permalink
    Definition Classes
    BoolData
  46. final def assignFrom(that: AnyRef, target: AnyRef = this): Unit

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

    Permalink
    Definition Classes
    BoolData
  48. def assignFromBits(bits: Bits): Unit

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

    Permalink
    Definition Classes
    Data
  50. def cldCount: Int

    Permalink
    Definition Classes
    DoubleLinkedContainer
  51. def clear(): Unit

    Permalink

    this is assigned to False

  52. def clearWhen(cond: Bool)(implicit loc: Location): Bool

    Permalink

    this is assigned to False when cond is True

  53. var clockDomain: ClockDomain

    Permalink
    Definition Classes
    BaseType
  54. def clone(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData → AnyRef
  55. def component: Component

    Permalink
    Definition Classes
    ContextUser
  56. final def compositAssignFrom(that: AnyRef, target: AnyRef, kind: AnyRef): Unit

    Permalink
    Definition Classes
    Assignable
  57. var compositeAssign: Assignable

    Permalink
    Definition Classes
    Assignable
  58. def copyDirectionOf(that: Bool): Unit

    Permalink
    Definition Classes
    DataPrimitives
  59. def copyDirectionOfImpl(that: Data): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  60. def default(that: ⇒ Bool): Bool

    Permalink

    Set a default value to a data

    Set a default value to a data

    Definition Classes
    DataPrimitives
  61. def dirString(): String

    Permalink
    Definition Classes
    Data
  62. def dlcAppend(that: AssignmentStatement): Bool.this.type

    Permalink
    Definition Classes
    DoubleLinkedContainer
  63. def dlcForeach[T >: AssignmentStatement](func: (T) ⇒ Unit): Unit

    Permalink
    Definition Classes
    DoubleLinkedContainer
  64. def dlcHasOnlyOne: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  65. var dlcHead: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  66. def dlcIsEmpty: Boolean

    Permalink
    Definition Classes
    DoubleLinkedContainer
  67. var dlcLast: AssignmentStatement

    Permalink
    Definition Classes
    DoubleLinkedContainer
  68. def dlcPrepend(that: AssignmentStatement): Bool.this.type

    Permalink
    Definition Classes
    DoubleLinkedContainer
  69. def dontSimplifyIt(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  70. def edge(): Bool

    Permalink

    Edge detection

  71. def edge(initAt: Bool): Bool

    Permalink

    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)
  72. def edges(): BoolEdges

    Permalink

    Edge detection without intial value

  73. def edges(initAt: Bool): BoolEdges

    Permalink

    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){...}
  74. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  77. def fall(): Bool

    Permalink

    Falling edge detection

  78. def fall(initAt: Bool): Bool

    Permalink

    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)
  79. def fallWhen(cond: Bool)(implicit loc: Location): Bool

    Permalink

    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()

  80. def filterTag(cond: (SpinalTag) ⇒ Boolean): Iterable[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  81. def findTag(cond: (SpinalTag) ⇒ Boolean): Option[SpinalTag]

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

    Permalink
    Definition Classes
    BaseTypeData
  83. def flattenForeach(body: (BaseType) ⇒ Unit): Unit

    Permalink
    Definition Classes
    BaseTypeData
  84. def flattenLocalName: Seq[String]

    Permalink
    Definition Classes
    BaseTypeData
  85. def flip(): Bool.this.type

    Permalink

    flip the direction of the data

    flip the direction of the data

    Definition Classes
    Data
  86. def foreachClockDomain(func: (ClockDomain) ⇒ Unit): Unit

    Permalink
    Definition Classes
    BaseTypeStatement
  87. def foreachDrivingExpression(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  88. def foreachExpression(func: (Expression) ⇒ Unit): Unit

    Permalink
  89. def foreachReflectableNameables(doThat: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Nameable
  90. def foreachStatements(func: (AssignmentStatement) ⇒ Unit): Unit

    Permalink
  91. def foreachTag(body: (SpinalTag) ⇒ Unit): Unit

    Permalink
    Definition Classes
    SpinalTagReady
  92. def freeze(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  93. def genIf(cond: Boolean): Bool.this.type

    Permalink

    Generate this if condition is true

    Generate this if condition is true

    Definition Classes
    Data
  94. def getAheadValue(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  95. def getBitsWidth: Int

    Permalink

    Return the width of the data

    Return the width of the data

    Definition Classes
    BoolData
  96. final def getClass(): Class[_]

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

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

    Permalink

    Get current component with all parents

    Get current component with all parents

    Definition Classes
    InComponent
  99. def getDirection: IODirection

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

    Permalink
    Definition Classes
    Nameable
  101. def getDrivingReg: Bool.this.type

    Permalink
    Definition Classes
    BaseType
  102. def getInstanceCounter: Int

    Permalink
    Definition Classes
    ContextUser
  103. def getMode: Byte

    Permalink
    Attributes
    protected
    Definition Classes
    Nameable
  104. def getName(default: String): String

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

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

    Permalink
    Definition Classes
    Nameable
  107. def getRealSource: Any

    Permalink
    Definition Classes
    Assignable
  108. def getRealSourceNoRec: Any

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

    Permalink
    Definition Classes
    OwnableRef
  110. def getRootParent: Data

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

    Permalink
    Definition Classes
    Data
  112. def getScalaLocationLong: String

    Permalink
    Definition Classes
    ScalaLocated
  113. def getScalaLocationShort: String

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

    Permalink
    Definition Classes
    ScalaLocated
  115. def getSingleDriver: Option[Bool.this.type]

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  118. def getTypeObject: TypeBool.type

    Permalink
    Definition Classes
    BoolExpression
  119. def getZero: Bool.this.type

    Permalink

    Create a data set to 0

    Create a data set to 0

    Definition Classes
    BoolData
  120. val globalData: GlobalData

    Permalink
    Definition Classes
    GlobalDataUser
  121. def hasAssignement: Boolean

    Permalink
    Definition Classes
    BaseType
  122. def hasDataAssignment: Boolean

    Permalink
    Definition Classes
    BaseType
  123. def hasInit: Boolean

    Permalink

    Does the base type have initial value

    Does the base type have initial value

    Definition Classes
    BaseType
  124. def hasOnlyOneStatement: Boolean

    Permalink
  125. def hasTag[T <: SpinalTag](clazz: Class[T]): Boolean

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

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

    Permalink
    Definition Classes
    OverridedEqualsHashCode → AnyRef → Any
  128. def head: AssignmentStatement

    Permalink
  129. def init(value: Boolean): Bool

    Permalink
  130. def init(that: Bool): Bool

    Permalink

    Set initial value to a data

    Set initial value to a data

    Definition Classes
    DataPrimitives
  131. final def initFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    Data
  132. def initial(that: Bool): Bool

    Permalink
    Definition Classes
    BaseTypePrimitives
  133. def initialFrom(that: AnyRef, target: AnyRef = this): Unit

    Permalink
    Definition Classes
    BaseType
  134. def insertNext(s: Statement): Unit

    Permalink
    Definition Classes
    Statement
  135. def instanceAttributes(language: Language): Iterable[Attribute]

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

    Permalink
    Definition Classes
    SpinalTagReady
  137. def isAnalog: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  138. def isComb: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  139. def isCompletelyUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  140. def isDirectionLess: Boolean

    Permalink
    Definition Classes
    Data
  141. def isEmptyOfTag: Boolean

    Permalink
    Definition Classes
    SpinalTagReady
  142. def isFrozen(): Boolean

    Permalink
    Definition Classes
    BaseType
  143. def isInOut: Boolean

    Permalink
    Definition Classes
    Data
  144. def isInput: Boolean

    Permalink
    Definition Classes
    Data
  145. def isInputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Any
  147. def isNamed: Boolean

    Permalink
    Definition Classes
    NameableByComponentNameable
  148. def isOutput: Boolean

    Permalink
    Definition Classes
    Data
  149. def isOutputOrInOut: Boolean

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

    Permalink
    Definition Classes
    Nameable
  151. def isReg: Boolean

    Permalink
    Definition Classes
    BaseTypeData
  152. def isTypeNode: Boolean

    Permalink

    Is the baseType a node

    Is the baseType a node

    Definition Classes
    BaseType
  153. def isUnnamed: Boolean

    Permalink
    Definition Classes
    Nameable
  154. def isUsingResetSignal: Boolean

    Permalink

    Is the basetype using reset signal

    Is the basetype using reset signal

    Definition Classes
    BaseType
  155. def isUsingSoftResetSignal: Boolean

    Permalink

    Is the basetype using soft reset signal

    Is the basetype using soft reset signal

    Definition Classes
    BaseType
  156. def isVital: Boolean

    Permalink

    Check if the baseType is vital

    Check if the baseType is vital

    Definition Classes
    BaseType
  157. var lastScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  158. def mux[T2 <: Data](mappings: (Any, T2)*): T2

    Permalink
    Definition Classes
    BaseType
  159. def muxList[T2 <: Data](defaultValue: T2, mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  160. def muxList[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  161. def muxListDc[T2 <: Data](mappings: Seq[(Any, T2)]): T2

    Permalink
    Definition Classes
    BaseType
  162. var name: String

    Permalink
    Definition Classes
    Nameable
  163. var nameableRef: Nameable

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

    Permalink
    Definition Classes
    AnyRef
  165. var nextScopeStatement: Statement

    Permalink
    Definition Classes
    Statement
  166. def noBackendCombMerge: Bool.this.type

    Permalink
    Definition Classes
    Data
  167. def noCombLoopCheck: Bool.this.type

    Permalink
    Definition Classes
    Data
  168. def normalizeInputs: Unit

    Permalink
    Definition Classes
    BaseTypeExpressionContainer
  169. final def notify(): Unit

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

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

    Permalink
    Definition Classes
    SpinalTagReady
  172. def opName: String

    Permalink
    Definition Classes
    BoolExpression
  173. def overrideLocalName(name: String): Bool.this.type

    Permalink
    Definition Classes
    Nameable
  174. var parent: Data

    Permalink
    Definition Classes
    Data
  175. var parentScope: ScopeStatement

    Permalink
    Definition Classes
    ContextUser
  176. def pull(propagateName: Boolean): Bool.this.type

    Permalink
    Definition Classes
    Data
  177. def pull(): Bool.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
  178. def purify(): Bool.this.type

    Permalink
    Definition Classes
    Data
  179. def randBoot(u: Unit): Bool.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
  180. var refOwner: RefOwnerType

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

    Permalink
    Definition Classes
    Nameable
  182. def remapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  183. def remapExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
  184. def removeAssignments(): Bool.this.type

    Permalink

    Remove all assignments of the base type

    Remove all assignments of the base type

    Definition Classes
    BaseTypeData
  185. def removeStatement(): Unit

    Permalink
    Definition Classes
    BaseTypeStatement
  186. def removeStatementFromScope(): Unit

    Permalink
    Definition Classes
    Statement
  187. def removeTag(spinalTag: SpinalTag): Bool.this.type

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

    Permalink
    Definition Classes
    SpinalTagReady
  189. def resized: Bool.this.type

    Permalink

    Resized data regarding target

    Resized data regarding target

    Definition Classes
    Data
  190. def rise(): Bool

    Permalink

    Rising edge detection

  191. def rise(initAt: Bool): Bool

    Permalink

    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)
  192. def riseWhen(cond: Bool)(implicit loc: Location): Bool

    Permalink

    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)
  193. def rootScopeStatement: ScopeStatement

    Permalink
    Definition Classes
    BaseTypeStatement
  194. var scalaTrace: Throwable

    Permalink
    Definition Classes
    ScalaLocated
  195. def set(): Unit

    Permalink

    this is assigned to True

  196. def setAsAnalog(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  197. def setAsComb(): Bool.this.type

    Permalink

    Set baseType to Combinatorial

    Set baseType to Combinatorial

    Definition Classes
    BaseTypeData
  198. def setAsDirectionLess(): Bool.this.type

    Permalink

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

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

    Definition Classes
    BaseTypeData
  199. def setAsReg(): Bool.this.type

    Permalink

    Set baseType to reg

    Set baseType to reg

    Definition Classes
    BaseTypeData
  200. def setAsTypeNode(): Bool.this.type

    Permalink

    Set baseType to Node

    Set baseType to Node

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

    Permalink

    Set the baseType to vital

    Set the baseType to vital

    Definition Classes
    BaseType
  202. def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): Bool.this.type

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  207. def setCompositeName(nameable: Nameable): Bool.this.type

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

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

    Permalink
    Definition Classes
    Nameable
  210. def setName(name: String): Bool.this.type

    Permalink
    Definition Classes
    Nameable
  211. def setNameAsWeak(): Bool.this.type

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

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

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

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

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

    Permalink
    Definition Classes
    Nameable
  217. def setPartialName(name: String): Bool.this.type

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

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

    Permalink
    Definition Classes
    OwnableRef
  220. def setScalaLocated(source: ScalaLocated): Bool.this.type

    Permalink
    Definition Classes
    ScalaLocated
  221. def setWeakName(name: String): Bool.this.type

    Permalink
    Definition Classes
    Nameable
  222. def setWhen(cond: Bool)(implicit loc: Location): Bool

    Permalink

    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)
  223. def simplifyNode: Expression

    Permalink
    Definition Classes
    Expression
  224. def spinalTags: LinkedHashSet[SpinalTag]

    Permalink
    Definition Classes
    SpinalTagReady
  225. def stabilized(func: (Expression) ⇒ Expression, seed: Expression): Expression

    Permalink
    Definition Classes
    ExpressionContainer
  226. def swichAssign[T2 <: BaseType](sel: T2)(mappings: (Any, Bool)*): Unit

    Permalink
    Definition Classes
    DataPrimitives
  227. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  228. def toIo(): Bool.this.type

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

    Permalink
    Definition Classes
    BaseTypeExpressionNameable → AnyRef → Any
  230. def toStringMultiLine(): String

    Permalink
    Definition Classes
    BaseNode
  231. def toStringRec(level: Int = 1): String

    Permalink
    Definition Classes
    Expression
  232. def toggleWhen(cond: Bool)(implicit loc: Location): Bool

    Permalink

    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)
  233. def unary_!: Bool

    Permalink

    Logical NOT

    Logical NOT

    returns

    a Bool assign with the NOT result

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

    Permalink

    Inverse bitwise operator

    Inverse bitwise operator

    Definition Classes
    BoolBitwiseOp
  235. def unfreeze(): Bool.this.type

    Permalink
    Definition Classes
    BaseTypeData
  236. def unsetName(): Bool.this.type

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  240. def walkDrivingExpressions(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  241. def walkExpression(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  242. def walkExpressionPostorder(func: (Expression) ⇒ Unit): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  243. def walkParentTreeStatements(func: (TreeStatement) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Statement
  244. def walkParentTreeStatementsUntilRootScope(func: (TreeStatement) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Statement
  245. def walkRemapDrivingExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  246. def walkRemapExpressions(func: (Expression) ⇒ Expression): Unit

    Permalink
    Definition Classes
    ExpressionContainer
  247. def wrapCast[T <: BaseType](result: T, node: Cast): T

    Permalink
    Definition Classes
    BaseType
  248. def wrapNext(): Bool.this.type

    Permalink
    Definition Classes
    Data
  249. def |(b: Bool): Bool

    Permalink

    Logical OR operator

    Logical OR operator

    Definition Classes
    BoolBitwiseOp
  250. def ||(b: Bool): Bool

    Permalink

    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

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

Inherited from BaseTypePrimitives[Bool]

Inherited from DataPrimitives[Bool]

Inherited from BaseType

Inherited from Expression

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