ResponseCreateInfo class is used to specify the response creation information for an Efficiency Map Analysis study.
The class can be called from the Study class.
. More...

Public Member Functions
void	ClearAccuracyParameter (int paramNo)
	Clears the settings for the given accuracy mode response parameter. More...

void	ClearSpeedParameter (int paramNo)
	Clears the values associated with a speed priority mode parameter. More...

String	GetAccuracyParameterName (int paramNo)
	Returns the name of the given accuracy mode response parameter. More...

Variant	GetBaseFrequency ()
	Returns the value of the frequency at which the stray load loss is measured. More...

Variant	GetBaseVoltage ()
	Returns the voltage at which the stray load loss was measured. More...

Variant	GetCalculationCycle ()
	Returns the number of calculation cycles. More...

String	GetCalculationCycleType ()
	Returns the calculation period type for this study. More...

int	GetCalculationType ()
	Returns the calculation type. More...

String	GetDQAxisTransformType ()
	Returns the dq-axis transformation type. More...

bool	GetIgnoreDifferenceFromAutoCalculation ()
	Returns true if ignore the differene between calculation for specified offset and automatically calculation for the current phase offset. More...

String	GetInductanceCalculationType ()
	Returns the inductance calculation type. More...

Variant	GetMaximumCurrent ()
	Returns the maximum current. More...

Variant	GetMaximumFieldCurrent ()
	Returns the maximum field current. More...

Variant	GetMaximumSpeed ()
	Returns the maximum speed. More...

String	GetMotorType ()
	Returns the motor type for this study. More...

Variant	GetParallelJobs ()
	Returns the parallel jobs. More...

Variant	GetPhaseOffset ()
	Returns the current phase offset. More...

Variant	GetPole ()
	Returns the number of poles. More...

String	GetSpeedParameterType (int paramNo)
	Returns the type of the parameter used in speed priority mode. More...

Variant	GetStrayLoss ()
	Returns the value of the stray load loss. More...

Variant	GetTargetCycle ()
	Returns the calculation target cycle. More...

String	GetTargetCycleType ()
	Returns the calculation target type for this study. More...

Condition *	GetTorqueCondition ()
	Returns the condition that has been set as the reference Torque condition for the response calculation. More...

bool	GetUseStrayLoss ()
	Returns True if the stray load loss will be added to the calculation. More...

Variant	GetWindingFactor ()
	Returns the winding factor. More...

int	IsAutoCalculationPhaseOffset ()
	Returns Calculation type for the current phase offset. More...

bool	IsSpeedCalculationType ()
	Returns True if the setting is for a speed priority response calculation. More...

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

int	NumAccuracyParameter ()
	Returns the number of parameters used in the accuracy mode response settings. More...

int	NumSpeedParameter ()
	Returns the number of parameters used in speed priority mode (will always be 3 for PMSM). More...

void	SetAccuracyParameter (int paramNo, Variant &nameOrIndex)
	Specifies the parametric item to use for the given accuracy mode response parameter. More...

void	SetAccuracyTable (String array &array)
	Specifies the table of values for the accuracy mode cases. More...

void	SetAutoCalculationPhaseOffset (int calculationPhaseType)
	Specifies the calculation method for the current phase offset. More...

void	SetBaseFrequency (Variant &value)
	Specifies the base frequency for the response calculation. More...

void	SetBaseVoltage (Variant &value)
	Specifies the base voltage for the response calculation. More...

void	SetCalculationCycle (Variant &value)
	Specifies the number of calculation cycles. More...

void	SetCalculationCycleType (String &type)
	Specifies the calculation period type. More...

void	SetCalculationType (String &type)
	Specifies the calculation type. More...

void	SetDQAxisTransformType (String &type)
	Specifies the dq axis transformation type. More...

void	SetIgnoreDifferenceFromAutoCalculation (bool ignoreDiff)
	Specifies whether to ignore the difference between the calculation for the specified offset and automatic calculation for the current phase offset. More...

void	SetInductanceCalculationType (String &type)
	Specifies the inductance calculation method. More...

void	SetMaximumCurrent (Variant &value)
	Specifies the maximum current. More...

void	SetMaximumFieldCurrent (Variant &value)
	Specifies the maximum field current. More...

void	SetMaximumSpeed (Variant &value)
	Specifies the maximum speed. More...

void	SetMotorType (String &type)
	Specifies the motor type. More...

void	SetParallelJobs (Variant &value)
	Specifies the parallel jobs. More...

void	SetPhaseOffset (Variant &value)
	Specifies the current phase offset. More...

void	SetPole (Variant &value)
	Specifies the number of poles for the response calculation. More...

void	SetSpeedParameterDivisionsRange (int paramNo, Variant &start, Variant &end, Variant &divisions)
	Specifies the given speed priority mode parameter to have an divided range. More...

void	SetSpeedParameterIncrementRange (int paramNo, Variant &start, Variant &increment, Variant &steps)
	Specifies the given speed priority mode parameter to have an incremental range. More...

void	SetSpeedParameterTableRange (int paramNo, String array &array)
	Specifies the given speed priority mode parameter to have an table range. More...

void	SetStrayLoss (Variant &value)
	Specifies the stray load loss for the response calculation. More...

void	SetTargetCycle (Variant &value)
	Specifies the calculation target cycle. More...

void	SetTargetCycleType (String &type)
	Specifies the calculation target type. More...

void	SetTorqueCondition (Condition *cond)
	Specifies the Torque condition to use for the response calculation. More...

void	SetTorqueConditionIndex (int index)
	Specifies the index of the Torque condition to use for the response calculation. More...

void	SetUseStrayLoss (bool use)
	Specifies whether to use the stray load loss or not in the calculation. More...

void	SetWindingFactor (Variant &value)
	Specifies the winding factor for the response calculation. More...

Detailed Description

ResponseCreateInfo class is used to specify the response creation information for an Efficiency Map Analysis study.
The class can be called from the Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetCreateResponseInfo()

Member Function Documentation

void ResponseCreateInfo::ClearAccuracyParameter ( int paramNo )

Clears the settings for the given accuracy mode response parameter.

Parameters

paramNo Index of the parameter

void ResponseCreateInfo::ClearSpeedParameter ( int paramNo )

Clears the values associated with a speed priority mode parameter.

Parameters

paramNo Index of the parameter

String ResponseCreateInfo::GetAccuracyParameterName ( int paramNo )

Returns the name of the given accuracy mode response parameter.

Parameters

paramNo Index of the parameter

Returns: Parametric item name

Variant ResponseCreateInfo::GetBaseFrequency ( )

Returns the value of the frequency at which the stray load loss is measured.

Returns: Frequency as an expression

Variant ResponseCreateInfo::GetBaseVoltage ( )

Returns the voltage at which the stray load loss was measured.

Returns: Voltage as an expression

Variant ResponseCreateInfo::GetCalculationCycle ( )

Returns the number of calculation cycles.

Returns: Number of calculation cycles as an expression

String ResponseCreateInfo::GetCalculationCycleType ( )

Returns the calculation period type for this study.

Returns: Calculation period type
Single

Multi

int ResponseCreateInfo::GetCalculationType ( )

Returns the calculation type.

Returns: Type

0 = speed priority

1 = accuracy priority

2 = reduced order model

String ResponseCreateInfo::GetDQAxisTransformType ( )

Returns the dq-axis transformation type.

Returns: Transformation type
ValueInvariant

PowerInvariant

bool ResponseCreateInfo::GetIgnoreDifferenceFromAutoCalculation ( )

Returns true if ignore the differene between calculation for specified offset and automatically calculation for the current phase offset.

Returns

String ResponseCreateInfo::GetInductanceCalculationType ( )

Returns the inductance calculation type.

Returns: Type
Static

DifferentialLd

DoubleDifferential

Phase

Variant ResponseCreateInfo::GetMaximumCurrent ( )

Returns the maximum current.

Returns: Maximum current

Variant ResponseCreateInfo::GetMaximumFieldCurrent ( )

Returns the maximum field current.

Returns: Mmaximum field current

Variant ResponseCreateInfo::GetMaximumSpeed ( )

Returns the maximum speed.

Returns: Maximum speed

String ResponseCreateInfo::GetMotorType ( )

Returns the motor type for this study.

Returns: Motor type
PMSM

IM

SynRM

WFSM

Variant ResponseCreateInfo::GetParallelJobs ( )

Returns the parallel jobs.

Returns: Parallel jobs

Variant ResponseCreateInfo::GetPhaseOffset ( )

Returns the current phase offset.

Returns: Current phase offset

Variant ResponseCreateInfo::GetPole ( )

Returns the number of poles.

Returns: Number of poles as an expression

String ResponseCreateInfo::GetSpeedParameterType ( int paramNo )

Returns the type of the parameter used in speed priority mode.

Parameters

paramNo Index of the parameter

Returns: Parameter type
current

phase

speed

slip

Variant ResponseCreateInfo::GetStrayLoss ( )

Returns the value of the stray load loss.

Returns: Stray load loss as an expression

Variant ResponseCreateInfo::GetTargetCycle ( )

Returns the calculation target cycle.

Returns: Calculation target cycle

String ResponseCreateInfo::GetTargetCycleType ( )

Returns the calculation target type for this study.

Returns: Calculation target type
AllCycles

SpecifyCycle

Condition * ResponseCreateInfo::GetTorqueCondition ( )

Returns the condition that has been set as the reference Torque condition for the response calculation.

Returns: Condition object

bool ResponseCreateInfo::GetUseStrayLoss ( )

Returns True if the stray load loss will be added to the calculation.

Returns: True/False

Variant ResponseCreateInfo::GetWindingFactor ( )

Returns the winding factor.

Returns: Winding factor as an expression

int ResponseCreateInfo::IsAutoCalculationPhaseOffset ( )

Returns Calculation type for the current phase offset.

Returns

bool ResponseCreateInfo::IsSpeedCalculationType ( )

Returns True if the setting is for a speed priority response calculation.

Returns

bool ResponseCreateInfo::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the ResponseCreateInfo object is valid

int ResponseCreateInfo::NumAccuracyParameter ( )

Returns the number of parameters used in the accuracy mode response settings.

Returns: Number of parameters

int ResponseCreateInfo::NumSpeedParameter ( )

Returns the number of parameters used in speed priority mode (will always be 3 for PMSM).

Returns: Number of parameters

void ResponseCreateInfo::SetAccuracyParameter	(	int	paramNo,
		Variant &	nameOrIndex
	)

Specifies the parametric item to use for the given accuracy mode response parameter.

Parameters

paramNo	Index of the parameter
nameOrIndex	Index or name of the parametric item or expression to use.

void ResponseCreateInfo::SetAccuracyTable ( String array & array )

Specifies the table of values for the accuracy mode cases.

Parameters

array 2D array of values

void ResponseCreateInfo::SetAutoCalculationPhaseOffset ( int phaseOffsetType )

Specifies the calculation method for the current phase offset.

Parameters

phaseOffsetType

Calculation method

: Automatic calculation with no load is used
:  Automatic calculation of current phase offset is used
:  Automatic calculation with winding settings is used

void ResponseCreateInfo::SetBaseFrequency ( Variant & value )

Specifies the base frequency for the response calculation.

Parameters

value Expression for the base frequency.

void ResponseCreateInfo::SetBaseVoltage ( Variant & value )

Specifies the base voltage for the response calculation.

Parameters

value Expression for the base voltage

void ResponseCreateInfo::SetCalculationCycle ( Variant & value )

Specifies the number of calculation cycles.

Parameters

value Expression for the calculation cycles

void ResponseCreateInfo::SetCalculationCycleType ( String & type )

Specifies the calculation period type.

Parameters

type	Calculation period type Single Multi

void ResponseCreateInfo::SetCalculationType ( String & type )

Specifies the calculation type.

Parameters

type	The calculation type speed accuracy ReducedOrderModel

void ResponseCreateInfo::SetDQAxisTransformType ( String & value )

Specifies the dq axis transformation type.

Parameters

value

Type

ValueInvariant

PowerInvariant

void ResponseCreateInfo::SetIgnoreDifferenceFromAutoCalculation ( bool ignoreDiff )

Specifies whether to ignore the difference between the calculation for the specified offset and automatic calculation for the current phase offset.

Parameters

ignoreDiff Ignore Difference from Automatic Calculation Results

void ResponseCreateInfo::SetInductanceCalculationType ( String & value )

Specifies the inductance calculation method.

Parameters

value

Name of the method

Static                          
DifferentialLd          
DoubleDifferential      
Phase                           

void ResponseCreateInfo::SetMaximumCurrent ( Variant & value )

Specifies the maximum current.

Parameters

value Maximum current

void ResponseCreateInfo::SetMaximumFieldCurrent ( Variant & value )

Specifies the maximum field current.

Parameters

value Maximum field current

void ResponseCreateInfo::SetMaximumSpeed ( Variant & value )

Specifies the maximum speed.

Parameters

value Maximum speed

void ResponseCreateInfo::SetMotorType ( String & type )

Specifies the motor type.

Parameters

type	Motor type PMSM IM SynRM WFSM

void ResponseCreateInfo::SetParallelJobs ( Variant & value )

Specifies the parallel jobs.

Parameters

value Parallel jobs

void ResponseCreateInfo::SetPhaseOffset ( Variant & value )

Specifies the current phase offset.

Parameters

value Expression for the current phase offset

void ResponseCreateInfo::SetPole ( Variant & value )

Specifies the number of poles for the response calculation.

Parameters

value Expression for the number of poles

void ResponseCreateInfo::SetSpeedParameterDivisionsRange	(	int	paramNo,
		Variant &	start,
		Variant &	end,
		Variant &	divisions
	)

Specifies the given speed priority mode parameter to have an divided range.

Parameters

paramNo	Index of the parameter
start	Start value of the range
end	End value of the range
divisions	Number of divisions to divide the range

void ResponseCreateInfo::SetSpeedParameterIncrementRange	(	int	paramNo,
		Variant &	start,
		Variant &	increment,
		Variant &	steps
	)

Specifies the given speed priority mode parameter to have an incremental range.

Parameters

paramNo	Index of the parameter
start	Start value of the range
increment	Increment value at each step
steps	Number of steps to increment the value

void ResponseCreateInfo::SetSpeedParameterTableRange	(	int	paramNo,
		String array &	array
	)

Specifies the given speed priority mode parameter to have an table range.

Parameters

paramNo	Index of the parameter
array	Table of values for the parameter

void ResponseCreateInfo::SetStrayLoss ( Variant & value )

Specifies the stray load loss for the response calculation.

Parameters

value Expression for the stray load loss

void ResponseCreateInfo::SetTargetCycle ( Variant & value )

Specifies the calculation target cycle.

Parameters

value Calculation target cycle

void ResponseCreateInfo::SetTargetCycleType ( String & type )

Specifies the calculation target type.

Parameters

type	Calculation target type AllCycles SpecifyCycle

void ResponseCreateInfo::SetTorqueCondition ( Condition * cond )

Specifies the Torque condition to use for the response calculation.

Parameters

cond	A condition object representing the Torque condition

void ResponseCreateInfo::SetTorqueConditionIndex ( int index )

Specifies the index of the Torque condition to use for the response calculation.

Parameters

index Index of the Torque condition

void ResponseCreateInfo::SetUseStrayLoss ( bool use )

Specifies whether to use the stray load loss or not in the calculation.

Parameters

value

The flag for using the stray load loss

True=1 : Stray load loss is used

False=0 : Stray load loss is not used

void ResponseCreateInfo::SetWindingFactor ( Variant & value )

Specifies the winding factor for the response calculation.

Parameters

value Expression for the winding factors

Public Member Functions

Detailed Description

Member Function Documentation