MotorXP-AFM Scripting API
    Preparing search index...

    Interface WindingElement

    WindingElement type

    interface WindingElement {
        actualWireDiameter: number;
        actualWireDiameterChanged: SignalConnector<number>;
        autoCalcCoilSpan: boolean;
        autoCalcCoilSpanChanged: SignalConnector<boolean>;
        autoCalcEndInductance: boolean;
        autoCalcEndInductanceChanged: SignalConnector<boolean>;
        autoCalcOverhangEndturns: boolean;
        autoCalcOverhangEndturnsChanged: SignalConnector<boolean>;
        autoCalcPhaseResistance: boolean;
        autoCalcPhaseResistanceChanged: SignalConnector<boolean>;
        availableWireSizeMethods: WireSizeMethod[];
        availableWireSizeMethodsChanged: SignalConnector<WireSizeMethod[]>;
        circuit: number;
        circuitChanged: SignalConnector<number>;
        coilFillFactor: number;
        coilFillFactorChanged: SignalConnector<number>;
        coilSpan: number;
        coilSpanChanged: SignalConnector<number>;
        connection: string;
        connectionChanged: SignalConnector<string>;
        endInductance: number;
        endInductanceChanged: SignalConnector<number>;
        endturnsScript: string;
        endturnsScriptChanged: SignalConnector<string>;
        endturnsScriptName: string;
        fillFactor: number;
        heightInnerEndturn: number;
        heightInnerEndturnChanged: SignalConnector<number>;
        heightOuterEndturn: number;
        heightOuterEndturnChanged: SignalConnector<number>;
        heightRectangularWire: number;
        heightRectangularWireChanged: SignalConnector<number>;
        layersOrientation: number;
        layersOrientationChanged: SignalConnector<number>;
        modeLayout: number;
        modeLayoutChanged: SignalConnector<number>;
        numberColumns: number;
        numberLayers: number;
        numberLayersChanged: SignalConnector<number>;
        numberRows: number;
        numberStrands: number;
        numberStrandsChanged: SignalConnector<number>;
        numberTurns: number;
        numberTurnsChanged: SignalConnector<number>;
        offsetHeightInnerEndturn: number;
        offsetHeightInnerEndturnChanged: SignalConnector<number>;
        offsetHeightOuterEndturn: number;
        offsetHeightOuterEndturnChanged: SignalConnector<number>;
        offsetOverhangInnerEndturn: number;
        offsetOverhangInnerEndturnChanged: SignalConnector<number>;
        offsetOverhangOuterEndturn: number;
        offsetOverhangOuterEndturnChanged: SignalConnector<number>;
        overhangInnerEndturn: number;
        overhangInnerEndturnChanged: SignalConnector<number>;
        overhangOuterEndturn: number;
        overhangOuterEndturnChanged: SignalConnector<number>;
        parallelPaths: number;
        parallelPathsChanged: SignalConnector<number>;
        phaseResistance: number;
        phaseResistanceChanged: SignalConnector<number>;
        properties: { [name: string]: any };
        radialOverhangInnerEnd: number;
        radialOverhangInnerEndturn: number;
        radialOverhangOuterEnd: number;
        radialOverhangOuterEndturn: number;
        radiusCornerRectangularWire: number;
        radiusCornerRectangularWireChanged: SignalConnector<number>;
        reverseLayersLayouts: boolean[];
        reverseLayersLayoutsChanged: SignalConnector;
        sizeRectangularWire: { height: number; width: number };
        sizeRectangularWireChanged: SignalConnector<
            { height: number; width: number },
        >;
        slotFillFactor: number;
        slotFillFactorChanged: SignalConnector<number>;
        stepColumns: number;
        stepRows: number;
        strandsConductor: number;
        type: number;
        typeChanged: SignalConnector<number>;
        widthRectangularWire: number;
        widthRectangularWireChanged: SignalConnector<number>;
        windingModel: number;
        windingModelChanged: SignalConnector<number>;
        wireDiameter: number;
        wireDiameterAWG: number;
        wireDiameterAWGChanged: SignalConnector<number>;
        wireDiameterFillFactor: number;
        wireDiameterFillFactorChanged: SignalConnector<number>;
        wireDiameterRound: number;
        wireDiameterRoundChanged: SignalConnector<number>;
        wireDiameterSWG: number;
        wireDiameterSWGChanged: SignalConnector<number>;
        wireLength: number;
        wireLengthChanged: SignalConnector<number>;
        wireSizeAWG: string;
        wireSizeAWGChanged: SignalConnector<string>;
        wireSizeMethod: WireSizeMethod;
        wireSizeMethodChanged: SignalConnector<WireSizeMethod>;
        wireSizeSWG: string;
        wireSizeSWGChanged: SignalConnector<string>;
        appendError(text: string, separator?: string): void;
        appendWarning(text: string, separator?: string): void;
        changeProperty(propName: string, value: any): boolean;
        error(): string;
        isDoubleLayer(): boolean;
        isDoubleLayerLeftRight(): boolean;
        isDoubleLayerUpperLower(): boolean;
        isOrientationLeftRight(): boolean;
        isOrientationUpperLower(): boolean;
        isPlanar(): boolean;
        isSingleLayer(): boolean;
        isToroidal(): boolean;
        isWindingModelFull(): boolean;
        isWindingModelLumped(): boolean;
        isWireSizeMethodAWG(): boolean;
        isWireSizeMethodFillFactor(): boolean;
        isWireSizeMethodRectangularWire(): boolean;
        isWireSizeMethodRoundWire(): boolean;
        isWireSizeMethodSWG(): boolean;
        isWireSizeMethodWireDiameter(): boolean;
        setError(text: string): void;
        setWarning(text: string): void;
        warning(): string;
    }
    Index
    actualWireDiameter actualWireDiameterChanged autoCalcCoilSpan autoCalcCoilSpanChanged autoCalcEndInductance autoCalcEndInductanceChanged autoCalcOverhangEndturns autoCalcOverhangEndturnsChanged autoCalcPhaseResistance autoCalcPhaseResistanceChanged availableWireSizeMethods availableWireSizeMethodsChanged circuit circuitChanged coilFillFactor coilFillFactorChanged coilSpan coilSpanChanged connection connectionChanged endInductance endInductanceChanged endturnsScript endturnsScriptChanged endturnsScriptName fillFactor heightInnerEndturn heightInnerEndturnChanged heightOuterEndturn heightOuterEndturnChanged heightRectangularWire heightRectangularWireChanged layersOrientation layersOrientationChanged modeLayout modeLayoutChanged numberColumns numberLayers numberLayersChanged numberRows numberStrands numberStrandsChanged numberTurns numberTurnsChanged offsetHeightInnerEndturn offsetHeightInnerEndturnChanged offsetHeightOuterEndturn offsetHeightOuterEndturnChanged offsetOverhangInnerEndturn offsetOverhangInnerEndturnChanged offsetOverhangOuterEndturn offsetOverhangOuterEndturnChanged overhangInnerEndturn overhangInnerEndturnChanged overhangOuterEndturn overhangOuterEndturnChanged parallelPaths parallelPathsChanged phaseResistance phaseResistanceChanged properties radialOverhangInnerEnd radialOverhangInnerEndturn radialOverhangOuterEnd radialOverhangOuterEndturn radiusCornerRectangularWire radiusCornerRectangularWireChanged reverseLayersLayouts reverseLayersLayoutsChanged sizeRectangularWire sizeRectangularWireChanged slotFillFactor slotFillFactorChanged stepColumns stepRows strandsConductor type typeChanged widthRectangularWire widthRectangularWireChanged windingModel windingModelChanged wireDiameter wireDiameterAWG wireDiameterAWGChanged wireDiameterFillFactor wireDiameterFillFactorChanged wireDiameterRound wireDiameterRoundChanged wireDiameterSWG wireDiameterSWGChanged wireLength wireLengthChanged wireSizeAWG wireSizeAWGChanged wireSizeMethod wireSizeMethodChanged wireSizeSWG wireSizeSWGChanged
    actualWireDiameter: number

    Actual winding wire diameter, accounting for the selected wire sizing method.

    Read only

    actualWireDiameterChanged: SignalConnector<number>

    Signal emitted when the actual wire diameter changes (actualWireDiameter and wireDiameter).

    Read

    autoCalcCoilSpan: boolean

    The autoCalcCoilSpan property...

    Read/Write

    autoCalcCoilSpanChanged: SignalConnector<boolean>

    Signal emitted when autoCalcCoilSpan changes.

    Read

    autoCalcEndInductance: boolean

    The autoCalcEndInductance property...

    Read/Write

    autoCalcEndInductanceChanged: SignalConnector<boolean>

    Signal emitted when autoCalcEndInductance changes.

    Read

    autoCalcOverhangEndturns: boolean

    The autoCalcOverhangEndturns property...

    Read/Write

    autoCalcOverhangEndturnsChanged: SignalConnector<boolean>

    Signal emitted when autoCalcOverhangEndturns changes.

    Read

    autoCalcPhaseResistance: boolean

    The autoCalcPhaseResistance property...

    Read/Write

    autoCalcPhaseResistanceChanged: SignalConnector<boolean>

    Signal emitted when autoCalcPhaseResistance changes.

    Read

    availableWireSizeMethods: WireSizeMethod[]

    List of available wire sizing methods.

    Read/Write

    availableWireSizeMethodsChanged: SignalConnector<WireSizeMethod[]>

    Signal emitted when availableWireSizeMethods changes.

    Read

    circuit: number

    The circuit property...

    Read/Write

    circuitChanged: SignalConnector<number>

    Signal emitted when circuit changes.

    Read

    coilFillFactor: number

    Coil fill factor.

    Read/Write

    coilFillFactorChanged: SignalConnector<number>

    Signal emitted when coilFillFactor changes.

    Read

    coilSpan: number

    Coil span: number of slots between the start and end of one coil.

    Read/Write

    coilSpanChanged: SignalConnector<number>

    Signal emitted when coilSpan changes.

    Read

    connection: string

    The connection property...

    Read/Write

    connectionChanged: SignalConnector<string>

    Signal emitted when connection changes.

    Read

    endInductance: number

    End-turn inductance.

    Read/Write

    endInductanceChanged: SignalConnector<number>

    Signal emitted when endInductance changes.

    Read

    endturnsScript: string

    End-turn script file name.

    Read/Write

    endturnsScriptChanged: SignalConnector<string>

    Signal emitted when endturnsScript changes.

    Read

    endturnsScriptName: string

    End-turn script name.

    Read only

    fillFactor: number

    Coil fill factor.

    Read/Write

    heightInnerEndturn: number

    The heightInnerEndturn property...

    Read/Write

    heightInnerEndturnChanged: SignalConnector<number>

    Signal emitted when heightInnerEndturn changes.

    Read

    heightOuterEndturn: number

    The heightOuterEndturn property...

    Read/Write

    heightOuterEndturnChanged: SignalConnector<number>

    Signal emitted when heightOuterEndturn changes.

    Read

    heightRectangularWire: number

    Rectangular conductor height.

    Read/Write

    heightRectangularWireChanged: SignalConnector<number>

    Signal emitted when rectangular conductor height changes.

    Read

    layersOrientation: number

    The layersOrientation property...

    Read/Write

    layersOrientationChanged: SignalConnector<number>

    Signal emitted when layersOrientation changes.

    Read

    modeLayout: number

    Winding layout mode: Winding.Automatic or Winding.Manual.

    Read/Write

    modeLayoutChanged: SignalConnector<number>

    Signal emitted when modeLayout changes.

    Read

    numberColumns: number

    Number of winding columns in a slot.

    Read only

    numberLayers: number

    The numberLayers property...

    Read/Write

    numberLayersChanged: SignalConnector<number>

    Signal emitted when numberLayers changes.

    Read

    numberRows: number

    Number of winding rows in a slot.

    Read only

    numberStrands: number

    The numberStrands property...

    Read/Write

    numberStrandsChanged: SignalConnector<number>

    Signal emitted when the number of strands changes.

    Read

    numberTurns: number

    The numberTurns property...

    Read/Write

    numberTurnsChanged: SignalConnector<number>

    Signal emitted when the number of turns changes.

    Read

    offsetHeightInnerEndturn: number

    Inner end-turn height offset.

    Read/Write

    offsetHeightInnerEndturnChanged: SignalConnector<number>

    Signal emitted when offsetHeightInnerEndturn changes.

    Read

    offsetHeightOuterEndturn: number

    Outer end-turn height offset.

    Read/Write

    offsetHeightOuterEndturnChanged: SignalConnector<number>

    Signal emitted when offsetHeightOuterEndturn changes.

    Read

    offsetOverhangInnerEndturn: number

    Inner end-turn overhang offset.

    Read/Write

    offsetOverhangInnerEndturnChanged: SignalConnector<number>

    Signal emitted when offsetOverhangInnerEndturn changes.

    Read

    offsetOverhangOuterEndturn: number

    Outer end-turn overhang offset.

    Read/Write

    offsetOverhangOuterEndturnChanged: SignalConnector<number>

    Signal emitted when offsetOverhangOuterEndturn changes.

    Read

    overhangInnerEndturn: number

    The overhangInnerEndturn property...

    Read/Write

    overhangInnerEndturnChanged: SignalConnector<number>

    Signal emitted when overhangInnerEndturn changes.

    Read

    overhangOuterEndturn: number

    The overhangOuterEndturn property...

    Read/Write

    overhangOuterEndturnChanged: SignalConnector<number>

    Signal emitted when overhangOuterEndturn changes.

    Read

    parallelPaths: number

    The parallelPaths property...

    Read/Write

    parallelPathsChanged: SignalConnector<number>

    Signal emitted when parallelPaths changes.

    Read

    phaseResistance: number

    Phase resistance.

    Read/Write

    phaseResistanceChanged: SignalConnector<number>

    Signal emitted when phaseResistance changes.

    Read

    properties: { [name: string]: any }

    All winding properties as a name-to-value object.

    Read/Write

    radialOverhangInnerEnd: number

    Inner end-turn overhang.

    Read/Write

    radialOverhangInnerEndturn: number

    Inner end-turn overhang.

    Read/Write

    radialOverhangOuterEnd: number

    Outer end-turn overhang.

    Read/Write

    radialOverhangOuterEndturn: number

    Outer end-turn overhang.

    Read/Write

    radiusCornerRectangularWire: number

    Rectangular conductor corner radius.

    Read/Write

    radiusCornerRectangularWireChanged: SignalConnector<number>

    Signal emitted when the rectangular conductor corner radius changes.

    Read

    reverseLayersLayouts: boolean[]

    Layout reversal flags for each layer.

    Read/Write

    reverseLayersLayoutsChanged: SignalConnector

    Signal emitted when reverseLayersLayouts changes.

    Read

    sizeRectangularWire: { height: number; width: number }

    Rectangular conductor size (width and height).

    Read/Write

    sizeRectangularWireChanged: SignalConnector<{ height: number; width: number }>

    Signal emitted when sizeRectangularWire changes.

    Read

    slotFillFactor: number

    Slot fill factor.

    Read/Write

    slotFillFactorChanged: SignalConnector<number>

    Signal emitted when slotFillFactor changes.

    Read

    stepColumns: number

    Spacing between winding columns in a slot.

    Read only

    stepRows: number

    Spacing between winding rows in a slot.

    Read only

    strandsConductor: number

    Number of conductors per turn.

    Read/Write

    type: number

    The type property...

    Read/Write

    typeChanged: SignalConnector<number>

    Signal emitted when type changes.

    Read

    widthRectangularWire: number

    Rectangular conductor width.

    Read/Write

    widthRectangularWireChanged: SignalConnector<number>

    Signal emitted when rectangular conductor width changes.

    Read

    windingModel: number

    The windingModel property...

    Read/Write

    windingModelChanged: SignalConnector<number>

    Signal emitted when windingModel changes.

    Read

    wireDiameter: number

    Winding wire diameter (same as actualWireDiameter).

    Read only

    wireDiameterAWG: number

    Wire diameter according to AWG.

    Read only

    wireDiameterAWGChanged: SignalConnector<number>

    Signal emitted when the AWG round conductor diameter changes.

    Read

    wireDiameterFillFactor: number

    Wire diameter calculated from the fill factor.

    Read only

    wireDiameterFillFactorChanged: SignalConnector<number>

    Signal emitted when the FillFactor round conductor diameter changes.

    Read

    wireDiameterRound: number

    Custom winding wire diameter.

    Read/Write

    wireDiameterRoundChanged: SignalConnector<number>

    Signal emitted when the custom round conductor diameter changes.

    Read

    wireDiameterSWG: number

    Wire diameter according to SWG.

    Read only

    wireDiameterSWGChanged: SignalConnector<number>

    Signal emitted when the SWG round conductor diameter changes.

    Read

    wireLength: number

    Winding wire length.

    Read only

    wireLengthChanged: SignalConnector<number>

    Signal emitted when wireLength changes.

    Read

    wireSizeAWG: string

    AWG wire size

    Read/Write

    wireSizeAWGChanged: SignalConnector<string>

    Signal emitted when the AWG wire diameter changes.

    Read

    wireSizeMethod: WireSizeMethod

    Wire sizing method.

    Read/Write

    wireSizeMethodChanged: SignalConnector<WireSizeMethod>

    Signal emitted when the wire type or standard changes.

    Read

    wireSizeSWG: string

    SWG wire size

    Read/Write

    wireSizeSWGChanged: SignalConnector<string>

    Signal emitted when the SWG wire diameter changes.

    Read

    • Appends a script-defined winding geometry error for display in the scene.

      Parameters

      • text: string

        {string} - Error text.

      • Optionalseparator: string

        {string} - Separator inserted before the error text.

      Returns void

      No return value.

    • Appends a script-defined rotor geometry warning for display in the scene.

      Parameters

      • text: string

        {string} - Warning text.

      • Optionalseparator: string

        {string} - Separator inserted before the error text.

      Returns void

      No return value.

    • Changes a property value. The change can be undone with the Undo command in the GUI.

      Parameters

      • propName: string

        {string} - Property name.

      • value: any

        {any} - Property value.

      Returns boolean

      True on success.

    • Current script-defined winding geometry error.

      Returns string

      Error text.

    • True if a double layer is selected.

      Returns boolean

      True if a double layer is selected.

    • True if a double-layer winding with left/right orientation is selected.

      Returns boolean

      True if a double layer with left/right orientation is selected.

    • True if a double-layer winding with upper/lower orientation is selected.

      Returns boolean

      True if a double layer with upper/lower orientation is selected.

    • True if left/right winding orientation is selected for the double layer.

      Returns boolean

      True if left/right winding orientation is selected for the double layer.

    • True if upper/lower winding orientation is selected for the double layer.

      Returns boolean

      True if upper/lower winding orientation is selected for the double layer.

    • True if the winding type is planar.

      Returns boolean

      True if the winding type is planar.

    • True if a single layer is selected.

      Returns boolean

      True if a single layer is selected.

    • True if the winding type is toroidal.

      Returns boolean

      True if the winding type is toroidal.

    • True if the Full model is selected.

      Returns boolean

      True if the Full model is selected.

    • True if the Lumped model is selected.

      Returns boolean

      True if the Lumped model is selected.

    • Flag indicating whether American Wire Gauge (AWG) sizing is used.

      Returns boolean

      True if AWG is used.

    • Flag indicating whether FillFactor is used.

      Returns boolean

      True if FillFactor is used.

    • Flag indicating whether custom rectangular wire dimensions (RectangularWire) are used.

      Returns boolean

      True if RectangularWire is used.

    • Flag indicating whether custom round wire dimensions (RoundWire) are used.

      Returns boolean

      True if RoundWire is used.

    • Flag indicating whether Standard Wire Gauge (SWG) sizing is used.

      Returns boolean

      True if SWG is used.

    • Flag indicating whether a custom wire diameter (WireDiameter) is used.

      Returns boolean

      True if WireDiameter is used.

    • Sets a script-defined winding geometry error for display in the scene.

      Parameters

      • text: string

        {string} - Error text.

      Returns void

      No return value.

    • Sets a script-defined winding geometry warning for display in the scene.

      Parameters

      • text: string

        {string} - Warning text.

      Returns void

      No return value.

    • Current script-defined winding geometry warning.

      Returns string

      Warning text.