MotorXP-AFM Scripting API
    Preparing search index...

    Interface RotorElement

    RotorElement type

    interface RotorElement {
        conductorMaterial: string;
        conductorMaterialChanged: SignalConnector<string>;
        conductorTemperature: number;
        conductorTemperatureChanged: SignalConnector<number>;
        countItems: number;
        innerDiameter: number;
        innerDiameterChanged: SignalConnector<number>;
        innerRadius: number;
        ironMaterial: string;
        ironMaterialChanged: SignalConnector<string>;
        ironStacking: number;
        ironStackingChanged: SignalConnector<number>;
        items: RotorElementItem[];
        magnetMaterial: string;
        magnetMaterialChanged: SignalConnector<string>;
        magnetSegmentsRadialDirection: number;
        magnetSegmentsRadialDirectionChanged: SignalConnector<number>;
        magnetTemperature: number;
        magnetTemperatureChanged: SignalConnector<number>;
        nameScript: string;
        numberPolePairs: number;
        numberPolePairsChanged: SignalConnector<number>;
        outerDiameter: number;
        outerDiameterChanged: SignalConnector<number>;
        outerRadius: number;
        poleAngleSpan: number;
        poleArrangement: number;
        poleArrangementChanged: SignalConnector<number>;
        script: string;
        scriptChanged: SignalConnector<string>;
        simDomain: SimDomain;
        simRadialOuterDomain: number;
        typeMiddleItem: number;
        typeMiddleItemChanged: 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): RotorElementItem;
        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 conductorMaterialChanged conductorTemperature conductorTemperatureChanged countItems innerDiameter innerDiameterChanged innerRadius ironMaterial ironMaterialChanged ironStacking ironStackingChanged items magnetMaterial magnetMaterialChanged magnetSegmentsRadialDirection magnetSegmentsRadialDirectionChanged magnetTemperature magnetTemperatureChanged nameScript numberPolePairs numberPolePairsChanged outerDiameter outerDiameterChanged outerRadius poleAngleSpan poleArrangement poleArrangementChanged script scriptChanged simDomain simRadialOuterDomain typeMiddleItem typeMiddleItemChanged
    appendError appendWarning changeProperty error isGeometryFromSTEP isLower isMiddle isTypeMiddleYoke isTypeMiddleYokeless isUpper item itemAngularDisplacement rebuildGeometry setError setErrorGeometry setItemAngularDisplacement setWarning warning
    conductorMaterial: string

    Rotor conductor material.

    Read/Write

    conductorMaterialChanged: SignalConnector<string>

    Signal emitted when conductorMaterial changes.

    Read

    conductorTemperature: number

    Rotor conductor temperature in degrees Celsius.

    Read/Write

    conductorTemperatureChanged: SignalConnector<number>

    Signal emitted when conductorTemperature changes.

    Read

    countItems: number

    Number of rotor elements; depends on motor.machineType.

    Read only

    innerDiameter: number

    Inner diameter

    Read/Write

    innerDiameterChanged: SignalConnector<number>

    Signal emitted when the inner diameter changes.

    Read

    innerRadius: number

    Inner radius

    Read/Write

    ironMaterial: string

    Rotor iron material

    Read/Write

    ironMaterialChanged: SignalConnector<string>

    Signal emitted when ironMaterial changes.

    Read

    ironStacking: number

    Rotor iron stacking factor.

    Read/Write

    ironStackingChanged: SignalConnector<number>

    Signal emitted when ironStacking changes.

    Read

    items: RotorElementItem[]

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

    Read only

    magnetMaterial: string

    Rotor magnet material.

    Read/Write

    magnetMaterialChanged: SignalConnector<string>

    Signal emitted when magnetMaterial changes.

    Read

    magnetSegmentsRadialDirection: number

    Number of radial magnet segments.

    Read/Write

    magnetSegmentsRadialDirectionChanged: SignalConnector<number>

    Signal emitted when magnetSegmentsRadialDirection changes.

    Read

    magnetTemperature: number

    Rotor magnet temperature in degrees Celsius.

    Read/Write

    magnetTemperatureChanged: SignalConnector<number>

    Signal emitted when magnetTemperature changes.

    Read

    nameScript: string

    Script name

    Read only

    numberPolePairs: number

    Number of pole pairs.

    Read/Write

    numberPolePairsChanged: SignalConnector<number>

    Signal emitted when the number of pole pairs changes.

    Read

    outerDiameter: number

    Outer diameter.

    Read/Write

    outerDiameterChanged: SignalConnector<number>

    Signal emitted when the outer diameter changes.

    Read

    outerRadius: number

    Outer radius.

    Read/Write

    poleAngleSpan: number

    Angular span of one rotor pole in degrees.

    Read only

    poleArrangement: number

    Pole arrangement

    Read/Write

    poleArrangementChanged: SignalConnector<number>

    Signal emitted when poleArrangement changes.

    Read

    script: string

    Script file name

    Read only

    scriptChanged: SignalConnector<string>

    Signal emitted when script changes.

    Read

    simDomain: SimDomain

    Simulation domain.

    Read

    simRadialOuterDomain: number

    Outer radius of the rotor simulation domain.

    Read only

    typeMiddleItem: number

    Middle rotor type.

    Read/Write

    typeMiddleItemChanged: SignalConnector<number>

    Signal emitted when typeMiddleItem changes.

    Read

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

      Returns string

      Error text.

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

      Returns boolean

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

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

      Parameters

      • itemID: number

        {number} - Rotor element identifier.

      Returns boolean

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

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

      Parameters

      • itemID: number

        {number} - Rotor element identifier.

      Returns boolean

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

    • True if the middle rotor element has a yoke.

      Returns boolean

      True if the middle rotor element has a yoke.

    • True if the middle rotor element has no yoke.

      Returns boolean

      True if the middle rotor element has no yoke.

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

      Parameters

      • itemID: number

        {number} - Rotor element identifier.

      Returns boolean

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

    • Method type description.

      Parameters

      • itemID: number

        {number} - Rotor element identifier.

      Returns RotorElementItem

      RotorElementItem object.

    • Angular displacement of the rotor element in degrees.

      Parameters

      • itemID: number

        {number} - Rotor element identifier.

      Returns number

      Angular displacement of the rotor element in degrees.

    • Rebuilds the rotor geometry.

      Returns void

      No return value.

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

      Parameters

      • text: string

        {string} - Error text.

      Returns void

      No return value.

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

      Parameters

      • text: string

        {string} - Error text.

      Returns void

      No return value.

      Use RotorElement.setError.

    • Sets the rotor element angular displacement in degrees.

      Parameters

      • itemID: number

        {number} - Rotor element identifier.

      • angle: number

        {number} - Rotor element angular displacement.

      Returns void

      No return value.

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

      Parameters

      • text: string

        {string} - Warning text.

      Returns void

      No return value.

    • Current script-defined rotor geometry warning.

      Returns string

      Warning text.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods