class SpinalEnum extends Nameable with ScalaLocated
Base class for creating enumeration
object MyEnum extends SpinalEnum(binarySequential){ val s1, s2, s3, s4 = newElement() }
SpinalEnum contains a list of SpinalEnumElement that is the definition of an element. SpinalEnumCraft is the hardware representation of the the element.
- See also
Example:
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- SpinalEnum
- Nameable
- ContextUser
- ScalaLocated
- GlobalDataUser
- OwnableRef
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new SpinalEnum(defaultEncoding: SpinalEnumEncoding = native)
- defaultEncoding
encoding of the senum
Type Members
- type C = SpinalEnumCraft[SpinalEnum.this.type]
- type E = SpinalEnumElement[SpinalEnum.this.type]
- abstract type RefOwnerType
- Definition Classes
- OwnableRef
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply(encoding: SpinalEnumEncoding): SpinalEnumCraft[SpinalEnum.this.type]
- def apply(): SpinalEnumCraft[SpinalEnum.this.type]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def component: Component
- Definition Classes
- ContextUser
- def craft(enumEncoding: SpinalEnumEncoding): SpinalEnumCraft[SpinalEnum.this.type]
- def craft(): SpinalEnumCraft[SpinalEnum.this.type]
- var defaultEncoding: SpinalEnumEncoding
- val elements: ArrayBuffer[SpinalEnumElement[SpinalEnum.this.type]]
Contains all elements of the enumeration
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def foreachReflectableNameables(doThat: (Any) => Unit): Unit
- Definition Classes
- Nameable
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getDisplayName(): String
- Definition Classes
- Nameable
- def getInstanceCounter: Int
- Definition Classes
- ContextUser
- def getMode: Byte
- Attributes
- protected
- Definition Classes
- Nameable
- def getName(default: String): String
- Definition Classes
- Nameable
- def getName(): String
- Definition Classes
- Nameable
- def getPartialName(): String
- Definition Classes
- Nameable
- def getRefOwnersChain(): List[Any]
- Definition Classes
- OwnableRef
- def getScalaLocationLong: String
- Definition Classes
- ScalaLocated
- def getScalaLocationShort: String
- Definition Classes
- ScalaLocated
- def getScalaTrace(): Throwable
- Definition Classes
- ScalaLocated
- val globalData: GlobalData
- Definition Classes
- GlobalDataUser
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def isCompletelyUnnamed: Boolean
- Definition Classes
- Nameable
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isNamed: Boolean
- Definition Classes
- Nameable
- def isPriorityApplicable(namePriority: Byte): Boolean
- Definition Classes
- Nameable
- def isUnnamed: Boolean
- Definition Classes
- Nameable
- val name: String
- Definition Classes
- Nameable
- val nameableRef: Nameable
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newElement(name: String): SpinalEnumElement[SpinalEnum.this.type]
- def newElement(): SpinalEnumElement[SpinalEnum.this.type]
Create a new Element
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def overrideLocalName(name: String): SpinalEnum.this.type
- Definition Classes
- Nameable
- val parentScope: ScopeStatement
- Definition Classes
- ContextUser
- def rawElementName(): Unit
- val refOwner: RefOwnerType
- Definition Classes
- OwnableRef
- Annotations
- @DontName()
- def reflectNames(): Unit
- Definition Classes
- Nameable
- val scalaTrace: Throwable
- Definition Classes
- ScalaLocated
- def setCompositeName(nameable: Nameable, postfix: String, namePriority: Byte): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, postfix: String, weak: Boolean): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, postfix: String): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, namePriority: Byte): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable, weak: Boolean): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setCompositeName(nameable: Nameable): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setGlobal(): Unit
- def setLocal(): Unit
- def setName(name: String, namePriority: Byte): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setName(name: String, weak: Boolean): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setName(name: String): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setNameAsWeak(): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String, namePriority: Byte, owner: Any): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String, namePriority: Byte): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String, weak: Boolean): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable, name: String, namePriority: Byte): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable, name: String, weak: Boolean): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setPartialName(name: String): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setPartialName(owner: Nameable, name: String): SpinalEnum.this.type
- Definition Classes
- Nameable
- def setRefOwner(that: Any): Unit
- Definition Classes
- OwnableRef
- def setScalaLocated(source: ScalaLocated): SpinalEnum.this.type
- Definition Classes
- ScalaLocated
- def setWeakName(name: String): SpinalEnum.this.type
- Definition Classes
- Nameable
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- Nameable → AnyRef → Any
- def unsetName(): SpinalEnum.this.type
- Definition Classes
- Nameable
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated