WindingRegion class is used to specify the location of the slots and geometry for the winding.
The class can be called from the Study class.
. More...

Public Member Functions
void	AddCoilRegion (String &name)
	Adds a coil region with the specified name. More...

void	AddPart (int layer, Variant &val)
	Adds a part to the specified layer for the reference slot of the winding region. More...

void	AddSelected (int layer, Selection *selection)
	Adds a selection to the specified layer for the reference slot of the winding region. More...

void	AddSet (int layer, Set *set)
	Adds a Set object to the specified layer for the reference slot of the winding region. More...

void	ClearParts ()
	Clears all selected parts for the winding region.

int	CoilGroupSize ()
	Returns the number of coil groups in the case of winding region (coil template). More...

String	CoilTemplate ()
	Returns a coil template name in the case of winding region (coil template). More...

void	DeleteCoilRegion (String &name)
	Deletes a coil region with the specified name. More...

bool	DetectFromGeometry ()
	Returns True as the return value in the case detecting coil 2 region automatically from coil 1 region. More...

Selection *	GetAllSlotSelection ()
	Returns the winding region parts for the all reference slot as a Selection object. More...

Point *	GetAxis ()
	Returns the direction of the rotation axis for the detection of the slot pattern. More...

String	GetName ()
	Returns the winding region name as a string. More...

Point *	GetOrigin ()
	Returns the position of the origin for the detection of the slot pattern. More...

Variant	GetParts (int layer)
	Returns a list of parts for the reference slot for the given winding layer. More...

Selection *	GetSelection (int layer)
	Returns the parts for the reference slot for the given winding layer as a Selection object. More...

Set *	GetSet (int layer, int index)
	Returns the parts for the reference slot for the given winding layer as a Set object. More...

bool	HasCoilEnd ()
	Returns True as the return value in the case considering coil end when detecting coil pattern. More...

bool	IsValid ()
	Returns True if an object is valid. More...

bool	IsWireTemplateRegion ()
	Returns True as the return value in the case the winding region uses the region of the wire template. More...

int	NumPoles ()
	Returns the number of poles for this winding region. More...

int	NumSlots ()
	Returns the number of slots for this winding region. More...

double	Offset ()
	Returns the offset distance between slots (for linear winding regions). More...

int	Phases ()
	Returns the number of phases in the case of winding region (coil template). More...

void	ReNameCoilRegion (String &from, String &to)
	Renames the coil region from "from" to "to". More...

void	SetAxis (Point *axis)
	Specifies the direction of the rotation axis for the slot pattern. More...

void	SetAxisXYZ (Variant &x, Variant &y, Variant &z)
	Specifies the direction of the rotation axis as (x,y,z) coordiantes for the slot pattern. More...

void	SetCoilTemplate (Variant &coilTemplate)
	Specifies the coil template where this template will be located. More...

void	SetDetectFromGeometry (bool value)
	Specifies the flag to detect the coil 2 region automatically from coil 1 region. More...

void	SetHasCoilEnd (bool value)
	Specifies the flag to consider the coil end when detecting the coil pattern. More...

void	SetIsWireTemplateRegion (bool value)
	Specifies whether the winding regions is region created using the wire template. More...

void	SetName (String &name)
	Specifies the name of this winding region. More...

void	SetOffset (Variant &offset)
	Specifies the linear offset distance between slots. More...

void	SetOrigin (Point *origin)
	Specifies the origin position as a Point for the slot pattern. More...

void	SetOriginXYZ (Variant &x, Variant &y, Variant &z)
	Specifies the origin position as (x,y,z) coordiantes for the slot pattern. More...

void	SetPhaseToCoilGroup (String array &list)
	Specifies the phase to each coil group in the case of winding region(coil template). More...

void	SetPoles (Variant &numPoles)
	Specifies the number of poles for this winding region. More...

void	SetSlots (Variant &numSlots)
	Specifies the number of slots for this winding region. More...

void	SetUseAxialPartialModel (bool value)
	Specifies the flag to treat the model is axial partial model. More...

void	SetUsePartGroup (bool value)
	Specifies the flag to consider the part group when detecting the coil pattern. More...

bool	UseAxialPartialModel ()
	Returns True as the return value if the axial partial model flag is set. More...

bool	UsePartGroup ()
	Returns True as the return value in the case considering a part group when detecting coil pattern. More...

Detailed Description

WindingRegion class is used to specify the location of the slots and geometry for the winding.
The class can be called from the Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetWindingRegion(0)

Member Function Documentation

void WindingRegion::AddCoilRegion ( String & name )

Adds a coil region with the specified name.

Parameters

name	Name of the coil region

void WindingRegion::AddPart	(	int	layer,
		Variant &	val
	)

Adds a part to the specified layer for the reference slot of the winding region.

Parameters

layer	The layer of the winding
val	Name or index of the part

void WindingRegion::AddSelected	(	int	layer,
		Selection *	selection
	)

Adds a selection to the specified layer for the reference slot of the winding region.

Parameters

layer	The layer of the winding
selection	Selection object

void WindingRegion::AddSet	(	int	layer,
		Set *	set
	)

Adds a Set object to the specified layer for the reference slot of the winding region.

Parameters

layer	The layer of the winding
selection	Set object

int WindingRegion::CoilGroupSize ( )

Returns the number of coil groups in the case of winding region (coil template).

Returns: Number of coil groups

String WindingRegion::CoilTemplate ( )

Returns a coil template name in the case of winding region (coil template).

Returns: Name of the coil template

void WindingRegion::DeleteCoilRegion ( String & name )

Deletes a coil region with the specified name.

Parameters

name	Name of the coil region

bool WindingRegion::DetectFromGeometry ( )

Returns True as the return value in the case detecting coil 2 region automatically from coil 1 region.

Returns: Whether or not to detect coil 2 region automatically form coil 1 region.

Selection * WindingRegion::GetAllSlotSelection ( )

Returns the winding region parts for the all reference slot as a Selection object.

Returns: Selection object

Point * WindingRegion::GetAxis ( )

Returns the direction of the rotation axis for the detection of the slot pattern.

Returns: The direction of the rotation axis

String WindingRegion::GetName ( )

Returns the winding region name as a string.

Returns: Name of the winding region

Point * WindingRegion::GetOrigin ( )

Returns the position of the origin for the detection of the slot pattern.

Returns: A point giving the origin coordinates

Variant WindingRegion::GetParts ( int layer )

Returns a list of parts for the reference slot for the given winding layer.

Parameters

layer

Returns: List of parts

Selection * WindingRegion::GetSelection ( int layer )

Returns the parts for the reference slot for the given winding layer as a Selection object.

Parameters

layer

Returns: Selection object

Set * WindingRegion::GetSet	(	int	layer,
		int	index
	)

Returns the parts for the reference slot for the given winding layer as a Set object.

Parameters

layer
index

Returns: Set object

bool WindingRegion::HasCoilEnd ( )

Returns True as the return value in the case considering coil end when detecting coil pattern.

Returns: Whether or not to consider coil end.

bool WindingRegion::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the WindingRegion object is valid

bool WindingRegion::IsWireTemplateRegion ( )

Returns True as the return value in the case the winding region uses the region of the wire template.

Returns: Whether or not to the winding region is the region of the wire template.

int WindingRegion::NumPoles ( )

Returns the number of poles for this winding region.

Returns: Number of poles

int WindingRegion::NumSlots ( )

Returns the number of slots for this winding region.

Returns: Number of slots

double WindingRegion::Offset ( )

Returns the offset distance between slots (for linear winding regions).

Returns: Offset distance

int WindingRegion::Phases ( )

Returns the number of phases in the case of winding region (coil template).

Returns: Number of phases

void WindingRegion::ReNameCoilRegion	(	String &	from,
		String &	to
	)

Renames the coil region from "from" to "to".

Parameters

from	The name of the coil region before rename
to	The name of the coil region after rename

void WindingRegion::SetAxis ( Point * axis )

Specifies the direction of the rotation axis for the slot pattern.

Parameters

axis	The direction of the rotation axis

void WindingRegion::SetAxisXYZ	(	Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies the direction of the rotation axis as (x,y,z) coordiantes for the slot pattern.

Parameters

x	The origin x coordinate
y	The origin y coordinate
z	The origin z coordinate

void WindingRegion::SetCoilTemplate ( Variant & coilTemplate )

Specifies the coil template where this template will be located.

Parameters

coilTemplate The index or name of the coil template

void WindingRegion::SetDetectFromGeometry ( bool value )

Specifies the flag to detect the coil 2 region automatically from coil 1 region.

Parameters

value

True=1 : Detects automatically from coil 1 region geometry

False=0 : Specifies from the model

void WindingRegion::SetHasCoilEnd ( bool value )

Specifies the flag to consider the coil end when detecting the coil pattern.

Parameters

value

True=1 : Considers coil end

False=0 : Does not consider coil end

void WindingRegion::SetIsWireTemplateRegion ( bool value )

Specifies whether the winding regions is region created using the wire template.

Parameters

value

True=1 : Wire template region

False=0 : Not wire template region

void WindingRegion::SetName ( String & name )

Specifies the name of this winding region.

Parameters

name	Name of the winding region

void WindingRegion::SetOffset ( Variant & offset )

Specifies the linear offset distance between slots.

Parameters

offset Offset distance

void WindingRegion::SetOrigin ( Point * origin )

Specifies the origin position as a Point for the slot pattern.

Parameters

origin Origin position

void WindingRegion::SetOriginXYZ	(	Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies the origin position as (x,y,z) coordiantes for the slot pattern.

Parameters

x	The origin x coordinate
y	The origin y coordinate
z	The origin z coordinate

void WindingRegion::SetPhaseToCoilGroup ( String array & list )

Specifies the phase to each coil group in the case of winding region(coil template).

Parameters

list	Phase name or index list corresponding to the coil group

void WindingRegion::SetPoles ( Variant & numPoles )

Specifies the number of poles for this winding region.

Parameters

numPoles Number of poles

void WindingRegion::SetSlots ( Variant & numSlots )

Specifies the number of slots for this winding region.

Parameters

numSlots Number of slots

void WindingRegion::SetUseAxialPartialModel ( bool value )

Specifies the flag to treat the model is axial partial model.

Parameters

value

True=1 : Treats the model is axial partial model

False=0 : Treats the model is not axial partial model

void WindingRegion::SetUsePartGroup ( bool value )

Specifies the flag to consider the part group when detecting the coil pattern.

Parameters

value

True=1 : Considers a part group

False=0 : Does not consider a part group

bool WindingRegion::UseAxialPartialModel ( )

Returns True as the return value if the axial partial model flag is set.

Returns: Whether or not axial model flag is set.

bool WindingRegion::UsePartGroup ( )

Returns True as the return value in the case considering a part group when detecting coil pattern.

Returns: Whether or not to consider a part group.

Public Member Functions

Detailed Description

Member Function Documentation