UserComponent class is used to specify the user component.
The class can be called from UserComponentList class
. More...

Public Member Functions
int	GetAnalysisType ()
	Returns analysis type of a user component as a character string. More...

String	GetDescription ()
	Returns a user component description in character string. More...

String	GetExpression ()
	Returns a user component expression in character string. More...

String	GetName ()
	Returns a user component name in character string. More...

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

void	SetAnalysisType (int type)
	Specifies the user component analysis type. More...

void	SetDescription (String &description)
	Specifies the user component description. More...

void	SetExpression (String &expression)
	Specifies the user component expression. More...

void	SetName (String &name)
	Specifies the user component name. More...

Detailed Description

UserComponent class is used to specify the user component.
The class can be called from UserComponentList class
.

Example of calling the class object:

app.GetUserComponentList().GetUserComponent(0)

Member Function Documentation

int UserComponent::GetAnalysisType ( )

Returns analysis type of a user component as a character string.

Returns: User component analysis type
0=Magnetic field analysis

1=Thermal analysis

2=Structural analysis

3=Electric field analysis

4=Loss analysis

String UserComponent::GetDescription ( )

Returns a user component description in character string.

String UserComponent::GetExpression ( )

Returns a user component expression in character string.

String UserComponent::GetName ( )

Returns a user component name in character string.

bool UserComponent::IsValid ( )

Returns True if an object is valid.

void UserComponent::SetAnalysisType ( int type )

Specifies the user component analysis type.

Parameters

type	User component analysis type 0=Magnetic field analysis 1=Thermal analysis 2=Structural analysis 3=Electric field analysis 4=Loss analysis

void UserComponent::SetDescription ( String & description )

Specifies the user component description.

Parameters

description Description of user component

void UserComponent::SetExpression ( String & expression )

Specifies the user component expression.

Parameters

expression User component expression

void UserComponent::SetName ( String & name )

Specifies the user component name.

Parameters

name	Name of the user component