Class MockFrontPanel

constructor

• new MockFrontPanel(wireWidth, triggerVectorWidth): MockFrontPanel

• Parameters

  • wireWidth: number

    The width of the mock WireIn and WireOut endpoints, measured in bits.
  • triggerVectorWidth: number

    The width of the mock TriggerOut vectors, measured in bits.

  Returns MockFrontPanel

Static Readonly PIPEIN_ADDRESS_RANGE

Static Readonly PIPEOUT_ADDRESS_RANGE

Static Readonly REGISTER_ADDRESS_RANGE

Static Readonly TRIGGERIN_ADDRESS_RANGE

Static Readonly TRIGGEROUT_ADDRESS_RANGE

Static Readonly WIREIN_ADDRESS_RANGE

Static Readonly WIREOUT_ADDRESS_RANGE

RegisterBlock

• get RegisterBlock(): MockDataBlock

• The Register data block

  Returns MockDataBlock

TriggerOutBlock

• get TriggerOutBlock(): MockDataBlock

• The TriggerOut data block

  Returns MockDataBlock

WireInBlock

• get WireInBlock(): MockDataBlock

• The WireIn data block

  Returns MockDataBlock

WireOutBlock

• get WireOutBlock(): MockDataBlock

• The WireOut data block

  Returns MockDataBlock

activateTriggerIn

• activateTriggerIn(address, bit): Promise<void>

• Activates the mock TriggerIn endpoint at the specified address and bit.

  Parameters

  • address: number

    The address of the mock TriggerIn vector.
  • bit: number

    The bit to activate.

  Returns Promise<void>

  • A promise that resolves when the mock TriggerIn endpoint has been activated.

getTriggerOutVector

• getTriggerOutVector(address): number

• Gets the mock TriggerOut vector at the specified address.

  Parameters

  • address: number

    The address of the mock TriggerOut vector.

  Returns number

  • The mock TriggerOut vector.

getWireInValue

• getWireInValue(address): number

• Gets the value of the mock WireIn endpoint at the specified address.

  Parameters

  • address: number

    The address of the WireIn endpoint.

  Returns number

  • The value of the mock WireIn endpoint.

getWireOutValue

• getWireOutValue(address): number

• Gets the value of the mock WireOut endpoint at the specified address.

  Parameters

  • address: number

    The address of the wire out.

  Returns number

  • The value of the wire out.

isTriggered

• isTriggered(address, mask): boolean

• Checks if the mock TriggerOut endpoint at the specified address is active by applying the mask.

  Parameters

  • address: number

    The address of the mock TriggerOut vector.
  • mask: number

    The mask to apply to the mock TriggerOut vector.

  Returns boolean

  • True if the TriggerOut endpoint is active, or false otherwise.

readFromBlockPipeOut

• readFromBlockPipeOut(_address, _blockSize, _length, _buffer): Promise<number>

• Reads data from the Block Throttle PipeOut at the specified address.

  Parameters

  • _address: number
  • _blockSize: number
  • _length: number
  • _buffer: ArrayBuffer

  Returns Promise<number>

  • A promise that resolves when the data has been read indicating the number of bytes that were successfully read.

readFromPipeOut

• readFromPipeOut(_address, _length, _buffer): Promise<number>

• Reads data from the PipeOut at the specified address.

  Parameters

  • _address: number
  • _length: number
  • _buffer: ArrayBuffer

  Returns Promise<number>

  • A promise that resolves when the data has been read indicating the number of bytes that were successfully read.

readRegister

• readRegister(address): Promise<number>

• Reads the value of the mock Register at the specified address.

  Parameters

  • address: number

    The address of the mock Register.

  Returns Promise<number>

  • A promise that resolves to the value of the mock Register.

readRegisters

• readRegisters(_registers): Promise<void>

• Reads the data of the Registers at the specified addresses and stores the data in the corresponding array element.

  Parameters

  • _registers: {
        address: number;
        data: number;
    }[]

  Returns Promise<void>

  • A promise that resolves when all the registers have been read.

setWireInValue

• setWireInValue(address, value, mask): void

• Sets the value of the mock WireIn endpoint at the specified address.

  Parameters

  • address: number

    The address of the mock WireIn endpoint.
  • value: number

    The value to set.
  • mask: number

    The mask to apply to the value.

  Returns void

updateTriggerOuts

• updateTriggerOuts(): Promise<void>

• Updates all mock TriggerOut vectors.

  Returns Promise<void>

  • A promise that resolves when all mock TriggerOut vectors have been updated.

updateWireIns

• updateWireIns(): Promise<void>

• Updates all mock WireIn endpoints.

  Returns Promise<void>

  • A promise that resolves when all mock WireIn endpoints have been updated.

updateWireOuts

• updateWireOuts(): Promise<void>

• Updates all mock WireOut endpoints.

  Returns Promise<void>

  • A promise that resolves when all mock WireOut endpoints have been updated.

writeRegister

• writeRegister(address, value): Promise<void>

• Writes a value to the mock Register at the specified address.

  Parameters

  • address: number

    The address of the mock Register.
  • value: number

    The value to write.

  Returns Promise<void>

  • A promise that resolves when the value has been written.

writeRegisters

• writeRegisters(_registers): Promise<void>

• Writes data to each of the Registers at the specified addresses.

  Parameters

  • _registers: {
        address: number;
        data: number;
    }[]

  Returns Promise<void>

  • A promise that resolves when the register values have been written.

writeToBlockPipeIn

• writeToBlockPipeIn(_address, _blockSize, _length, _data): Promise<number>

• Writes data to the Block Throttle PipeIn at the specified address.

  Parameters

  • _address: number
  • _blockSize: number
  • _length: number
  • _data: ArrayBuffer

  Returns Promise<number>

  • A promise that resolves when the data has been written indicating the number of bytes that were successfully written.

writeToPipeIn

• writeToPipeIn(_address, _length, _data): Promise<number>

• Writes data to the PipeIn at the specified address.

  Parameters

  • _address: number
  • _length: number
  • _data: ArrayBuffer

  Returns Promise<number>

  • A promise that resolves when the data has been written indicating the number of bytes that were successfully written.