ResponseCreateAdditionalPointsInfo Class Reference

ResponseCreateAdditionalPointsInfo class is used to specify the response creation additional points information for an efficiency map study
The class can be called from the Study class.
. More...

Public Member Functions
void	ClearParameter (int paramNo)
	Clears the values associated with the parameter. More...
String	GetParameterType (int paramNo)
	Returns the type of the parameter. ("current", "phase", "speed") More...
bool	IsValid ()
	Returns True if an object is valid. More...
int	NumParameter ()
	Returns the number of parameters. More...
void	SetAccuracyTable (String array &array)
	Specifies the table of values for the accuracy mode cases. More...
void	SetSpeedParameterDivisionsRange (int paramNo, double start, double end, int divisions)
	Specifies the given parameter to have an divided range. More...
void	SetSpeedParameterIncrementRange (int paramNo, double start, double increment, int steps)
	Specifies the given parameter to have an incremental range. More...
void	SetSpeedParameterTableRange (int paramNo, String array &array)
	Specifies the given parameter to have an table range. More...

Detailed Description

ResponseCreateAdditionalPointsInfo class is used to specify the response creation additional points information for an efficiency map study
The class can be called from the Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetCreateResponseAdditionalPointsInfo()

Member Function Documentation

void ResponseCreateAdditionalPointsInfo::ClearParameter

(

int

paramNo

)

Clears the values associated with the parameter.

Parameters

paramNo

Index of the parameter

String ResponseCreateAdditionalPointsInfo::GetParameterType

(

int

paramNo

)

Returns the type of the parameter. ("current", "phase", "speed")

Parameters

paramNo

Index of the parameter

Returns

Parameter type

bool ResponseCreateAdditionalPointsInfo::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the ResponseCreateAdditionalPointsInfo object is valid

int ResponseCreateAdditionalPointsInfo::NumParameter

(

)

Returns the number of parameters.

Returns

Number of parameters

void ResponseCreateAdditionalPointsInfo::SetAccuracyTable

(

String array &

array

)

Specifies the table of values for the accuracy mode cases.

Parameters

array

Table

void ResponseCreateAdditionalPointsInfo::SetSpeedParameterDivisionsRange	(	int	paramNo,
		double	start,
		double	end,
		int	divisions
	)

Specifies the given parameter to have an divided range.

Parameters

paramNo	Index of the parameter
start	Lower limit of range
end	Upper limit of range
divisions	Number of divisions for a range defined by the upper and lower limits

void ResponseCreateAdditionalPointsInfo::SetSpeedParameterIncrementRange	(	int	paramNo,
		double	start,
		double	increment,
		int	steps
	)

Specifies the given 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 ResponseCreateAdditionalPointsInfo::SetSpeedParameterTableRange	(	int	paramNo,
		String array &	array
	)

Specifies the given parameter to have an table range.

Parameters

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