MotorXP-PM Scripting API
    Preparing search index...

    Interface WindingElement

    Winding element (motor.winding)

    interface WindingElement {
        actualWireDiameter: number;
        actualWireDiameterChanged: SignalConnector<number>;
        autoCalcCoilSpan: boolean;
        autoCalcCoilSpanChanged: SignalConnector<boolean>;
        autoCalcEndAxialOverhang: boolean;
        autoCalcEndAxialOverhangChanged: SignalConnector<boolean>;
        autoCalcEndInductance: boolean;
        autoCalcEndInductanceChanged: SignalConnector<boolean>;
        autoCalcPhaseResistance: boolean;
        autoCalcPhaseResistanceChanged: SignalConnector<boolean>;
        availableWireSizeMethods: WireSizeMethod[];
        availableWireSizeMethodsChanged: SignalConnector<WireSizeMethod[]>;
        circuit: WindingCircuit;
        circuitChanged: SignalConnector<WindingCircuit>;
        coilFillFactor: number;
        coilFillFactorChanged: SignalConnector<number>;
        coilSpan: number;
        coilSpanChanged: SignalConnector<number>;
        endAxialOverhang: number;
        endAxialOverhangChanged: SignalConnector<number>;
        endInductance: number;
        endInductanceChanged: SignalConnector<number>;
        fillFactor: number;
        heightRectangularWire: number;
        heightRectangularWireChanged: SignalConnector<number>;
        layerOrientation: LayerOrientation;
        layerOrientationChanged: SignalConnector<LayerOrientation>;
        layersOrientation: LayerOrientation;
        layout: LayoutCoils;
        layoutChanged: SignalConnector<LayoutCoils>;
        methodCalcEndInductance: string;
        methodCalcEndInductanceChanged: SignalConnector<string>;
        modeLayout: ModeLayout;
        modeLayoutChanged: SignalConnector<ModeLayout>;
        modeLayoutCoils: ModeLayout;
        numberColumns: number;
        numberLayers: number;
        numberLayersChanged: SignalConnector<number>;
        numberRows: number;
        numberStrands: number;
        numberStrandsChanged: SignalConnector<number>;
        numberTurns: number;
        numberTurnsChanged: SignalConnector<number>;
        parallelPaths: number;
        parallelPathsChanged: SignalConnector<number>;
        phaseResistance: number;
        phaseResistanceChanged: SignalConnector<number>;
        properties: { [name: string]: any };
        radiusCornerRectangularWire: number;
        radiusCornerRectangularWireChanged: SignalConnector<number>;
        sizeRectangularWire: Size;
        sizeRectangularWireChanged: SignalConnector<Size>;
        slotFillFactor: number;
        slotFillFactorChanged: SignalConnector<number>;
        stepColumns: number;
        stepRows: number;
        strandsConductor: number;
        widthRectangularWire: number;
        widthRectangularWireChanged: SignalConnector<number>;
        windingChanged: SignalConnector;
        windingModel: WindingModel;
        windingModelChanged: SignalConnector<WindingModel>;
        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>;
        changeProperty(propName: string, value: any): boolean;
        isLayerOrientationLeftRight(): boolean;
        isLayerOrientationUpperLower(): boolean;
        isWindingModelFull(): boolean;
        isWindingModelLumped(): boolean;
        isWireSizeMethodAWG(): boolean;
        isWireSizeMethodDiameter(): boolean;
        isWireSizeMethodDimensions(): boolean;
        isWireSizeMethodFillFactor(): boolean;
        isWireSizeMethodRectangularWire(): boolean;
        isWireSizeMethodRoundWire(): boolean;
        isWireSizeMethodSWG(): boolean;
        setNumberLayers(n: number): void;
    }
    Index

    Methods

    changeProperty isLayerOrientationLeftRight isLayerOrientationUpperLower isWindingModelFull isWindingModelLumped isWireSizeMethodAWG isWireSizeMethodDiameter isWireSizeMethodDimensions isWireSizeMethodFillFactor isWireSizeMethodRectangularWire isWireSizeMethodRoundWire isWireSizeMethodSWG setNumberLayers

    Properties

    actualWireDiameter actualWireDiameterChanged autoCalcCoilSpan autoCalcCoilSpanChanged autoCalcEndAxialOverhang autoCalcEndAxialOverhangChanged autoCalcEndInductance autoCalcEndInductanceChanged autoCalcPhaseResistance autoCalcPhaseResistanceChanged availableWireSizeMethods availableWireSizeMethodsChanged circuit circuitChanged coilFillFactor coilFillFactorChanged coilSpan coilSpanChanged endAxialOverhang endAxialOverhangChanged endInductance endInductanceChanged fillFactor heightRectangularWire heightRectangularWireChanged layerOrientation layerOrientationChanged layersOrientation layout layoutChanged methodCalcEndInductance methodCalcEndInductanceChanged modeLayout modeLayoutChanged modeLayoutCoils numberColumns numberLayers numberLayersChanged numberRows numberStrands numberStrandsChanged numberTurns numberTurnsChanged parallelPaths parallelPathsChanged phaseResistance phaseResistanceChanged properties radiusCornerRectangularWire radiusCornerRectangularWireChanged sizeRectangularWire sizeRectangularWireChanged slotFillFactor slotFillFactorChanged stepColumns stepRows strandsConductor widthRectangularWire widthRectangularWireChanged windingChanged windingModel windingModelChanged wireDiameter wireDiameterAWG wireDiameterAWGChanged wireDiameterFillFactor wireDiameterFillFactorChanged wireDiameterRound wireDiameterRoundChanged wireDiameterSWG wireDiameterSWGChanged wireLength wireLengthChanged wireSizeAWG wireSizeAWGChanged wireSizeMethod wireSizeMethodChanged wireSizeSWG wireSizeSWGChanged

    Methods

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

      Parameters

      • propName: string

        Property name.

      • value: any

        Property value.

      Returns boolean

      True on success.

    • True if the winding layers are located side by side.

      Returns boolean

    • True if the winding layers are located one above the other.

      Returns boolean

    • True for the full winding model.

      Returns boolean

    • True for the lumped winding model.

      Returns boolean

    • True if the wire size is taken from the AWG table.

      Returns boolean

    • True if the wire is round and set by diameter.

      Returns boolean

    • True if the wire is rectangular and set by width and height.

      Returns boolean

    • True if the wire diameter is calculated from the fill factor.

      Returns boolean

    • True if the wire is rectangular and set by width and height.

      Returns boolean

      Use WindingElement.isWireSizeMethodDimensions.

    • True if the wire is round and set by diameter.

      Returns boolean

      Use WindingElement.isWireSizeMethodDiameter.

    • True if the wire size is taken from the SWG table.

      Returns boolean

    • Sets the number of winding layers in a slot.

      Parameters

      • n: number

        Number of layers (1 or 2).

      Returns void

    Properties

    actualWireDiameter: number

    Wire diameter for the current wire size method.

    actualWireDiameterChanged: SignalConnector<number>

    Signal emitted when actualWireDiameter changes.

    autoCalcCoilSpan: boolean

    Calculate the coil span automatically.

    autoCalcCoilSpanChanged: SignalConnector<boolean>

    Signal emitted when autoCalcCoilSpan changes.

    autoCalcEndAxialOverhang: boolean

    Calculate the end-winding axial overhang automatically.

    autoCalcEndAxialOverhangChanged: SignalConnector<boolean>

    Signal emitted when autoCalcEndAxialOverhang changes.

    autoCalcEndInductance: boolean

    Calculate the end-winding inductance automatically.

    autoCalcEndInductanceChanged: SignalConnector<boolean>

    Signal emitted when autoCalcEndInductance changes.

    autoCalcPhaseResistance: boolean

    Calculate the phase resistance automatically.

    autoCalcPhaseResistanceChanged: SignalConnector<boolean>

    Signal emitted when autoCalcPhaseResistance changes.

    availableWireSizeMethods: WireSizeMethod[]

    Wire size methods available in the GUI.

    availableWireSizeMethodsChanged: SignalConnector<WireSizeMethod[]>

    Signal emitted when the available wire size methods change.

    circuit: WindingCircuit

    Winding circuit (star or delta).

    circuitChanged: SignalConnector<WindingCircuit>

    Signal emitted when the circuit changes.

    coilFillFactor: number

    Coil fill factor.

    coilFillFactorChanged: SignalConnector<number>

    Signal emitted when coilFillFactor changes.

    coilSpan: number

    Coil span in slots.

    coilSpanChanged: SignalConnector<number>

    Signal emitted when the coil span changes.

    endAxialOverhang: number

    End-winding axial overhang.

    endAxialOverhangChanged: SignalConnector<number>

    Signal emitted when endAxialOverhang changes.

    endInductance: number

    End-winding inductance.

    endInductanceChanged: SignalConnector<number>

    Signal emitted when endInductance changes.

    fillFactor: number

    Coil fill factor.

    Use WindingElement.coilFillFactor.

    heightRectangularWire: number

    Rectangular wire height.

    heightRectangularWireChanged: SignalConnector<number>

    Signal emitted when heightRectangularWire changes.

    layerOrientation: LayerOrientation

    Orientation of winding layers in a slot. Winding.UpperLower or Winding.LeftRight.

    layerOrientationChanged: SignalConnector<LayerOrientation>

    Signal emitted when the layer orientation changes.

    layersOrientation: LayerOrientation

    Orientation of winding layers in a slot.

    Use WindingElement.layerOrientation.

    layout: LayoutCoils

    Coil layout.

    layoutChanged: SignalConnector<LayoutCoils>

    Signal emitted when the coil layout changes.

    methodCalcEndInductance: string

    End-winding inductance calculation method.

    methodCalcEndInductanceChanged: SignalConnector<string>

    Signal emitted when methodCalcEndInductance changes.

    modeLayout: ModeLayout

    Coil layout mode.

    modeLayoutChanged: SignalConnector<ModeLayout>

    Signal emitted when the coil layout mode changes.

    modeLayoutCoils: ModeLayout

    Coil layout mode.

    Use WindingElement.modeLayout.

    numberColumns: number

    Number of conductor columns in the coil (full winding model).

    numberLayers: number

    Number of winding layers in a slot (1 or 2).

    numberLayersChanged: SignalConnector<number>

    Signal emitted when the number of layers changes.

    numberRows: number

    Number of conductor rows in the coil (full winding model).

    numberStrands: number

    Number of strands in a conductor.

    numberStrandsChanged: SignalConnector<number>

    Signal emitted when the number of strands changes.

    numberTurns: number

    Number of turns.

    numberTurnsChanged: SignalConnector<number>

    Signal emitted when the number of turns changes.

    parallelPaths: number

    Number of parallel paths.

    parallelPathsChanged: SignalConnector<number>

    Signal emitted when the number of parallel paths changes.

    phaseResistance: number

    Phase resistance.

    phaseResistanceChanged: SignalConnector<number>

    Signal emitted when phaseResistance changes.

    properties: { [name: string]: any }

    Winding properties as an object (name: value).

    radiusCornerRectangularWire: number

    Rectangular wire corner radius.

    radiusCornerRectangularWireChanged: SignalConnector<number>

    Signal emitted when radiusCornerRectangularWire changes.

    sizeRectangularWire: Size

    Rectangular wire size.

    sizeRectangularWireChanged: SignalConnector<Size>

    Signal emitted when sizeRectangularWire changes.

    slotFillFactor: number

    Slot fill factor.

    slotFillFactorChanged: SignalConnector<number>

    Signal emitted when slotFillFactor changes.

    stepColumns: number

    Step between conductor columns.

    stepRows: number

    Step between conductor rows.

    strandsConductor: number

    Number of strands in a conductor.

    Use WindingElement.numberStrands.

    widthRectangularWire: number

    Rectangular wire width.

    widthRectangularWireChanged: SignalConnector<number>

    Signal emitted when widthRectangularWire changes.

    windingChanged: SignalConnector

    Signal emitted when the winding changes.

    windingModel: WindingModel

    Winding model. Winding.Lumped or Winding.Full.

    windingModelChanged: SignalConnector<WindingModel>

    Signal emitted when the winding model changes.

    wireDiameter: number

    Wire diameter for the current wire size method (same as actualWireDiameter).

    wireDiameterAWG: number

    Wire diameter for wireSizeAWG.

    wireDiameterAWGChanged: SignalConnector<number>

    Signal emitted when wireDiameterAWG changes.

    wireDiameterFillFactor: number

    Wire diameter calculated from the fill factor.

    wireDiameterFillFactorChanged: SignalConnector<number>

    Signal emitted when wireDiameterFillFactor changes.

    wireDiameterRound: number

    Round wire diameter (WireSizeMethod.Diameter).

    wireDiameterRoundChanged: SignalConnector<number>

    Signal emitted when wireDiameterRound changes.

    wireDiameterSWG: number

    Wire diameter for wireSizeSWG.

    wireDiameterSWGChanged: SignalConnector<number>

    Signal emitted when wireDiameterSWG changes.

    wireLength: number

    Wire length.

    wireLengthChanged: SignalConnector<number>

    Signal emitted when the wire length changes.

    wireSizeAWG: string

    Wire size from the AWG table.

    wireSizeAWGChanged: SignalConnector<string>

    Signal emitted when wireSizeAWG changes.

    wireSizeMethod: WireSizeMethod

    Wire size method. Numbers (0 - AWG, 1 - SWG, 2 - FillFactor, 3 - Diameter, 4 - Dimensions) and strings are also accepted on assignment.

    wireSizeMethodChanged: SignalConnector<WireSizeMethod>

    Signal emitted when the wire size method changes.

    wireSizeSWG: string

    Wire size from the SWG table.

    wireSizeSWGChanged: SignalConnector<string>

    Signal emitted when wireSizeSWG changes.

    Settings

    Member Visibility

    On This Page

    Methods
    Properties
    actualWireDiameteractualWireDiameterChangedautoCalcCoilSpanautoCalcCoilSpanChangedautoCalcEndAxialOverhangautoCalcEndAxialOverhangChangedautoCalcEndInductanceautoCalcEndInductanceChangedautoCalcPhaseResistanceautoCalcPhaseResistanceChangedavailableWireSizeMethodsavailableWireSizeMethodsChangedcircuitcircuitChangedcoilFillFactorcoilFillFactorChangedcoilSpancoilSpanChangedendAxialOverhangendAxialOverhangChangedendInductanceendInductanceChangedfillFactorheightRectangularWireheightRectangularWireChangedlayerOrientationlayerOrientationChangedlayersOrientationlayoutlayoutChangedmethodCalcEndInductancemethodCalcEndInductanceChangedmodeLayoutmodeLayoutChangedmodeLayoutCoilsnumberColumnsnumberLayersnumberLayersChangednumberRowsnumberStrandsnumberStrandsChangednumberTurnsnumberTurnsChangedparallelPathsparallelPathsChangedphaseResistancephaseResistanceChangedpropertiesradiusCornerRectangularWireradiusCornerRectangularWireChangedsizeRectangularWiresizeRectangularWireChangedslotFillFactorslotFillFactorChangedstepColumnsstepRowsstrandsConductorwidthRectangularWirewidthRectangularWireChangedwindingChangedwindingModelwindingModelChangedwireDiameterwireDiameterAWGwireDiameterAWGChangedwireDiameterFillFactorwireDiameterFillFactorChangedwireDiameterRoundwireDiameterRoundChangedwireDiameterSWGwireDiameterSWGChangedwireLengthwireLengthChangedwireSizeAWGwireSizeAWGChangedwireSizeMethodwireSizeMethodChangedwireSizeSWGwireSizeSWGChanged