SubmodulePathT | gateware-ts

Type representing a path into a signal deeply nested in submodules. Only available in simulation. Error prone because it relies on string, and therefore cannot perform any type checking. Should not be instantiated directly, instead use SubmodulePath.

Hierarchy

BaseSignalLike
- SubmodulePathT

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SubmodulePathT(path: string): SubmodulePathT

- Defined in signals.ts:968
Parameters
- path: string
Returns SubmodulePathT

Properties

path

path: string

type

type: string = SUBMODULE_PATH_EXPRESSION

width

width: number

Methods

!=

!=(b: SignalLikeOrValue): ComparrisonT

Inherited from BaseSignalLike.!=
- Defined in signals.ts:358
Alias of BaseSignalLike.neq

Parameters
- b: SignalLikeOrValue
Returns ComparrisonT

&

&(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.&
- Defined in signals.ts:281
Alias of BaseSignalLike.and

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

&&

&&(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.&&
- Defined in signals.ts:288
Alias of [[BaseSignalLike.logicalAnd]]

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

+

+(b: SignalLikeOrValue): BinaryT

Inherited from BaseSignalLike.+
- Defined in signals.ts:267
Alias of BaseSignalLike.plus

Parameters
- b: SignalLikeOrValue
Returns BinaryT

++

++(signals: SignalLike[]): ConcatT

Inherited from BaseSignalLike.++
- Defined in signals.ts:344
Alias of BaseSignalLike.concat

Parameters
- signals: SignalLike[]
Returns ConcatT

-

-(b: SignalLikeOrValue): BinaryT

Inherited from BaseSignalLike.-
- Defined in signals.ts:274
Alias of BaseSignalLike.minus

Parameters
- b: SignalLikeOrValue
Returns BinaryT

<

<(b: SignalLikeOrValue): ComparrisonT

Inherited from BaseSignalLike.<
- Defined in signals.ts:365
Alias of BaseSignalLike.lt

Parameters
- b: SignalLikeOrValue
Returns ComparrisonT

<<

<<(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.<<
- Defined in signals.ts:330
Alias of BaseSignalLike.shiftLeft

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

<<<

<<<(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.<<<
- Defined in signals.ts:316
Alias of BaseSignalLike.shiftLeftA

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

<=

<=(b: SignalLikeOrValue): ComparrisonT

Inherited from BaseSignalLike.<=
- Defined in signals.ts:379
Alias of BaseSignalLike.lte

Parameters
- b: SignalLikeOrValue
Returns ComparrisonT

=

=(s: SignalLikeOrValue): SimulationAssignmentStatement

- Defined in signals.ts:966
Alias for SubmodulePathT.setTo

Parameters
- s: SignalLikeOrValue
Returns SimulationAssignmentStatement

==

==(b: SignalLikeOrValue): ComparrisonT

Inherited from BaseSignalLike.==
- Defined in signals.ts:351
Alias of BaseSignalLike.eq

Parameters
- b: SignalLikeOrValue
Returns ComparrisonT

>

>(b: SignalLikeOrValue): ComparrisonT

Inherited from BaseSignalLike.>
- Defined in signals.ts:372
Alias of BaseSignalLike.gt

Parameters
- b: SignalLikeOrValue
Returns ComparrisonT

>=

>=(b: SignalLikeOrValue): ComparrisonT

Inherited from BaseSignalLike.>=
- Defined in signals.ts:386
Alias of BaseSignalLike.gte

Parameters
- b: SignalLikeOrValue
Returns ComparrisonT

>>

>>(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.>>
- Defined in signals.ts:337
Alias of BaseSignalLike.shiftRight

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

>>>

>>>(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.>>>
- Defined in signals.ts:323
Alias of BaseSignalLike.shiftRightA

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

?

?(a: SignalLikeOrValue, b: SignalLikeOrValue): TernaryT

Inherited from BaseSignalLike.?
- Defined in signals.ts:393
Alias of BaseSignalLike.ternary

Parameters
- a: SignalLikeOrValue
- b: SignalLikeOrValue
Returns TernaryT

^

^(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.^
- Defined in signals.ts:309
Alias of BaseSignalLike.xor

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

and

and(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.and
- Defined in signals.ts:179
Bitwise and of this signal and another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

andLogical

andLogical(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.andLogical
- Defined in signals.ts:187
Logical and of this signal and another SignalLikeOrValue (produces a 1-bit wide signal)

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

asSigned

asSigned(): ExplicitSignednessT

Inherited from BaseSignalLike.asSigned
- Defined in signals.ts:52
Treat this signal as signed

Returns ExplicitSignednessT

asUnsigned

asUnsigned(): ExplicitSignednessT

Inherited from BaseSignalLike.asUnsigned
- Defined in signals.ts:59
Treat this signal as unsigned

Returns ExplicitSignednessT

bit

bit(index: number): SliceT

Inherited from BaseSignalLike.bit
- Defined in signals.ts:251
Isolate a single bit from this signal

Parameters
- index: number
  
  the index to isolate
Returns SliceT

concat

concat(signals: SignalLike[]): ConcatT

Inherited from BaseSignalLike.concat
- Defined in signals.ts:107
Concat one or more SignalLikes with this signal

Parameters
- signals: SignalLike[]
  
  All the SignalLikes that should be concatenated
Returns ConcatT

eq

eq(b: SignalLikeOrValue): ComparrisonT

Inherited from BaseSignalLike.eq
- Defined in signals.ts:115
Compare if this signal is equal to another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns ComparrisonT

gt

gt(b: SignalLikeOrValue): ComparrisonT

Inherited from BaseSignalLike.gt
- Defined in signals.ts:131
Compare if this signal is greater than another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns ComparrisonT

gte

gte(b: SignalLikeOrValue): ComparrisonT

Inherited from BaseSignalLike.gte
- Defined in signals.ts:147
Compare if this signal is greater than or equal to another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns ComparrisonT

isEqual

isEqual(s: BaseSignalLike): boolean

Overrides BaseSignalLike.isEqual
- Defined in signals.ts:943
Compare two SignalLikes

Parameters
- s: BaseSignalLike
  
  Signal to compare with
Returns boolean

lt

lt(b: SignalLikeOrValue): ComparrisonT

Inherited from BaseSignalLike.lt
- Defined in signals.ts:123
Compare if this signal is less than another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns ComparrisonT

lte

lte(b: SignalLikeOrValue): ComparrisonT

Inherited from BaseSignalLike.lte
- Defined in signals.ts:139
Compare if this signal is less than or equal to another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns ComparrisonT

minus

minus(b: SignalLikeOrValue): BinaryT

Inherited from BaseSignalLike.minus
- Defined in signals.ts:171
Describe subtracting this signal from another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns BinaryT

neq

neq(b: SignalLikeOrValue): ComparrisonT

Inherited from BaseSignalLike.neq
- Defined in signals.ts:155
Compare if this signal is not equal to another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns ComparrisonT

or

or(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.or
- Defined in signals.ts:203
Logical or of this signal and another SignalLikeOrValue (produces a 1-bit wide signal)

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

orLogical

orLogical(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.orLogical
- Defined in signals.ts:195
Bitwise or of this signal and another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

plus

plus(b: SignalLikeOrValue): BinaryT

Inherited from BaseSignalLike.plus
- Defined in signals.ts:163
Describe adding another SignalLikeOrValue to this signal

Parameters
- b: SignalLikeOrValue
Returns BinaryT

setTo

setTo(s: SignalLikeOrValue): SimulationAssignmentStatement

- Defined in signals.ts:954
Assign the signal this path represents the value of s

Parameters
- s: SignalLikeOrValue
Returns SimulationAssignmentStatement

shiftLeft

shiftLeft(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.shiftLeft
- Defined in signals.ts:219
Bitwise left shift of this signal by another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

shiftLeftA

shiftLeftA(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.shiftLeftA
- Defined in signals.ts:235
Arithmetic left shift of this signal by another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

shiftRight

shiftRight(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.shiftRight
- Defined in signals.ts:227
Bitwise right shift of this signal by another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

shiftRightA

shiftRightA(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.shiftRightA
- Defined in signals.ts:243
Arithmetic right shift of this signal by another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

signExtend

signExtend(toWidth: number): ConcatT

Inherited from BaseSignalLike.signExtend
- Defined in signals.ts:82
Sign-extend this signal to a given bit width

Parameters
- toWidth: number
Returns ConcatT

slice

slice(fromBit: number, toBit: number): SliceT

Inherited from BaseSignalLike.slice
- Defined in signals.ts:99
Create a slice from this signal (inclusive)

Parameters
- fromBit: number
  
  the starting bit
- toBit: number
  
  the ending bit
Returns SliceT

ternary

ternary(a: SignalLikeOrValue, b: SignalLikeOrValue): TernaryT

Inherited from BaseSignalLike.ternary
- Defined in signals.ts:260
Multiplex two SignalLikes into one, using this signal to select

Parameters
- a: SignalLikeOrValue
- b: SignalLikeOrValue
Returns TernaryT

xor

xor(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.xor
- Defined in signals.ts:211
Bitwise xor of this signal and another SignalLikeOrValue

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

zeroExtend

zeroExtend(toWidth: number): ConcatT

Inherited from BaseSignalLike.zeroExtend
- Defined in signals.ts:67
Zero-extend this signal to a given bit width

Parameters
- toWidth: number
Returns ConcatT

|

|(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.|
- Defined in signals.ts:295
Alias of BaseSignalLike.or

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

||

||(b: SignalLikeOrValue): BooleanExpressionT

Inherited from BaseSignalLike.||
- Defined in signals.ts:302
Alias of [[BaseSignalLike.logicalOr]]

Parameters
- b: SignalLikeOrValue
Returns BooleanExpressionT

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

path: string

Returns SubmodulePathT

Properties

path

type

width

Methods

!=

Parameters

b: SignalLikeOrValue

Returns ComparrisonT

&

Parameters

b: SignalLikeOrValue

Returns BooleanExpressionT

&&

Parameters

b: SignalLikeOrValue

Returns BooleanExpressionT

+

Parameters

b: SignalLikeOrValue

Returns BinaryT

++

Parameters

signals: SignalLike[]

Returns ConcatT

-

Parameters

b: SignalLikeOrValue

Returns BinaryT

<

Parameters

b: SignalLikeOrValue

Returns ComparrisonT

<<

Parameters

b: SignalLikeOrValue

Returns BooleanExpressionT

<<<

Parameters

b: SignalLikeOrValue

Returns BooleanExpressionT

<=

Parameters

b: SignalLikeOrValue

Returns ComparrisonT

=

Parameters

s: SignalLikeOrValue

Returns SimulationAssignmentStatement

==

Parameters

b: SignalLikeOrValue

Returns ComparrisonT

>

Parameters

b: SignalLikeOrValue

Returns ComparrisonT

>=

Parameters

b: SignalLikeOrValue

Returns ComparrisonT

>>

Parameters

b: SignalLikeOrValue

Returns BooleanExpressionT

>>>

Parameters

b: SignalLikeOrValue

Returns BooleanExpressionT

?