Rotor Type Description¶
The built-in Rotor type is a composite part of the engine and describes the properties of the motor rotor.
Constants of Type Rotor¶
Rotor MiddleType¶
| Constant | Description | Value |
|---|---|---|
Rotor.MiddleYoke |
Middle part of the rotor with yoke | 1 |
Rotor.MiddleYokeless |
Middle part of the rotor without yoke | 2 |
Rotor.Yoke |
Middle part of the rotor with yoke (outdated) | 1 |
Rotor.Yokeless |
Middle part of the rotor without yoke (outdated) | 2 |
Properties of type Rotor¶
Below is a list of the available properties provided by the Rotor type. Click on a property name to see its detailed description and examples.
| Property | Description |
|---|---|
| outerDiameter | Outer diameter. |
| outerRadius | Outer radius. |
| innerDiameter | Inner diameter. |
| innerRadius | Inner radius. |
| numberPolePairs | Number of pole pairs. |
| poleAngleSpan | Angle span of one pole of the rotor in degrees. |
| poleArrangement | Pole arrangement. |
| typeMiddleItem | Type of middle part of the rotor. |
| countItems | Count of elements of the rotor. |
| items | Array of elements of the rotor. |
| nameScript | Name of script. |
| script | Name of script file. |
| ironMaterial | Iron material of the rotor. |
| ironStacking | Iron stacking coefficient of the rotor. |
| magnetMaterial | Magnet material of the rotor. |
| magnetTemperature | Magnet temperature of the rotor. |
| conductorMaterial | Conductor material of the rotor. |
| conductorTemperature | Conductor temperature of the rotor. |
Methods of type Rotor¶
Below is a list of the available methods provided by the Rotor type. Click on a method name to see its detailed description and examples.
| Method | Description |
|---|---|
| isLower() | Returns true if the rotor element is lower. |
| isMiddle() | Returns true if the rotor element is middle. |
| isUpper() | Returns true if the rotor element is upper. |
| isTypeMiddleYoke() | Returns true if the middle rotor element has a yoke. |
| isTypeMiddleYokeless() | Returns true if the middle rotor element does not have a yoke. |
| item() | Returns the rotor element. |
| itemAngularDisplacement() | Returns the angular displacement of the rotor element. |
| setItemAngularDisplacement() | Sets the angular displacement of the rotor element. |
| changeProperty() | Changes the value of a property. |
| rebuildGeometry() | Rebuilds the rotor geometry. |
| setErrorGeometry() | Sets an error in the script geometry. |
See Also