Skip to content

@celox-sim/celox / index / NativeFrontendSimulatorHandle

Interface: NativeFrontendSimulatorHandle ​

Defined in: packages/celox/src/types.ts:116

Raw simulator handle returned by a frontend-owned native addon.

Extends ​

  • FrontendSimulatorHandleMetadata

Properties ​

combWasmBytes? ​

optional combWasmBytes?: undefined

Defined in: packages/celox/src/types.ts:134


eventsJson ​

readonly eventsJson: string

Defined in: packages/celox/src/types.ts:107

Inherited from ​

FrontendSimulatorHandleMetadata.eventsJson


eventWasmBytes? ​

optional eventWasmBytes?: undefined

Defined in: packages/celox/src/types.ts:135


hierarchyJson ​

readonly hierarchyJson: string

Defined in: packages/celox/src/types.ts:108

Inherited from ​

FrontendSimulatorHandleMetadata.hierarchyJson


initialMemoryBytes? ​

optional initialMemoryBytes?: undefined

Defined in: packages/celox/src/types.ts:133


layoutJson ​

readonly layoutJson: string

Defined in: packages/celox/src/types.ts:106

Inherited from ​

FrontendSimulatorHandleMetadata.layoutJson


stableSize ​

readonly stableSize: number

Defined in: packages/celox/src/types.ts:110

Inherited from ​

FrontendSimulatorHandleMetadata.stableSize


totalSize ​

readonly totalSize: number

Defined in: packages/celox/src/types.ts:111

Inherited from ​

FrontendSimulatorHandleMetadata.totalSize


warningsJson ​

readonly warningsJson: string

Defined in: packages/celox/src/types.ts:109

Inherited from ​

FrontendSimulatorHandleMetadata.warningsJson

Methods ​

checkpoint()? ​

optional checkpoint(): NativeCheckpoint

Defined in: packages/celox/src/types.ts:124

Save the design state. Absent on addons without checkpoint support.

Returns ​

NativeCheckpoint


dispose() ​

dispose(): void

Defined in: packages/celox/src/types.ts:112

Returns ​

void

Inherited from ​

FrontendSimulatorHandleMetadata.dispose


dump() ​

dump(timestamp): void

Defined in: packages/celox/src/types.ts:121

Parameters ​

timestamp ​

number

Returns ​

void


evalComb() ​

evalComb(): void

Defined in: packages/celox/src/types.ts:120

Returns ​

void


loadState()? ​

optional loadState(bytes): void

Defined in: packages/celox/src/types.ts:130

Load state file bytes and settle combinational logic.

Parameters ​

bytes ​

Uint8Array

Returns ​

void


restore()? ​

optional restore(checkpoint): void

Defined in: packages/celox/src/types.ts:126

Restore a checkpoint and settle combinational logic.

Parameters ​

checkpoint ​

NativeCheckpoint

Returns ​

void


saveState()? ​

optional saveState(): Uint8Array

Defined in: packages/celox/src/types.ts:128

Save every state object by path as state file bytes.

Returns ​

Uint8Array


sharedMemory() ​

sharedMemory(): Uint8Array

Defined in: packages/celox/src/types.ts:122

Returns ​

Uint8Array


switchVcd()? ​

optional switchVcd(path): void

Defined in: packages/celox/src/types.ts:132

Continue the waveform in a new VCD file.

Parameters ​

path ​

string

Returns ​

void


tick() ​

tick(eventId): void

Defined in: packages/celox/src/types.ts:118

Parameters ​

eventId ​

number

Returns ​

void


tickN() ​

tickN(eventId, count): void

Defined in: packages/celox/src/types.ts:119

Parameters ​

eventId ​

number

count ​

number

Returns ​

void