MotorXP-AFM Scripting API
    Preparing search index...

    Interface StatorElement

    StatorElement type

    interface StatorElement {
        conductorMaterial: string;
        conductorTemperature: number;
        countItems: number;
        innerDiameter: number;
        innerDiameterChanged: SignalConnector<number>;
        innerRadius: number;
        ironMaterial: string;
        ironMaterialChanged: SignalConnector<string>;
        ironStacking: number;
        ironStackingChanged: SignalConnector<number>;
        items: StatorElementItem[];
        nameScript: string;
        numberSlots: number;
        numberSlotsChanged: SignalConnector<number>;
        outerDiameter: number;
        outerDiameterChanged: SignalConnector<number>;
        outerRadius: number;
        script: string;
        scriptChanged: SignalConnector<string>;
        simDomain: SimDomain;
        simDomainChanged: SignalConnector<SimDomain>;
        simRadialOuterDomain: number;
        simRadialOuterDomainChanged: SignalConnector<number>;
        slotAngleSpan: number;
        typeMiddleItem: number;
        typeMiddleItemChanged: SignalConnector<number>;
        windingMaterial: string;
        windingMaterialChanged: SignalConnector<string>;
        windingTemperature: number;
        windingTemperatureChanged: SignalConnector<number>;
        appendError(text: string, separator?: string): void;
        appendWarning(text: string, separator?: string): void;
        changeProperty(propName: string, value: any): boolean;
        error(): string;
        isGeometryFromSTEP(): boolean;
        isLower(itemID: number): boolean;
        isMiddle(itemID: number): boolean;
        isTypeMiddleYoke(): boolean;
        isTypeMiddleYokeless(): boolean;
        isUpper(itemID: number): boolean;
        item(itemID: number): StatorElementItem;
        itemAngularDisplacement(itemID: number): number;
        rebuildGeometry(): void;
        setError(text: string): void;
        setErrorGeometry(text: string): void;
        setItemAngularDisplacement(itemID: number, angle: number): void;
        setWarning(text: string): void;
        warning(): string;
    }
    Index
    conductorMaterial conductorTemperature countItems innerDiameter innerDiameterChanged innerRadius ironMaterial ironMaterialChanged ironStacking ironStackingChanged items nameScript numberSlots numberSlotsChanged outerDiameter outerDiameterChanged outerRadius script scriptChanged simDomain simDomainChanged simRadialOuterDomain simRadialOuterDomainChanged slotAngleSpan typeMiddleItem typeMiddleItemChanged windingMaterial windingMaterialChanged windingTemperature windingTemperatureChanged
    appendError appendWarning changeProperty error isGeometryFromSTEP isLower isMiddle isTypeMiddleYoke isTypeMiddleYokeless isUpper item itemAngularDisplacement rebuildGeometry setError setErrorGeometry setItemAngularDisplacement setWarning warning
    conductorMaterial: string

    Stator conductor material.

    Read/Write

    conductorTemperature: number

    Stator conductor temperature in degrees Celsius.

    Read/Write

    countItems: number

    Number of stator elements; depends on motor.machineType.

    Read only

    innerDiameter: number

    Inner diameter

    Read/Write

    innerDiameterChanged: SignalConnector<number>

    Signal emitted when innerDiameter changes.

    Read

    innerRadius: number

    Inner radius.

    Read/Write

    ironMaterial: string

    Stator iron material.

    Read/Write

    ironMaterialChanged: SignalConnector<string>

    Signal emitted when ironMaterial changes.

    Read

    ironStacking: number

    Stator iron stacking factor.

    Read/Write

    ironStackingChanged: SignalConnector<number>

    Signal emitted when ironStacking changes.

    Read

    items: StatorElementItem[]

    Array of stator elements; the number of elements depends on motor.machineType.

    Read only

    nameScript: string

    Script name.

    Read only

    numberSlots: number

    Number of slots.

    Read/Write

    numberSlotsChanged: SignalConnector<number>

    Signal emitted when numberSlots changes.

    Read

    outerDiameter: number

    Outer diameter.

    Read/Write

    outerDiameterChanged: SignalConnector<number>

    Signal emitted when outerDiameter changes.

    Read

    outerRadius: number

    Outer radius.

    Read/Write

    script: string

    Script file name.

    Read only

    scriptChanged: SignalConnector<string>

    Signal emitted when script changes.

    Read

    simDomain: SimDomain

    Simulation domain.

    Read

    simDomainChanged: SignalConnector<SimDomain>

    Signal emitted when simDomain changes.

    Read

    simRadialOuterDomain: number

    Outer radius of the stator simulation domain.

    Read/Write

    simRadialOuterDomainChanged: SignalConnector<number>

    Signal emitted when simRadialOuterDomain changes.

    Read

    slotAngleSpan: number

    Angular span of one stator slot in degrees.

    Read only

    typeMiddleItem: number

    Middle stator type.

    Read/Write

    typeMiddleItemChanged: SignalConnector<number>

    Signal emitted when typeMiddleItem changes.

    Read

    windingMaterial: string

    Stator winding material.

    Read/Write

    windingMaterialChanged: SignalConnector<string>

    Signal emitted when windingMaterial changes.

    Read

    windingTemperature: number

    Stator winding temperature in degrees Celsius.

    Read/Write

    windingTemperatureChanged: SignalConnector<number>

    Signal emitted when windingTemperature changes.

    Read

    • Appends a script-defined stator 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 winding 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 stator geometry error.

      Returns string

      Error text.

    • True if the stator geometry was loaded from a STEP file.

      Returns boolean

      True if the stator geometry was loaded from a STEP file.

    • True if the stator element is the lower element of the motor.

      Parameters

      • itemID: number

        {number} - Stator element identifier.

      Returns boolean

      True if the stator element is the lower element of the motor.

    • True if the stator element is the middle element of the motor.

      Parameters

      • itemID: number

        {number} - Stator element identifier.

      Returns boolean

      True if the stator element is the middle element of the motor.

    • True if the middle stator element has a yoke.

      Returns boolean

      True if the middle stator element has a yoke.

    • True if the middle stator element has no yoke.

      Returns boolean

      True if the middle stator element has no yoke.

    • True if the stator element is the upper element of the motor.

      Parameters

      • itemID: number

        {number} - Stator element identifier.

      Returns boolean

      True if the stator element is the upper element of the motor.

    • Method type description.

      Parameters

      • itemID: number

        {number} - Stator element identifier.

      Returns StatorElementItem

      StatorElementItem object.

    • Angular displacement of the stator element in degrees.

      Parameters

      • itemID: number

        {number} - Stator element identifier.

      Returns number

      Angular displacement of the stator element in degrees.

    • Rebuilds the stator geometry.

      Returns void

      No return value.

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

      Parameters

      • text: string

        {string} - Error text.

      Returns void

      No return value.

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

      Parameters

      • text: string

        {string} - Error text.

      Returns void

      No return value.

      Use StatorElement.setError.

    • Sets the stator element angular displacement in degrees.

      Parameters

      • itemID: number

        {number} - Stator element identifier.

      • angle: number

        {number} - Stator element angular displacement.

      Returns void

      No return value.

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

      Parameters

      • text: string

        {string} - Warning text.

      Returns void

      No return value.

    • Current script-defined stator geometry warning.

      Returns string

      Warning text.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods