RTCreateAdditionalPointsInfo Class Reference

RTCreateAdditionalPointsInfo class is used to specify the response creation additional points information for rt generic study
The class can be called from the Study class.
. More...

Public Member Functions
void	ClearParameter ()
	Clears the values associated with the parameter.
int	GetNumJobs ()
	Returns the number of simultaneous jobs. More...
bool	GetSpecifyNumJobs ()
	Returns whether the number of simultaneous jobs is specified. More...
bool	IsValid ()
	Returns True if an object is valid. More...
void	SetNumJobs (int numJobs)
	Set the number of simultaneous jobs. More...
void	SetParameterDivisionsRange (int paramNo, double start, double end, int divisions)
	Specifies the given parameter to have an divided range. More...
void	SetParameterIncrementRange (int paramNo, double start, double increment, int steps)
	Specifies the given parameter to have an incremental range. More...
void	SetParameterTableRange (int paramNo, String array &array)
	Specifies the given parameter to have an table range. More...
void	SetSpecifyNumJobs (bool specify)
	Specifies whether to specify the number of simultaneous jobs. More...

Detailed Description

RTCreateAdditionalPointsInfo class is used to specify the response creation additional points information for rt generic study
The class can be called from the Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetCreateRTAdditionalPointsInfo()

Author

Author

Date

水 9 6 2023

Member Function Documentation

int RTCreateAdditionalPointsInfo::GetNumJobs

(

)

Returns the number of simultaneous jobs.

Returns

The number of simultaneous jobs.

bool RTCreateAdditionalPointsInfo::GetSpecifyNumJobs

(

)

Returns whether the number of simultaneous jobs is specified.

Returns

Whether the number of simultaneous jobs is specified

bool RTCreateAdditionalPointsInfo::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the RTCreateAdditionalPointsInfo object is valid

void RTCreateAdditionalPointsInfo::SetNumJobs

(

int

numJobs

)

Set the number of simultaneous jobs.

Parameters

numJobs

Number of simultaneous jobs

void RTCreateAdditionalPointsInfo::SetParameterDivisionsRange	(	int	paramNo,
		double	start,
		double	end,
		int	divisions
	)

Specifies the given parameter to have an divided range.

Parameters

paramNo	The index of the parameter
start	The start value of the range
end	The end value of the range
divisions	The number of divisions to divide the range

void RTCreateAdditionalPointsInfo::SetParameterIncrementRange	(	int	paramNo,
		double	start,
		double	increment,
		int	steps
	)

Specifies the given parameter to have an incremental range.

Parameters

paramNo	The index of the parameter
start	The start value of the range
increment	The increment value at each step
steps	The number of steps to increment the value

void RTCreateAdditionalPointsInfo::SetParameterTableRange	(	int	paramNo,
		String array &	array
	)

Specifies the given parameter to have an table range.

Parameters

paramNo	The index of the parameter
array	The table of values for the parameter

void RTCreateAdditionalPointsInfo::SetSpecifyNumJobs

(

bool

specify

)

Specifies whether to specify the number of simultaneous jobs.

Parameters

specify

Specify the number of simultaneous jobs