Public Member Functions | List of all members
WindingDefinition Class Reference

WindingDefinition class is used to specify the winding setings.
The class can be called from the Study class.
. More...

Public Member Functions

double ActualInductance ()
 Returns the actual leakage inductance of the coil. More...
 
double ActualResistance ()
 Returns the actual coil resistance. More...
 
double ActualSlotFillFactor ()
 Returns the actual slot fill factor. More...
 
double ActualTurn ()
 Returns the actual number of turns in the coils of this winding. More...
 
double ActualWireDiameter ()
 Returns the actual diameter of the wire. Used for round wire types. More...
 
double ActualWireHeight ()
 Returns the actual height of the wire. Used for rectangle wire types. More...
 
double ActualWireWidth ()
 Returns the actual width of the wire. Used for rectangle wire types. More...
 
String AxialCoilConnection ()
 Returns the axial coil connection type of the winding. More...
 
int CoilPitch ()
 Returns the coil pitch for the automatic winding. More...
 
Variant CoilPitchValues ()
 Since this is an internal function, it is not officially supported. More...
 
String Component ()
 Returns the name of the circuit component associated with this winding. More...
 
double CorrectionFactor ()
 Returns the correction factor use for the resistance calculation. More...
 
int CreateCoil (String &name)
 Creates a coil. More...
 
void ExportCoilSetting (String &filename)
 Exports WindingCoil settings to a CSV file.
. More...
 
double FilmThickness ()
 Returns the thickness of the insulating film around a wire. More...
 
WindingCoilGetCoil (int index)
 Returns a WindingCoil object with the specified index.
. More...
 
Variant GetCoilTable (int phase)
 Returns the manual winding table for the specified phase. More...
 
String GetName ()
 Returns the name of the winding definition. More...
 
void ImportCoilSetting (String &filename)
 Imports WindingCoil settings from a CSV file.
. More...
 
String InputType ()
 Returns the method used to specify the winding resistance or the cage resistance. More...
 
double InsulationThickness ()
 Returns the thickness of the insulation layer lining the slot. More...
 
bool IsReversed ()
 Returns the value of the flag to reverse Go/Return. More...
 
bool IsValid ()
 Returns True if an object is valid. More...
 
bool KeepParallelConnectionBetweenCoilRegions ()
 Returns whether to keep parallel connections between coil regions. More...
 
int Layers ()
 Returns the number of layers for this winding definition. More...
 
double LeakageInductance ()
 Returns the leakage inductance of the coil or cage. More...
 
double LeakageInductanceCorrectionFactor ()
 Returns the correction factor for use for the leakage inductance calculation. More...
 
String LeakageInductanceInputType ()
 Returns the type of leakage inductance input type, either "Manual" or "Auto". More...
 
double LowerRingArea ()
 Returns the area of the lower end ring cross section. (for area sections) More...
 
double LowerRingAreaFactor ()
 Returns the correction factor for the resistance calculation of the lower end ring. More...
 
double LowerRingBottomWidth ()
 Returns the width at the bottom of the lower end ring cross section. (for trapezoid sections) More...
 
double LowerRingHeight ()
 Returns the height of the lower end ring cross section. More...
 
double LowerRingOffset ()
 Returns the radial offset of the lower end ring. More...
 
double LowerRingResistance ()
 Returns the resistance of the lower end ring. More...
 
String LowerRingSectionType ()
 Returns the section type for the lower cage end ring. Can be "Rectangle", "Trapezoid" or "AreaSection". More...
 
double LowerRingTopWidth ()
 Returns the width at the top of the lower end ring cross section. (for trapezoid sections) More...
 
double LowerRingWidth ()
 Returns the width of the lower end ring cross section. (for rectangular sections) More...
 
double MaxSlotFillFactor ()
 Returns the value of the maximum slot fill factor. More...
 
int NumCoils ()
 Returns the number of coils on the coils table. More...
 
int ParallelCoils ()
 Returns the number of parallel coils in the winding. More...
 
Variant ParallelNumberValues ()
 Since this is an internal function, it is not officially supported. More...
 
String PhaseOrder ()
 Returns the phase ordering for a 3-phase winding. More...
 
int Poles ()
 Returns the number of poles set in the winding region definition. More...
 
String Region ()
 Returns the name of the winding region definition linked to this winding. More...
 
void RemoveAllCoils ()
 Removes all coils from coil table.
 
void RemoveCoil (int index)
 Removes the coil with specified index from coil table. More...
 
double Resistance ()
 Returns the coil resistance. More...
 
bool SeparateConductorsIntoSeparateComponents ()
 Returns whether to separate conductors into separate components. More...
 
int SerialGroups ()
 Returns the number of serial groups. More...
 
void SetAxialCoilConnection (Variant &type)
 Specifies the axial coil connection for the winding. More...
 
void SetCoilPitch (Variant &value)
 Specifies the coil pitch for the automatic winding. More...
 
void SetCoilTable (int phase, String array &matrix)
 Specifies the manual winding table for the specified phase. The table is a 2-column table with go / return slots for each coil. More...
 
void SetComponent (Variant &component)
 Specifies the circuit component associated with this winding. More...
 
void SetCorrectionFactor (Variant &value)
 Specifies the correction factor use for the resistance calculation. More...
 
void SetFilmThickness (Variant &value)
 Specifies the thickness of the insulating film around a wire. More...
 
void SetInputType (Variant &type)
 Specifies the method used to specify there resistance of the winding or cage. More...
 
void SetInsulationThickness (Variant &value)
 Specifies the thickness of the insulation layer lining the slot. More...
 
void SetKeepParallelConnectionBetweenCoilRegions (bool keepParallel)
 Specifies whether to keep parallel connection between coil regions. More...
 
void SetLayers (Variant &type)
 Specifies the number of layers for this winding definition. More...
 
void SetLeakageInductance (Variant &value)
 Specifies the leakage inductance of the coil or cage. More...
 
void SetLeakageInductanceCorrectionFactor (Variant &value)
 Specifies the correction factor use for the leakage inductance calculation. More...
 
void SetLeakageInductanceInputType (Variant &type)
 Specifies the leakage inductance input type for this winding. Depending on the leakage inductance input type are "Manual" and "Auto". More...
 
void SetLowerRingArea (Variant &value)
 Specifies the area of the lower end ring cross section. (for area sections) More...
 
void SetLowerRingAreaFactor (Variant &value)
 Specifies the correction factor for the resistance calculation of the lower end ring. More...
 
void SetLowerRingBottomWidth (Variant &value)
 Specifies the width at the bottom of the lower end ring cross section. (for trapezoid sections) More...
 
void SetLowerRingHeight (Variant &value)
 Specifies the height of the lower end ring cross section. More...
 
void SetLowerRingOffset (Variant &value)
 Specifies the radial offset of the lower end ring. More...
 
void SetLowerRingResistance (Variant &value)
 Specifies the resistance of the lower end ring. More...
 
void SetLowerRingSectionType (Variant &type)
 Specifies the section type for the lower cage end ring. Can be "Rectangle", "Trapezoid" or "AreaSection". More...
 
void SetLowerRingTopWidth (Variant &value)
 Specifies the width at the top of the lower end ring cross section. (for trapezoid sections) More...
 
void SetLowerRingWidth (Variant &value)
 Specifies the width of the lower end ring cross section. (for rectangular sections) More...
 
void SetMaxFillFactor (Variant &value)
 Specifies the value of the maximum slot fill factor. More...
 
void SetName (String &name)
 Specifies the name of this winding definition. More...
 
void SetParallelCoils (Variant &type)
 Specifies the number of parallel coils in the winding. More...
 
void SetPhaseOrder (Variant &type)
 Specifies the phase ordering for a 3-phase winding. More...
 
void SetRegion (Variant &region)
 Sets the winding region definition where this winding will be located. More...
 
void SetResistance (Variant &value)
 Specifies the coil resistance. More...
 
void SetReverse (bool value)
 Specifies the value of the flag to reverse Go/Return. More...
 
void SetSeparateConductorsIntoSeparateComponents (bool separateConductors)
 Specifies whether to separate conductors into separate components. More...
 
void SetSerialGroups (Variant &value)
 Specifies the number of serial groups. More...
 
void SetSlotFillFactor (Variant &value)
 Specifies the slot fill factor. More...
 
void SetStrands (Variant &value)
 Specifies the number of strands in a single turn. More...
 
void SetTurns (Variant &value)
 Specifies the number of turns in the coils of this winding. More...
 
void SetUpperRingArea (Variant &value)
 Specifies the area of the upper end ring cross section. (for area sections) More...
 
void SetUpperRingAreaFactor (Variant &value)
 Specifies the correction factor for the resistance calculation of the upper end ring. More...
 
void SetUpperRingBottomWidth (Variant &value)
 Specifies the width at the bottom of the upper end ring cross section. (for trapezoid sections) More...
 
void SetUpperRingHeight (Variant &value)
 Specifies the height of the upper end ring cross section. More...
 
void SetUpperRingOffset (Variant &value)
 Specifies the radial offset of the upper end ring. More...
 
void SetUpperRingResistance (Variant &value)
 Specifies the resistance of the upper end ring. More...
 
void SetUpperRingSectionType (Variant &type)
 Specifies the section type for the upper cage end ring. Can be "Rectangle", "Trapezoid" or "AreaSection". More...
 
void SetUpperRingTopWidth (Variant &value)
 Specifies the width at the top of the upper end ring cross section. (for trapezoid sections) More...
 
void SetUpperRingWidth (Variant &value)
 Specifies the width of the upper end ring cross section. (for rectangular sections) More...
 
void SetUseMaximumPitch (bool value)
 Specifies the value of the flag to automatically use the maximum possible coil pitch. More...
 
void SetUsePropertiesPerCoil (bool value)
 Specifies the value of the flag to set properties per coil. More...
 
void SetWindingScheme (Variant &type)
 Specifies the winding scheme used for this winding. Depending on the winding type the schemes are "Auto", "ConcentratedWinding", "Manual", "Auto2" and "ConcentratedWinding2". More...
 
void SetWireDiameter (Variant &value)
 Specifies the diameter of the wire. Used for round wire types. More...
 
void SetWireHeight (Variant &value)
 Specifies the height of the wire. Used for rectangle wire types. More...
 
void SetWireType (Variant &type)
 Specifies the type of wire used, either "Rectangle" or "Round". More...
 
void SetWireWidth (Variant &value)
 Specifies the width of the wire. Used for rectangle wire types. More...
 
double SlotFillFactor ()
 Returns the slot fill factor. More...
 
int Slots ()
 Returns the number of slots for this winding. More...
 
int Strands ()
 Returns the number of strands in a single turn. More...
 
double Turn ()
 Returns the number of turns in the coils of this winding. More...
 
double UpperRingArea ()
 Returns the area of the upper end ring cross section. (for area sections) More...
 
double UpperRingAreaFactor ()
 Returns the correction factor for the resistance calculation of the upper end ring. More...
 
double UpperRingBottomWidth ()
 Returns the width at the bottom of the upper end ring cross section. (for trapezoid sections) More...
 
double UpperRingHeight ()
 Returns the height of the upper end ring cross section. More...
 
double UpperRingOffset ()
 Returns the radial offset of the upper end ring. More...
 
double UpperRingResistance ()
 Returns the resistance of the upper end ring. More...
 
String UpperRingSectionType ()
 Returns the section type for the upper cage end ring. Can be "Rectangle", "Trapezoid" or "AreaSection". More...
 
double UpperRingTopWidth ()
 Returns the width at the top of the upper end ring cross section. (for trapezoid sections) More...
 
double UpperRingWidth ()
 Returns the width of the upper end ring cross section. (for rectangular sections) More...
 
bool UseMaxCoilPitch ()
 Returns the value of the flag to automatically use the maximum possible coil pitch. More...
 
bool UsePropertiesPerCoil ()
 Returns the value of the flag to set properties per coil. More...
 
String WindingScheme ()
 Returns the winding scheme used for this winding. Depending on the winding type the schemes are "Auto", "ConcentratedWinding", "Manual", "Auto2" and "ConcentratedWinding2". More...
 
String WindingType ()
 Returns the type of winding ("ThreePhase", "MultiPhase", "Brush" or "Cage"). More...
 
double WireDiameter ()
 Returns the diameter of the wire. Used for round wire types. More...
 
double WireHeight ()
 Returns the height of the wire. Used for rectangle wire types. More...
 
String WireType ()
 Returns the type of wire used, either "Rectangle" or "Round". More...
 
double WireWidth ()
 Returns the width of the wire. Used for rectangle wire types. More...
 

Detailed Description

WindingDefinition class is used to specify the winding setings.
The class can be called from the Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetWinding(0)

Member Function Documentation

double WindingDefinition::ActualInductance ( )

Returns the actual leakage inductance of the coil.

Returns
Leakage inductance
double WindingDefinition::ActualResistance ( )

Returns the actual coil resistance.

Returns
Resistance value
double WindingDefinition::ActualSlotFillFactor ( )

Returns the actual slot fill factor.

Returns
Slot fill factor
double WindingDefinition::ActualTurn ( )

Returns the actual number of turns in the coils of this winding.

Returns
Number of turns
double WindingDefinition::ActualWireDiameter ( )

Returns the actual diameter of the wire. Used for round wire types.

Returns
Wire diameter
double WindingDefinition::ActualWireHeight ( )

Returns the actual height of the wire. Used for rectangle wire types.

Returns
Wire height
double WindingDefinition::ActualWireWidth ( )

Returns the actual width of the wire. Used for rectangle wire types.

Returns
Wire width
int WindingDefinition::AxialCoilConnection ( )

Returns the axial coil connection type of the winding.

Returns
Number of axial connection type
int WindingDefinition::CoilPitch ( )

Returns the coil pitch for the automatic winding.

Returns
Coil pitch
Variant WindingDefinition::CoilPitchValues ( )

Since this is an internal function, it is not officially supported.

Deprecated:
String WindingDefinition::Component ( )

Returns the name of the circuit component associated with this winding.

Returns
Name of the circuit component
double WindingDefinition::CorrectionFactor ( )

Returns the correction factor use for the resistance calculation.

Returns
Correction factor
int WindingDefinition::CreateCoil ( String &  name)

Creates a coil.

Parameters
nameCoil name
Returns
Index of coil
void WindingDefinition::ExportCoilSetting ( String &  filename)

Exports WindingCoil settings to a CSV file.
.

Parameters
filenameCSV file path
double WindingDefinition::FilmThickness ( )

Returns the thickness of the insulating film around a wire.

Returns
Film thickness
WindingCoil * WindingDefinition::GetCoil ( int  index)

Returns a WindingCoil object with the specified index.
.

Parameters
indexIndex of coil
Returns
WindingCoil object
Variant WindingDefinition::GetCoilTable ( int  phase)

Returns the manual winding table for the specified phase.

Parameters
phase
Returns
Winding table
String WindingDefinition::GetName ( )

Returns the name of the winding definition.

Returns
Name of the winding
void WindingDefinition::ImportCoilSetting ( String &  filename)

Imports WindingCoil settings from a CSV file.
.

Parameters
filenameCSV file path
String WindingDefinition::InputType ( )

Returns the method used to specify the winding resistance or the cage resistance.

*Winding
TurnAndWireSize
TurnAndFillFactor
WireSizeAndFillFactor
*Cage
CageResistance
SeparateResistances
Section
SeparateSections
Returns
A string giving the input type
double WindingDefinition::InsulationThickness ( )

Returns the thickness of the insulation layer lining the slot.

Returns
Insulation thickness
bool WindingDefinition::IsReversed ( )

Returns the value of the flag to reverse Go/Return.

Returns
The flag to reverse Go/Return
bool WindingDefinition::IsValid ( )

Returns True if an object is valid.

Returns
Whether or not the WindingDefinition object is valid
bool WindingDefinition::KeepParallelConnectionBetweenCoilRegions ( )

Returns whether to keep parallel connections between coil regions.

Returns
Whether to keep parallel connections between coil regions.
int WindingDefinition::Layers ( )

Returns the number of layers for this winding definition.

Returns
Number of layers
double WindingDefinition::LeakageInductance ( )

Returns the leakage inductance of the coil or cage.

Returns
Leakage inductance
double WindingDefinition::LeakageInductanceCorrectionFactor ( )

Returns the correction factor for use for the leakage inductance calculation.

Returns
Leakage inductance correction factor
String WindingDefinition::LeakageInductanceInputType ( )

Returns the type of leakage inductance input type, either "Manual" or "Auto".

Manual
Auto
Returns
A string giving the leakage inductance input type
double WindingDefinition::LowerRingArea ( )

Returns the area of the lower end ring cross section. (for area sections)

Returns
Area
double WindingDefinition::LowerRingAreaFactor ( )

Returns the correction factor for the resistance calculation of the lower end ring.

Returns
Correction factor
double WindingDefinition::LowerRingBottomWidth ( )

Returns the width at the bottom of the lower end ring cross section. (for trapezoid sections)

Returns
End ring width
double WindingDefinition::LowerRingHeight ( )

Returns the height of the lower end ring cross section.

Returns
End ring height
double WindingDefinition::LowerRingOffset ( )

Returns the radial offset of the lower end ring.

Returns
Offset value
double WindingDefinition::LowerRingResistance ( )

Returns the resistance of the lower end ring.

Returns
Resistance value
String WindingDefinition::LowerRingSectionType ( )

Returns the section type for the lower cage end ring. Can be "Rectangle", "Trapezoid" or "AreaSection".

Rectangle
Trapezoid
AreaSection
Returns
Section type
double WindingDefinition::LowerRingTopWidth ( )

Returns the width at the top of the lower end ring cross section. (for trapezoid sections)

Returns
End ring width
double WindingDefinition::LowerRingWidth ( )

Returns the width of the lower end ring cross section. (for rectangular sections)

Returns
End ring width
double WindingDefinition::MaxSlotFillFactor ( )

Returns the value of the maximum slot fill factor.

Returns
Maximum slot fill factor
int WindingDefinition::NumCoils ( )

Returns the number of coils on the coils table.

Returns
Number of coils
int WindingDefinition::ParallelCoils ( )

Returns the number of parallel coils in the winding.

Returns
Number of parallel coils
Variant WindingDefinition::ParallelNumberValues ( )

Since this is an internal function, it is not officially supported.

Deprecated:
String WindingDefinition::PhaseOrder ( )

Returns the phase ordering for a 3-phase winding.

Returns
A string either "UVW" or "UWV"
int WindingDefinition::Poles ( )

Returns the number of poles set in the winding region definition.

Returns
Number of poles
String WindingDefinition::Region ( )

Returns the name of the winding region definition linked to this winding.

Returns
Name of the winding region
void WindingDefinition::RemoveCoil ( int  index)

Removes the coil with specified index from coil table.

Parameters
valIndex of coil
double WindingDefinition::Resistance ( )

Returns the coil resistance.

Returns
Resistance value
bool WindingDefinition::SeparateConductorsIntoSeparateComponents ( )

Returns whether to separate conductors into separate components.

Returns
Whether to separate conductors into separate components.
int WindingDefinition::SerialGroups ( )

Returns the number of serial groups.

Returns
Number of serial groups
void WindingDefinition::SetAxialCoilConnection ( Variant &  type)

Specifies the axial coil connection for the winding.

Series
Parallel
Parameters
typeA string giving the axial coil connection type
void WindingDefinition::SetCoilPitch ( Variant &  value)

Specifies the coil pitch for the automatic winding.

Parameters
valueCoil pitch
void WindingDefinition::SetCoilTable ( int  phase,
String array &  matrix 
)

Specifies the manual winding table for the specified phase. The table is a 2-column table with go / return slots for each coil.

Parameters
phase
matrix
void WindingDefinition::SetComponent ( Variant &  component)

Specifies the circuit component associated with this winding.

Parameters
componentName or index of the winding circuit component
void WindingDefinition::SetCorrectionFactor ( Variant &  value)

Specifies the correction factor use for the resistance calculation.

Parameters
valueCorrection factor
void WindingDefinition::SetFilmThickness ( Variant &  value)

Specifies the thickness of the insulating film around a wire.

Parameters
valueFilm thickness
void WindingDefinition::SetInputType ( Variant &  type)

Specifies the method used to specify there resistance of the winding or cage.

*Winding
TurnAndWireSize
TurnAndFillFactor
WireSizeAndFillFactor
*Cage
CageResistance
SeparateResistances
Section
SeparateSections
void WindingDefinition::SetInsulationThickness ( Variant &  value)

Specifies the thickness of the insulation layer lining the slot.

Parameters
valueInsulation thickness
void WindingDefinition::SetKeepParallelConnectionBetweenCoilRegions ( bool  keepParallel)

Specifies whether to keep parallel connection between coil regions.

True=1 : Keeps parallel connection between coil regions
False=0 : Does not keep parallel connection between coil regions
Parameters
keepParallel
void WindingDefinition::SetLayers ( Variant &  type)

Specifies the number of layers for this winding definition.

Parameters
layersNumber of layers
void WindingDefinition::SetLeakageInductance ( Variant &  value)

Specifies the leakage inductance of the coil or cage.

Parameters
valueLeakage inductance
void WindingDefinition::SetLeakageInductanceCorrectionFactor ( Variant &  value)

Specifies the correction factor use for the leakage inductance calculation.

Parameters
valueLeakage inductance correction factor
void WindingDefinition::SetLeakageInductanceInputType ( Variant &  type)

Specifies the leakage inductance input type for this winding. Depending on the leakage inductance input type are "Manual" and "Auto".

Manual
Auto
Parameters
typeA string giving the leakage inductance input type
void WindingDefinition::SetLowerRingArea ( Variant &  value)

Specifies the area of the lower end ring cross section. (for area sections)

Parameters
valueArea
void WindingDefinition::SetLowerRingAreaFactor ( Variant &  value)

Specifies the correction factor for the resistance calculation of the lower end ring.

Parameters
valueCorrection factor
void WindingDefinition::SetLowerRingBottomWidth ( Variant &  value)

Specifies the width at the bottom of the lower end ring cross section. (for trapezoid sections)

Parameters
valueWidth
void WindingDefinition::SetLowerRingHeight ( Variant &  value)

Specifies the height of the lower end ring cross section.

Parameters
valueEnd ring height
void WindingDefinition::SetLowerRingOffset ( Variant &  value)

Specifies the radial offset of the lower end ring.

Parameters
valueOffset value
void WindingDefinition::SetLowerRingResistance ( Variant &  value)

Specifies the resistance of the lower end ring.

Parameters
valueResistance value
void WindingDefinition::SetLowerRingSectionType ( Variant &  type)

Specifies the section type for the lower cage end ring. Can be "Rectangle", "Trapezoid" or "AreaSection".

Rectangle
Trapezoid
AreaSection
Parameters
typeSection type
void WindingDefinition::SetLowerRingTopWidth ( Variant &  value)

Specifies the width at the top of the lower end ring cross section. (for trapezoid sections)

Parameters
valueWidth
void WindingDefinition::SetLowerRingWidth ( Variant &  value)

Specifies the width of the lower end ring cross section. (for rectangular sections)

Parameters
valueEnd ring width
void WindingDefinition::SetMaxFillFactor ( Variant &  value)

Specifies the value of the maximum slot fill factor.

Parameters
valueSlot fill factor
void WindingDefinition::SetName ( String &  name)

Specifies the name of this winding definition.

Parameters
nameName of the winding definition
void WindingDefinition::SetParallelCoils ( Variant &  type)

Specifies the number of parallel coils in the winding.

Parameters
numberNumber of parallel coils
void WindingDefinition::SetPhaseOrder ( Variant &  type)

Specifies the phase ordering for a 3-phase winding.

Parameters
typeA string either "UVW" or "UWV"
void WindingDefinition::SetRegion ( Variant &  region)

Sets the winding region definition where this winding will be located.

Parameters
regionName or index of the winding region definition
void WindingDefinition::SetResistance ( Variant &  value)

Specifies the coil resistance.

Parameters
valueResistance value
void WindingDefinition::SetReverse ( bool  value)

Specifies the value of the flag to reverse Go/Return.

True=1 : Reverses Go/Return
False=0 : Does not reverse Go/Return
Parameters
value
void WindingDefinition::SetSeparateConductorsIntoSeparateComponents ( bool  separateConductors)

Specifies whether to separate conductors into separate components.

True=1 : Separates conductors into separate components
False=0 : Does not separate conductors into separate components
Parameters
separateConductors
void WindingDefinition::SetSerialGroups ( Variant &  value)

Specifies the number of serial groups.

Parameters
valueThe number of serial groups
void WindingDefinition::SetSlotFillFactor ( Variant &  value)

Specifies the slot fill factor.

Parameters
valueSlot fill factor
void WindingDefinition::SetStrands ( Variant &  value)

Specifies the number of strands in a single turn.

Parameters
valueNumber of strands
void WindingDefinition::SetTurns ( Variant &  value)

Specifies the number of turns in the coils of this winding.

Parameters
valueNumber of turns
void WindingDefinition::SetUpperRingArea ( Variant &  value)

Specifies the area of the upper end ring cross section. (for area sections)

Parameters
valueArea
void WindingDefinition::SetUpperRingAreaFactor ( Variant &  value)

Specifies the correction factor for the resistance calculation of the upper end ring.

Parameters
valueCorrection factor
void WindingDefinition::SetUpperRingBottomWidth ( Variant &  value)

Specifies the width at the bottom of the upper end ring cross section. (for trapezoid sections)

Parameters
valueWidth
void WindingDefinition::SetUpperRingHeight ( Variant &  value)

Specifies the height of the upper end ring cross section.

Parameters
valueEnd ring height
void WindingDefinition::SetUpperRingOffset ( Variant &  value)

Specifies the radial offset of the upper end ring.

Parameters
valueOffset value
void WindingDefinition::SetUpperRingResistance ( Variant &  value)

Specifies the resistance of the upper end ring.

Parameters
valueResistance value
void WindingDefinition::SetUpperRingSectionType ( Variant &  type)

Specifies the section type for the upper cage end ring. Can be "Rectangle", "Trapezoid" or "AreaSection".

Rectangle
Trapezoid
AreaSection
Parameters
typeSection type
void WindingDefinition::SetUpperRingTopWidth ( Variant &  value)

Specifies the width at the top of the upper end ring cross section. (for trapezoid sections)

Parameters
valueWidth
void WindingDefinition::SetUpperRingWidth ( Variant &  value)

Specifies the width of the upper end ring cross section. (for rectangular sections)

Parameters
valueEnd ring width
void WindingDefinition::SetUseMaximumPitch ( bool  value)

Specifies the value of the flag to automatically use the maximum possible coil pitch.

Parameters
valueMaximum coil pitch flag
void WindingDefinition::SetUsePropertiesPerCoil ( bool  value)

Specifies the value of the flag to set properties per coil.

True=1 : Sets properties per coil
False=0 : Does not set properties per coil
Parameters
value
void WindingDefinition::SetWindingScheme ( Variant &  type)

Specifies the winding scheme used for this winding. Depending on the winding type the schemes are "Auto", "ConcentratedWinding", "Manual", "Auto2" and "ConcentratedWinding2".

Auto: Auto (Type 1)
ConcentratedWinding: Concentrated Winding (Type 1)
Manual
Auto2: Auto (Type 2)
ConcentratedWinding2: Concentrated Winding (Type 2)
Parameters
typeA string giving the winding scheme
void WindingDefinition::SetWireDiameter ( Variant &  value)

Specifies the diameter of the wire. Used for round wire types.

Parameters
valueWire diameter
void WindingDefinition::SetWireHeight ( Variant &  value)

Specifies the height of the wire. Used for rectangle wire types.

Parameters
valueWire height
void WindingDefinition::SetWireType ( Variant &  type)

Specifies the type of wire used, either "Rectangle" or "Round".

Rectangle
Round
Parameters
typeA string giving the wire type
void WindingDefinition::SetWireWidth ( Variant &  value)

Specifies the width of the wire. Used for rectangle wire types.

Parameters
valueWire width
double WindingDefinition::SlotFillFactor ( )

Returns the slot fill factor.

Returns
Slot fill factor
int WindingDefinition::Slots ( )

Returns the number of slots for this winding.

Returns
Number of slots
int WindingDefinition::Strands ( )

Returns the number of strands in a single turn.

Returns
Number of strands
double WindingDefinition::Turn ( )

Returns the number of turns in the coils of this winding.

Returns
Number of turns
double WindingDefinition::UpperRingArea ( )

Returns the area of the upper end ring cross section. (for area sections)

Returns
Area
double WindingDefinition::UpperRingAreaFactor ( )

Returns the correction factor for the resistance calculation of the upper end ring.

Returns
Correction factor
double WindingDefinition::UpperRingBottomWidth ( )

Returns the width at the bottom of the upper end ring cross section. (for trapezoid sections)

Returns
End ring width
double WindingDefinition::UpperRingHeight ( )

Returns the height of the upper end ring cross section.

Returns
End ring height
double WindingDefinition::UpperRingOffset ( )

Returns the radial offset of the upper end ring.

Returns
Offset value
double WindingDefinition::UpperRingResistance ( )

Returns the resistance of the upper end ring.

Returns
Resistance value
String WindingDefinition::UpperRingSectionType ( )

Returns the section type for the upper cage end ring. Can be "Rectangle", "Trapezoid" or "AreaSection".

Rectangle
Trapezoid
AreaSection
Returns
Section type
double WindingDefinition::UpperRingTopWidth ( )

Returns the width at the top of the upper end ring cross section. (for trapezoid sections)

Returns
End ring width
double WindingDefinition::UpperRingWidth ( )

Returns the width of the upper end ring cross section. (for rectangular sections)

Returns
End ring width
bool WindingDefinition::UseMaxCoilPitch ( )

Returns the value of the flag to automatically use the maximum possible coil pitch.

Returns
The maximum coil pitch flag
bool WindingDefinition::UsePropertiesPerCoil ( )

Returns the value of the flag to set properties per coil.

Returns
The flag to set properties per coil
String WindingDefinition::WindingScheme ( )

Returns the winding scheme used for this winding. Depending on the winding type the schemes are "Auto", "ConcentratedWinding", "Manual", "Auto2" and "ConcentratedWinding2".

Auto: Auto (Type 1)
ConcentratedWinding: Concentrated Winding (Type 1)
Manual
Auto2: Auto (Type 2)
ConcentratedWinding2: Concentrated Winding (Type 2)
Returns
A string giving the winding scheme
String WindingDefinition::WindingType ( )

Returns the type of winding ("ThreePhase", "MultiPhase", "Brush" or "Cage").

ThreePhase
MultiPhase
Brush
Cage
Returns
A string giving the typeof winding
double WindingDefinition::WireDiameter ( )

Returns the diameter of the wire. Used for round wire types.

Returns
Wire diameter
double WindingDefinition::WireHeight ( )

Returns the height of the wire. Used for rectangle wire types.

Returns
Wire height
String WindingDefinition::WireType ( )

Returns the type of wire used, either "Rectangle" or "Round".

Rectangle
Round
Returns
A string giving the wire type
double WindingDefinition::WireWidth ( )

Returns the width of the wire. Used for rectangle wire types.

Returns
Wire width