Ranges

Tutorial Toolkit Function Descriptions > Graphics > Ranges

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">

Ranges


ga_range_contour_get	( name, flag )


Description:
Get whether range is to be displayed using contour values.
Input:
STRING	name[]	Range name.
Output:
INTEGER	flag	Flag=1 if contour values are displayed, Flag=0 if fringe values.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000134	The range name is invalid.
11000136	The specified range was not found.
11000098	A fatal error has occurred in the database. Database is corrupted.

Example:

Please see ga_range_contour_get (p. 153) in the MSC Acumen Toolkit - Code Examples.


ga_range_contour_set	( name, flag )


Description:
Set the display type flag.
Input:
STRING	name[]	Name of range.
INTEGER	flag	Flag=1 if contour values are displayed Flag=0 if fringe values.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000134	The range name is invalid.
11000136	The specified range was not found.
11000098	A fatal error has occurred in the database. Database is corrupted.

Example:

Please see ga_range_contour_set (p. 154) in the MSC Acumen Toolkit - Code Examples.


ga_range_create	( name, number )


Description:
Creates a range.
Input:
STRING	name[]	Name of range.
INTEGER	number	Number of sub-ranges in range.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000134	The range name is invalid.
11000133	A range with the given name is already in the database.
11000097	There is not enough disk space to complete operation.
11000098	A fatal error has occurred in the database. Database is corrupted.

Example:

Please see ga_range_create (p. 156) in the MSC Acumen Toolkit - Code Examples.


ga_range_delete	( name )


Description:
Delete a range
Input:
STRING	name[]	Name of range.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000134	The range name is invalid.
11000136	The specified range was not found.
11000098	A fatal error has occurred in the database. Database is corrupted.

Example:

Please see ga_range_delete (p. 159) in the MSC Acumen Toolkit - Code Examples.


ga_range_exist_get	( name, flag )


Description:
Check if range exists.
Input:
STRING	name[]	Range name.
Output:
INTEGER	flag	Exist flag.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000134	The range name is invalid.
11000136	The specified range was not found.

Example:

See example for ga_range_create, 66. See also ga_range_exist_get (p. 161) in the MSC Acumen Toolkit - Code Examples.


ga_range_nranges_get	( nranges )


Description:
Gets the number of ranges.
Input:
None.
Output:
INTEGER	nranges	Number of ranges.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000098	A fatal error has occurred in the database. Database is corrupted.

Example:

Please see ga_range_nranges_get (p. 162) in the MSC Acumen Toolkit - Code Examples.


ga_range_nvalues_get	( name, number )


Description:
Get the number of sub-ranges defined in range.
Input:
STRING	name[]	Range name.
Output:
INTEGER	number	Number of sub-ranges.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000134	The range name is invalid.
11000136	The specified range was not found.
11000098	A fatal error has occurred in the database. Database is corrupted.

Example:

Please see ga_range_nvalues_get (p. 163) in the MSC Acumen Toolkit - Code Examples.


ga_range_ranges_get	( ranges )


Description:
Gets the list of ranges.
Input:
None.
Output:
STRING	ranges [ ] ( )	List of ranges.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000098	A fatal error has occurred in the database. Database is corrupted.

Example:

Please see ga_range_ranges_get (p. 165) in the MSC Acumen Toolkit - Code Examples.


ga_range_rename	( old, new )


Description:
Rename a range.
Input:
STRING	old[]	Current name of range.
STRING	new[]	New name of range.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000134	The range name is invalid.
11000136	The specified range was not found.
11000098	A fatal error has occurred in the database. Database is corrupted.

Example:

Please see ga_range_rename (p. 166) in the MSC Acumen Toolkit - Code Examples.


ga_range_startend_set	( name, start, end )


Description:
Set the sub-ranges in range given start/end.
Input:
STRING	name[]	Name of range.
REAL	start	Start value.
REAL	end	End value.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000134	The range name is invalid.
11000136	The specified range was not found.
11000098	A fatal error has occurred in the database. Database is corrupted.

Example:

Please see ga_range_startend_set (p. 168) in the MSC Acumen Toolkit - Code Examples.


ga_range_threshold_set	( name, start, end, sthresh_fl, sthresh, ethresh_fl, ethresh )


Description:
Set the sub-ranges in range given start/end and threshold values.
Input:
STRING	name[]	Name of range.
REAL	start	Start value.
REAL	end	End value.
INTEGER	sthresh_fl	Whether a starting threshold value is spec.
REAL	sthresh	Starting threshold value.
INTEGER	ethresh_fl	Whether an ending threshold value is spec.
REAL	ethresh	Ending threshold value.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000134	The range name is invalid.
11000136	The specified range was not found.
11000098	A fatal error has occurred in the database. Database is corrupted.

Example:

Please see ga_range_threshold_set (p. 170) in the MSC Acumen Toolkit - Code Examples.


ga_range_values_get	( name, from, to, middle )


Description:
Get the sub-ranges defined in range.
Input:
STRING	name[]	Range name.
Output:
REAL	from ( )	From values.
REAL	to ( )	To values.
REAL	ranges [ ] ( )	List of ranges.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000134	The range name is invalid.
11000136	The specified range was not found.
11000098	A fatal error has occurred in the database. Database is corrupted.

Example:

Please see ga_range_values_get (p. 173) in the MSC Acumen Toolkit - Code Examples.


ga_range_values_set	( name, from, to, middle )


Description:
Set the sub-ranges in range.
Input:
STRING	name[]	Name of range.
REAL	from ( )	From values.
REAL	to ( )	To values.
REAL	middle ( )	Middle values.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000134	The range name is invalid.
11000136	The specified range was not found.
11000098	A fatal error has occurred in the database. Database is corrupted.

Example:

Please see ga_range_values_set (p. 175) in the MSC Acumen Toolkit - Code Examples.