MotorXP-PM Scripting API
    Preparing search index...

    Interface MotorElement

    Built-in motor object (Document)

    interface MotorElement {
        airgap: number;
        airGap: number;
        airgapChanged: SignalConnector<number>;
        airgapMeshQuality: number;
        airgapMeshSlices: number;
        airgapNumberLayers: number;
        autoSizeBoundMesh: boolean;
        axialRotorSkew: number;
        axialStatorSkew: number;
        boundaryCondition: BoundaryCondition;
        boundaryConditionMode: BoundaryConditionMode;
        buildHousingInElectro: boolean;
        buildHousingInElectroChanged: SignalConnector<boolean>;
        buildShaftInElectro: boolean;
        buildShaftInElectroChanged: SignalConnector<boolean>;
        conductorMaterial: string;
        conductorTemperature: number;
        developerModeChanged: SignalConnector<boolean>;
        documentLoaded: SignalConnector;
        housing: HousingElement;
        laminationLength: number;
        laminationLengthChanged: SignalConnector<number>;
        machinePeriodicity: number;
        machineType: MachineType;
        machineTypeChanged: SignalConnector<MachineType>;
        mesh: MeshElement;
        numberMeshSlices: number;
        refineMeshInAirgap: boolean;
        rotor: RotorElement;
        rotorInnerDiameter: number;
        rotorInnerDiameterChanged: SignalConnector<number>;
        rotorInnerRadius: number;
        rotorIronMaterial: string;
        rotorIronStacking: number;
        rotorMagnetMaterial: string;
        rotorMagnetTemperature: number;
        rotorNumberPolePairs: number;
        rotorOuterDiameter: number;
        rotorOuterDiameterChanged: SignalConnector<number>;
        rotorOuterRadius: number;
        rotorScript: string;
        shaft: ShaftElement;
        sizeBoundMesh: number;
        stator: StatorElement;
        statorInnerDiameter: number;
        statorInnerDiameterChanged: SignalConnector<number>;
        statorInnerRadius: number;
        statorIronMaterial: string;
        statorIronStacking: number;
        statorNumberSlotLayers: number;
        statorNumberSlots: number;
        statorOuterDiameter: number;
        statorOuterDiameterChanged: SignalConnector<number>;
        statorOuterRadius: number;
        statorScript: string;
        statorSlotLayersOrientation: LayerOrientation;
        statorWindingMaterial: string;
        statorWindingTemperature: number;
        Tpm: number;
        Tsw: number;
        winding: WindingElement;
        changeProperty(propName: string, value: any): boolean;
        isInnerRotor(): boolean;
        isOuterRotor(): boolean;
        isStatorNumberSlotLayersDouble(): boolean;
        isStatorNumberSlotLayersSingle(): boolean;
        isStatorSlotLayerOrientationLeftRight(): boolean;
        isStatorSlotLayerOrientationUpperLower(): boolean;
        isStatorSlotLayersOrientationLeftRight(): boolean;
        isStatorSlotLayersOrientationUpperLower(): boolean;
    }
    Index

    Methods

    changeProperty isInnerRotor isOuterRotor isStatorNumberSlotLayersDouble isStatorNumberSlotLayersSingle isStatorSlotLayerOrientationLeftRight isStatorSlotLayerOrientationUpperLower isStatorSlotLayersOrientationLeftRight isStatorSlotLayersOrientationUpperLower

    Properties

    airgap airGap airgapChanged airgapMeshQuality airgapMeshSlices airgapNumberLayers autoSizeBoundMesh axialRotorSkew axialStatorSkew boundaryCondition boundaryConditionMode buildHousingInElectro buildHousingInElectroChanged buildShaftInElectro buildShaftInElectroChanged conductorMaterial conductorTemperature developerModeChanged documentLoaded housing laminationLength laminationLengthChanged machinePeriodicity machineType machineTypeChanged mesh numberMeshSlices refineMeshInAirgap rotor rotorInnerDiameter rotorInnerDiameterChanged rotorInnerRadius rotorIronMaterial rotorIronStacking rotorMagnetMaterial rotorMagnetTemperature rotorNumberPolePairs rotorOuterDiameter rotorOuterDiameterChanged rotorOuterRadius rotorScript shaft sizeBoundMesh stator statorInnerDiameter statorInnerDiameterChanged statorInnerRadius statorIronMaterial statorIronStacking statorNumberSlotLayers statorNumberSlots statorOuterDiameter statorOuterDiameterChanged statorOuterRadius statorScript statorSlotLayersOrientation statorWindingMaterial statorWindingTemperature Tpm Tsw winding

    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 rotor is inside the stator.

      Returns boolean

    • True if the rotor is outside the stator.

      Returns boolean

    • True if the stator winding has two layers.

      Returns boolean

    • True if the stator winding has one layer.

      Returns boolean

    • 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 if the winding layers are located side by side.

      Returns boolean

      Use MotorElement.isStatorSlotLayerOrientationLeftRight.

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

      Returns boolean

      Use MotorElement.isStatorSlotLayerOrientationUpperLower.

    Properties

    airgap: number

    Airgap length.

    Read only

    airGap: number

    Airgap length.

    Read only

    Use MotorElement.airgap.

    airgapChanged: SignalConnector<number>

    Signal emitted when the airgap changes.

    airgapMeshQuality: number

    Airgap mesh quality factor. Same as motor.mesh.airgapMeshQuality.

    airgapMeshSlices: number

    Number of mesh slices.

    Use MotorElement.numberMeshSlices.

    airgapNumberLayers: number

    Number of mesh layers in the airgap. Same as motor.mesh.airgapNumberLayers.

    autoSizeBoundMesh: boolean

    Automatic size of the mesh boundary elements. Same as motor.mesh.autoSizeBoundMesh.

    axialRotorSkew: number

    Rotor axial skew.

    Use motor.rotor.axialSkew.

    axialStatorSkew: number

    Stator axial skew.

    Use motor.stator.axialSkew.

    boundaryCondition: BoundaryCondition

    Boundary condition.

    boundaryConditionMode: BoundaryConditionMode

    Boundary condition mode.

    buildHousingInElectro: boolean

    Include the housing in the electromagnetic model.

    buildHousingInElectroChanged: SignalConnector<boolean>

    Signal emitted when buildHousingInElectro changes.

    buildShaftInElectro: boolean

    Include the shaft in the electromagnetic model.

    buildShaftInElectroChanged: SignalConnector<boolean>

    Signal emitted when buildShaftInElectro changes.

    conductorMaterial: string

    Conductor material name.

    conductorTemperature: number

    Conductor temperature.

    developerModeChanged: SignalConnector<boolean>

    Signal emitted when developer mode changes.

    documentLoaded: SignalConnector

    Signal emitted when the document is loaded.

    housing: HousingElement

    Returns a HousingElement object.

    Read only

    laminationLength: number

    Lamination (stack) length.

    laminationLengthChanged: SignalConnector<number>

    Signal emitted when the lamination length changes.

    machinePeriodicity: number

    Machine periodicity (number of periods in the full model).

    Read only

    machineType: MachineType

    Machine type. Use isInnerRotor() / isOuterRotor() for checks.

    Read/Write

    machineTypeChanged: SignalConnector<MachineType>

    Signal emitted when machineType changes. The argument is a MachineType object.

    mesh: MeshElement

    Returns a MeshElement object.

    Read only

    numberMeshSlices: number

    Number of mesh slices. Same as motor.mesh.numberMeshSlices.

    refineMeshInAirgap: boolean

    Refine the mesh in the airgap. Same as motor.mesh.refineMeshInAirgap.

    rotor: RotorElement

    Returns a RotorElement object.

    Read only

    rotorInnerDiameter: number

    Rotor inner diameter. Same as motor.rotor.innerDiameter.

    rotorInnerDiameterChanged: SignalConnector<number>

    Signal emitted when the rotor inner diameter changes.

    rotorInnerRadius: number

    Rotor inner radius. Same as motor.rotor.innerRadius.

    rotorIronMaterial: string

    Rotor iron material name.

    rotorIronStacking: number

    Rotor iron stacking factor.

    rotorMagnetMaterial: string

    Rotor magnet material name.

    rotorMagnetTemperature: number

    Rotor magnet temperature.

    rotorNumberPolePairs: number

    Number of rotor pole pairs. Same as motor.rotor.numberPolePairs.

    rotorOuterDiameter: number

    Rotor outer diameter. Same as motor.rotor.outerDiameter.

    rotorOuterDiameterChanged: SignalConnector<number>

    Signal emitted when the rotor outer diameter changes.

    rotorOuterRadius: number

    Rotor outer radius. Same as motor.rotor.outerRadius.

    rotorScript: string

    File name of the rotor script.

    shaft: ShaftElement

    Returns a ShaftElement object.

    Read only

    sizeBoundMesh: number

    Size of the mesh boundary elements. Same as motor.mesh.sizeBoundMesh.

    stator: StatorElement

    Returns a StatorElement object.

    Read only

    statorInnerDiameter: number

    Stator inner diameter. Same as motor.stator.innerDiameter.

    statorInnerDiameterChanged: SignalConnector<number>

    Signal emitted when the stator inner diameter changes.

    statorInnerRadius: number

    Stator inner radius. Same as motor.stator.innerRadius.

    statorIronMaterial: string

    Stator iron material name.

    statorIronStacking: number

    Stator iron stacking factor.

    statorNumberSlotLayers: number

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

    statorNumberSlots: number

    Number of stator slots. Same as motor.stator.numberSlots.

    statorOuterDiameter: number

    Stator outer diameter. Same as motor.stator.outerDiameter.

    statorOuterDiameterChanged: SignalConnector<number>

    Signal emitted when the stator outer diameter changes.

    statorOuterRadius: number

    Stator outer radius. Same as motor.stator.outerRadius.

    statorScript: string

    File name of the stator script.

    statorSlotLayersOrientation: LayerOrientation

    Orientation of winding layers in a slot.

    statorWindingMaterial: string

    Stator winding material name.

    statorWindingTemperature: number

    Stator winding temperature.

    Tpm: number

    Rotor magnet temperature (same as rotorMagnetTemperature).

    Tsw: number

    Stator winding temperature (same as statorWindingTemperature).

    winding: WindingElement

    Returns a WindingElement object.

    Read only

    Settings

    Member Visibility

    On This Page

    Methods
    Properties
    airgapairGapairgapChangedairgapMeshQualityairgapMeshSlicesairgapNumberLayersautoSizeBoundMeshaxialRotorSkewaxialStatorSkewboundaryConditionboundaryConditionModebuildHousingInElectrobuildHousingInElectroChangedbuildShaftInElectrobuildShaftInElectroChangedconductorMaterialconductorTemperaturedeveloperModeChangeddocumentLoadedhousinglaminationLengthlaminationLengthChangedmachinePeriodicitymachineTypemachineTypeChangedmeshnumberMeshSlicesrefineMeshInAirgaprotorrotorInnerDiameterrotorInnerDiameterChangedrotorInnerRadiusrotorIronMaterialrotorIronStackingrotorMagnetMaterialrotorMagnetTemperaturerotorNumberPolePairsrotorOuterDiameterrotorOuterDiameterChangedrotorOuterRadiusrotorScriptshaftsizeBoundMeshstatorstatorInnerDiameterstatorInnerDiameterChangedstatorInnerRadiusstatorIronMaterialstatorIronStackingstatorNumberSlotLayersstatorNumberSlotsstatorOuterDiameterstatorOuterDiameterChangedstatorOuterRadiusstatorScriptstatorSlotLayersOrientationstatorWindingMaterialstatorWindingTemperatureTpmTswwinding