MotorXP-AFM Scripting API
    Preparing search index...

    Variable motorConst

    motor: {
        airgap: AirgapElement;
        debugMode: boolean;
        debugModeChanged: SignalConnector<boolean>;
        developerMode: boolean;
        developerModeChanged: SignalConnector<boolean>;
        machineType: Motor;
        machineTypeChanged: SignalConnector<any>;
        mesh: MeshElement;
        rotor: RotorElement;
        stator: StatorElement;
        winding: WindingElement;
        changeProperty(propName: string, value: any): boolean;
        isMachineRSR(): boolean;
        isMachineRSRSR(): boolean;
        isMachineSR(): boolean;
        isMachineSRS(): boolean;
        isMachineSRSRS(): boolean;
        setConfigVariable(propName: string, value: any): void;
    }

    Built-in motor object

    Type Declaration

    • Readonlyairgap: AirgapElement

      Returns an object; its type is unspecified here.

      Read only

    • ReadonlydebugMode: boolean

      Returns whether developer mode is enabled in DS.

      Read only

      Use developerMode.

    • debugModeChanged: SignalConnector<boolean>

      Signal emitted when debug mode changes.

      Read

    • ReadonlydeveloperMode: boolean

      Returns whether developer mode is enabled in DS.

      Read only

    • developerModeChanged: SignalConnector<boolean>

      Signal emitted when developer mode changes.

      Read

    • machineType: Motor

      The machineType property defines the configuration type of the motor.

      Read/Write

    • machineTypeChanged: SignalConnector<any>

      Signal emitted when machineType changes. The argument is a MachineType object, not a number; read motor.machineType for comparisons.

      Read

    • Readonlymesh: MeshElement

      Returns a MeshElement object.

      Read only

    • Readonlyrotor: RotorElement

      Returns a RotorElement object.

      Read only

    • Readonlystator: StatorElement

      Returns a StatorElement object.

      Read only

    • Readonlywinding: WindingElement

      Returns a WindingElement object.

      Read only

    • changeProperty: function

      • 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.

    • isMachineRSR: function

      • True if the machine type is RSR.

        Returns boolean

        True if the machine type is RSR.

    • isMachineRSRSR: function

      • True if the machine type is RSRSR.

        Returns boolean

        True if the machine type is RSRSR.

    • isMachineSR: function

      • True if the machine type is SR.

        Returns boolean

        True if the machine type is SR.

    • isMachineSRS: function

      • True if the machine type is SRS.

        Returns boolean

        True if the machine type is SRS.

    • isMachineSRSRS: function

      • True if the machine type is SRSRS.

        Returns boolean

        True if the machine type is SRSRS.

    • setConfigVariable: function

      • Sets a motor configuration variable.

        Parameters

        • propName: string

          Variable name.

        • value: any

          Variable value.

        Returns void

        No return value.

    Settings
    Member Visibility