Public Member Functions | List of all members
WindingCoil Class Reference

WindingCoil class is used to specify the coil settings in winding setting.
The class can be created from WindingDefinition class.
. More...

Public Member Functions

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 coil 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...
 
double CorrectionFactor ()
 Returns the correction factor use for the resistance calculation. More...
 
double FilmThickness ()
 Returns the thickness of the insulating film around a wire. More...
 
String GetName ()
 Returns the name of the coil. More...
 
int GetPhaseIndex ()
 Returns the phase index of the coil. More...
 
int GetSerialGroupIndex ()
 Returns the serial group index of the coil. More...
 
Variant GetTable ()
 Returns the table of the coil. More...
 
String InputType ()
 Obtains the method used to specify the coil resistance. More...
 
double InsulationThickness ()
 Returns the thickness of the insulation layer lining the slot. More...
 
bool IsValid ()
 Returns True if an object is valid. More...
 
double LeakageInductance ()
 Returns the leakage inductance of the coil. More...
 
double MaxSlotFillFactor ()
 Returns the value of the maximum slot fill factor. More...
 
double Resistance ()
 Returns the coil resistance. 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 coil setting. More...
 
void SetInsulationThickness (Variant &value)
 Specifies the thickness of the insulation layer lining the slot. More...
 
void SetLeakageInductance (Variant &value)
 Specifies the leakage inductance of the coil. More...
 
void SetMaxFillFactor (Variant &value)
 Specifies the value of the maximum slot fill factor. More...
 
void SetName (String &name)
 Specifies the name of this coil. More...
 
void SetPhaseIndex (int index)
 Specifies the phase index of this coil. More...
 
void SetResistance (Variant &value)
 Specifies the coil resistance. More...
 
void SetSerialGroupIndex (int index)
 Specifies the phase index of this coil. 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 SetTable (String array &matrix)
 Specifies the table of this coil. More...
 
void SetTurns (Variant &value)
 Specifies the number of turns in the coil setting. 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 Strands ()
 Returns the number of strands in a single turn. More...
 
double Turn ()
 Returns the number of turns in the coil setting. 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

WindingCoil class is used to specify the coil settings in winding setting.
The class can be created from WindingDefinition class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetCoil(0)

Member Function Documentation

double WindingCoil::ActualResistance ( )

Returns the actual coil resistance.

Returns
Resistance value
double WindingCoil::ActualSlotFillFactor ( )

Returns the actual slot fill factor.

Returns
Slot fill factor
double WindingCoil::ActualTurn ( )

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

Returns
Number of turns
double WindingCoil::ActualWireDiameter ( )

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

Returns
Wire diameter
double WindingCoil::ActualWireHeight ( )

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

Returns
Wire height
double WindingCoil::ActualWireWidth ( )

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

Returns
Wire width
double WindingCoil::CorrectionFactor ( )

Returns the correction factor use for the resistance calculation.

Returns
Correcton factor
double WindingCoil::FilmThickness ( )

Returns the thickness of the insulating film around a wire.

Returns
Film thickness
String WindingCoil::GetName ( )

Returns the name of the coil.

Returns
Name of the coil
int WindingCoil::GetPhaseIndex ( )

Returns the phase index of the coil.

Returns
Index of the coil phase
int WindingCoil::GetSerialGroupIndex ( )

Returns the serial group index of the coil.

Returns
Index of the serial group
Variant WindingCoil::GetTable ( )

Returns the table of the coil.

Returns
Table of the coil
String WindingCoil::InputType ( )

Obtains the method used to specify the coil resistance.

TurnAndWireSize
TurnAndFillFactor
WireSizeAndFillFactor
Resistance: Phase resistance
Returns
A string giving the input type
double WindingCoil::InsulationThickness ( )

Returns the thickness of the insulation layer lining the slot.

Returns
Insulation thickness
bool WindingCoil::IsValid ( )

Returns True if an object is valid.

Returns
Whether or not the WindingCoil object is valid
double WindingCoil::LeakageInductance ( )

Returns the leakage inductance of the coil.

Returns
Leakage inductance
double WindingCoil::MaxSlotFillFactor ( )

Returns the value of the maximum slot fill factor.

Returns
Maximum slot fill factor
double WindingCoil::Resistance ( )

Returns the coil resistance.

Returns
Resistance value
void WindingCoil::SetCorrectionFactor ( Variant &  value)

Specifies the correction factor use for the resistance calculation.

Parameters
valueCorrecton factor
void WindingCoil::SetFilmThickness ( Variant &  value)

Specifies the thickness of the insulating film around a wire.

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

Specifies the method used to specify there resistance of the coil setting.

TurnAndWireSize
TurnAndFillFactor
WireSizeAndFillFactor
Resistance: Phase resistance
Parameters
typeMethod type
void WindingCoil::SetInsulationThickness ( Variant &  value)

Specifies the thickness of the insulation layer lining the slot.

Parameters
valueInsulation thickness
void WindingCoil::SetLeakageInductance ( Variant &  value)

Specifies the leakage inductance of the coil.

Parameters
valueLeakage inductance
void WindingCoil::SetMaxFillFactor ( Variant &  value)

Specifies the value of the maximum slot fill factor.

Parameters
valueMiximum slot fill factor
void WindingCoil::SetName ( String &  name)

Specifies the name of this coil.

Parameters
nameName of the coil
void WindingCoil::SetPhaseIndex ( int  index)

Specifies the phase index of this coil.

Parameters
indexIndex of the coil phase
void WindingCoil::SetResistance ( Variant &  value)

Specifies the coil resistance.

Parameters
valueResistance value
void WindingCoil::SetSerialGroupIndex ( int  index)

Specifies the phase index of this coil.

Parameters
indexIndex of the serial group
void WindingCoil::SetSlotFillFactor ( Variant &  value)

Specifies the slot fill factor.

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

Specifies the number of strands in a single turn.

Parameters
valueNumber of strands
void WindingCoil::SetTable ( String array &  matrix)

Specifies the table of this coil.

Parameters
matrixTable matrix
void WindingCoil::SetTurns ( Variant &  value)

Specifies the number of turns in the coil setting.

Parameters
valueNumber of turns
void WindingCoil::SetWireDiameter ( Variant &  value)

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

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

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

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

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

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

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

Parameters
valueWire width
double WindingCoil::SlotFillFactor ( )

Returns the slot fill factor.

Returns
Slot fill factor
int WindingCoil::Strands ( )

Returns the number of strands in a single turn.

Returns
Number of strands
double WindingCoil::Turn ( )

Returns the number of turns in the coil setting.

Returns
Number of turns
double WindingCoil::WireDiameter ( )

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

Returns
Wire diameter
double WindingCoil::WireHeight ( )

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

Returns
Wire height
String WindingCoil::WireType ( )

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

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

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

Returns
Wire width