Overview of the motor object¶
The built-in motor object represents a motor (generator) model with various parameters.
Properties of the motor object¶
Below is a list of the available properties provided by the motor object. Click on a property name to see its detailed description and examples.
| Property | Description |
|---|---|
| machineType | Type of machine. |
| stator | Returns a Stator object associated with the motor. |
| rotor | Returns a Rotor object associated with the motor. |
| airgap | Returns an Airgap object associated with the motor. |
| winding | Returns a Winding object associated with the motor. |
| mesh | Returns a Mesh object associated with the motor. |
Methods of the motor object¶
Below is a list of the available methods provided by the motor object. Click on a method name to see its detailed description and examples.
| Method | Description |
|---|---|
| isMachineSR() | true if the machine type is SR. |
| isMachineSRS() | true if the machine type is SRS. |
| isMachineSRSRS() | true if the machine type is SRSRS. |
| isMachineRSR() | true if the machine type is RSR. |
| isMachineRSRSR() | true if the machine type is RSRSR. |
| changeProperty() | Changes the value of a property. |
General Structure of the motor object¶
%%{
init: {
'securityLevel': 'loose'
}
}%%
graph LR
A[motor] --> B[Properties]
A --> C[Methods]
B --> B1["machineType"]
B --> B2["stator"]
B --> B3["rotor"]
B --> B4["airgap"]
B --> B5["winding"]
B --> B6["mesh"]
C --> C1["isMachineSR()"]
C --> C2["isMachineSRS()"]
C --> C3["isMachineSRSRS()"]
C --> C4["isMachineRSR()"]
C --> C5["isMachineRSRSR()"]
C --> C6["changeProperty()"]
click B "./props/index.html" "Go to properties" _blank
click C "./methods/index.html" "Go to methods" _blank
click B1 "./props/machineType.html" "View machineType" _blank
click B2 "./props/stator.html" "View stator" _blank
click B3 "./props/rotor.html" "View rotor" _blank
click B4 "./props/airgap.html" "View airgap" _blank
click B5 "./props/winding.html" "View winding" _blank
click B6 "./props/mesh.html" "View mesh" _blank
click C1 "./methods/isMachineSR.html" "View isMachineSR()" _blank
click C2 "./methods/isMachineSRS.html" "View isMachineSRS()" _blank
click C3 "./methods/isMachineSRSRS.html" "View isMachineSRSRS()" _blank
click C4 "./methods/isMachineRSR.html" "View isMachineRSR()" _blank
click C5 "./methods/isMachineRSRSR.html" "View isMachineRSRSR()" _blank
click C6 "./methods/changeProperty.html" "View changeProperty()" _blank
classDef clickable text-decoration:underline, cursor:pointer;
class B,C,B1,B2,B3,B4,B5,B6,C1,C2,C3,C4,C5,C6 clickable;