Class ScannedCircuitMap

circuitFile

frequency

index

mode

parent

selectorGroup

sourceDir

svgFile

trackingId

voltage

circuitId

• get circuitId(): string

  Returns string

customCircuitsPath

• get customCircuitsPath(): string

  Returns string

customOverViewSvgFile

• get customOverViewSvgFile(): string

  Returns string

  the path to the location of the overview svg file for the custom circuits

editorCircuitsPath

• get editorCircuitsPath(): string

  Returns string

editorOverViewSvgFile

• get editorOverViewSvgFile(): string

  Returns string

overViewSvgFile

• get overViewSvgFile(): string

  Returns string

  the path to the location of the overview svg file for the selector under learn

paramMap

• get paramMap(): ParamMap

  Returns ParamMap

qrCircuitsPath

• get qrCircuitsPath(): string

  Returns string

saveName

• get saveName(): string

  Returns string

solutionPath

• get solutionPath(): string

  Returns string

standardCircuitName

• get standardCircuitName(): string

  Returns string

standardCircuitsPath

• get standardCircuitsPath(): string

  Returns string

_init

• _init(
      circuitFileName: string,
      dir: any,
      id: {
          capacitor: string;
          inductor: string;
          kirchhoff: string;
          magnetic: string;
          mixed: string;
          quickstart: string;
          resistor: string;
          symbolic: string;
          wheatstone: string;
      },
      parent: CircuitMap[],
      index: int,
      mode?: { custom: number; editor: number; learn: number; qr: number },
  ): CircuitMap

  Parameters

  • circuitFileName: string

    {string} name of the file
  • dir: any

    {window.definitions.allowedDirNames} the directory the circuit is saved in
  • id: {
        capacitor: string;
        inductor: string;
        kirchhoff: string;
        magnetic: string;
        mixed: string;
        quickstart: string;
        resistor: string;
        symbolic: string;
        wheatstone: string;
    }

    {window.definitions.selectorIDs} the id of the circuit
  • parent: CircuitMap[]

    {Array} the list in which this CircuitMap is saved
  • index: int

    {int} at wich index this element is in the parent
  • mode: { custom: number; editor: number; learn: number; qr: number } = window.definitions.mode.learn

    {window.definitions.mode} the mode for wich this circuit map is used (changes paths)

  Returns CircuitMap

  the circuit map for the passed arguments

_readVoltageAndFreq

• _readVoltageAndFreq(path: any): Promise<{ frequency: string; voltage: string }>

  Parameters

  • path: any

  Returns Promise<{ frequency: string; voltage: string }>

init

• init(
      circuitFileName: any,
      dir: any,
      id: any,
      parent: any,
      index: any,
      mode?: any,
  ): Promise<ScannedCircuitMap>

  Parameters

  • circuitFileName: any
  • dir: any
  • id: any
  • parent: any
  • index: any
  • mode: any = window.definitions.mode.learn

  Returns Promise<ScannedCircuitMap>

nextCircuitMap

• nextCircuitMap(circuitMap: any): any

  uses the parent filed of the CircuitMap to determine the next element in the list this way we don't need to keep which CircuitFilesManager is handling this right now because the circuits know what list they are part of and the next element can be found by getting their index in their parent list and incrementing the index

  Parameters

  • circuitMap: any

  Returns any

readOrGenerateSvgData

• readOrGenerateSvgData(path: string): Promise<string>

  Parameters

  • path: string

    {string} the path to the svg file to read or generate

  Returns Promise<string>

  the svg data of the overview svg file for this circuit, generates the svg data if not found

readSvgData

• readSvgData(path: any): Promise<string>

  Parameters

  • path: any

  Returns Promise<string>

  the svg data of the overview svg file for this circuit, throws an error if file does not exist

svgData

• svgData(recursion?: boolean, mode?: any): any

  Parameters

  • recursion: boolean = true
  • mode: any = undefined

  Returns any