Aggregate

Abstract Value Members

abstract def cloneType: Aggregate.this.type

cloneType must be defined for any Chisel object extending Data.
cloneType must be defined for any Chisel object extending Data. It is responsible for constructing a basic copy of the object being cloned. If cloneType needs to recursively clone elements of an object, it should call the cloneType methods on those elements.
returns
a copy of the object.

Definition Classes
Data
abstract def getElements: Seq[Data]

Returns a Seq of the immediate contents of this Aggregate, in order.
abstract def toPrintable: Printable

Default pretty printing
Default pretty printing

Definition Classes
Data

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def :=(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

Definition Classes
Data
final def <>(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
macro def asTypeOf[T <: Data](that: T): T

Does a reinterpret cast of the bits in this node into the format that provides.
Does a reinterpret cast of the bits in this node into the format that provides. Returns a new Wire of that type. Does not modify existing nodes.
x.asTypeOf(that) performs the inverse operation of x = that.toBits.

Definition Classes
Data
Note
that should have known widths
,
bit widths are NOT checked, may pad or drop bits from input
final macro def asUInt(): UInt

Reinterpret cast to UInt.
Reinterpret cast to UInt.

Definition Classes
Data
Note
Aggregates are recursively packed with the first element appearing in the least-significant bits of the result.
,
value not guaranteed to be preserved: for example, a SInt of width 3 and value -1 (0b111) would become an UInt with value 7
def chiselCloneType(implicit compileOptions: CompileOptions): Aggregate.this.type

chiselCloneType is called at the top-level of a clone chain.
chiselCloneType is called at the top-level of a clone chain. It calls the client's cloneType() method to construct a basic copy of the object being cloned, then performs any fixups required to reconstruct the appropriate core state of the cloned object.
returns
a copy of the object with appropriate core state.

Definition Classes
Data
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

Definition Classes
Data
def do_asUInt(implicit sourceInfo: SourceInfo): UInt

Definition Classes
Aggregate → Data
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(that: Any): Boolean

Definition Classes
HasId → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def fromBits(that: Bits)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Aggregate.this.type

Creates an new instance of this type, unpacking the input Bits into structured data.
Creates an new instance of this type, unpacking the input Bits into structured data.
This performs the inverse operation of toBits.

Definition Classes
Data
Note
what fromBits assigs to must have known widths
,
does NOT check bit widths, may drop bits during assignment
,
does NOT assign to the object this is called on, instead creates and returns a NEW object (useful in a clone-and-assign scenario)
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getWidth: Int

Returns the width, in bits, if currently known.
Returns the width, in bits, if currently known.

Definition Classes
Data
Exceptions thrown
java.util.NoSuchElementException if the width is not known.
def hashCode(): Int

Definition Classes
HasId → AnyRef → Any
def instanceName: String

Definition Classes
HasId → InstanceId
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isLit(): Boolean

Definition Classes
Data
final def isWidthKnown: Boolean

Returns whether the width is currently known.
Returns whether the width is currently known.

Definition Classes
Data
def litArg(): Option[LitArg]

Definition Classes
Data
def litValue(): BigInt

Definition Classes
Data
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parentModName: String

Definition Classes
HasId → InstanceId
def parentPathName: String

Definition Classes
HasId → InstanceId
def pathName: String

Definition Classes
HasId → InstanceId
def suggestName(name: ⇒ String): Aggregate.this.type

Definition Classes
HasId
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )
final def widthOption: Option[Int]

Returns Some(width) if the width is known, else None.
Returns Some(width) if the width is known, else None.

Definition Classes
Data

Deprecated Value Members

def toBits(): UInt

Packs the value of this object as plain Bits.
Packs the value of this object as plain Bits.
This performs the inverse operation of fromBits(Bits).

Definition Classes
Data
Annotations
@deprecated
Deprecated
(Since version chisel3) Best alternative, .asUInt()

Related Doc: package core

sealed abstract class Aggregate extends Data

Abstract Value Members

abstract def cloneType: Aggregate.this.type

abstract def getElements: Seq[Data]

abstract def toPrintable: Printable

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def :=(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

final def <>(that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

macro def asTypeOf[T <: Data](that: T): T

final macro def asUInt(): UInt

def chiselCloneType(implicit compileOptions: CompileOptions): Aggregate.this.type

def clone(): AnyRef

def do_asTypeOf[T <: Data](that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T

def do_asUInt(implicit sourceInfo: SourceInfo): UInt

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def finalize(): Unit

def fromBits(that: Bits)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Aggregate.this.type

final def getClass(): Class[_]

final def getWidth: Int

def hashCode(): Int

def instanceName: String

final def isInstanceOf[T0]: Boolean

def isLit(): Boolean

final def isWidthKnown: Boolean

def litArg(): Option[LitArg]

def litValue(): BigInt

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parentModName: String

def parentPathName: String

def pathName: String

def suggestName(name: ⇒ String): Aggregate.this.type

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def widthOption: Option[Int]

Deprecated Value Members

def toBits(): UInt

Inherited from Data

Inherited from HasId

Inherited from InstanceId

Inherited from AnyRef

Inherited from Any

Ungrouped