Class TutorialFiles

Base class to load circuit files (e.g. Circuits.zip) from the server and creates a CircuitSet based on the loaded files. Use child classes to load and create the CircuitSet objects that are stored in CircuitFilesManager.circuitSets.

Hierarchy (View Summary)

Constructors

constructor

Properties

circuitDirs circuitSets customCircuitsPath files hash loaded quickStartIdentifier zipDirName

Accessors

keys options quickStartSet

Methods

_compareByCircuitDivIds _recreateAndFilter getCircuitSet getHash init loadZipIntoPyodide mapCircuits setHash

Constructors

constructor

Properties

circuitDirs

circuitDirs: any

circuitSets

circuitSets: CircuitSet[] = []

customCircuitsPath

customCircuitsPath: string

files

files: {}

hash

hash: any

loaded

loaded: boolean = false

quickStartIdentifier

quickStartIdentifier: any

zipDirName

zipDirName: string

Accessors

keys

  • get keys(): {
        capacitor: string;
        inductor: string;
        kirchhoff: string;
        magnetic: string;
        mixed: string;
        quickstart: string;
        resistor: string;
        symbolic: string;
        wheatstone: string;
    }[]

    Returns {
        capacitor: string;
        inductor: string;
        kirchhoff: string;
        magnetic: string;
        mixed: string;
        quickstart: string;
        resistor: string;
        symbolic: string;
        wheatstone: string;
    }[]

options

  • get options(): WheatstoneOption[]

    Returns WheatstoneOption[]

quickStartSet

  • get quickStartSet(): CircuitSet

    Returns CircuitSet

Methods

_compareByCircuitDivIds

_recreateAndFilter

  • _recreateAndFilter(readPath: string): Promise<void>

    recreate the folder structure from readPath in this.files

    Parameters

    • readPath: string

      the path where pyodide reads using FS interface

    Returns Promise<void>

getCircuitSet

  • getCircuitSet(
        identifier: {
            capacitor: string;
            inductor: string;
            kirchhoff: string;
            magnetic: string;
            mixed: string;
            quickstart: string;
            resistor: string;
            symbolic: string;
            wheatstone: string;
        },
    ): CircuitSet

    Parameters

    • identifier: {
          capacitor: string;
          inductor: string;
          kirchhoff: string;
          magnetic: string;
          mixed: string;
          quickstart: string;
          resistor: string;
          symbolic: string;
          wheatstone: string;
      }

      {window.definitions.selectorIDs}

    Returns CircuitSet

getHash

  • getHash(buffer: any): Promise<string>

    Parameters

    • buffer: any

    Returns Promise<string>

init

  • init(): Promise<void>

    Returns Promise<void>

loadZipIntoPyodide

  • loadZipIntoPyodide(arrayBuffer: any, extractDir: any): Promise<void>

    Parameters

    • arrayBuffer: any
    • extractDir: any

    Returns Promise<void>

mapCircuits

  • mapCircuits(
        mode?: { custom: number; editor: number; learn: number; qr: number },
    ): Promise<void>

    create CircuitSets from the directories

    Parameters

    • mode: { custom: number; editor: number; learn: number; qr: number } = window.definitions.mode.learn

      {window.definitions.mode}

    Returns Promise<void>

setHash

  • setHash(buffer: any): Promise<string>

    Parameters

    • buffer: any

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods