General

Tutorial Toolkit Function Descriptions > Preferences > General

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">

General


pref_anal_get	(anal_code, anal_type, mod_suf, res_suf )


Description:
Get the Analysis Preference parameters.
Input:
None
Output:
STRING	anal_code[31]	Analysis Code Name.
STRING	anal_type[31	Analysis Type.
STRING	mod_suf[4]	Model File Suffix.
STRING	res_suf[4]	Results File Suffix.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_anal_get (p. 1386) in the MSC Acumen Toolkit - Code Example.


pref_anal_set	(anal_code, anal_type, mod_suf, res_suf )


Description:
Set the Analysis Preference parameters.
Input:
STRING	anal_code[31]	Analysis Code Name.
STRING	anal_type[31]	Analysis Type.
STRING	mod_suf[4]	Model File Suffix.
STRING	res_suf[4]	Results File Suffix.
Output:
INTEGER	<Return Value>	0: no error. 1: fatal error
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_anal_set (p. 1387) in the MSC Acumen Toolkit - Code Example.


pref_confirm_get	(confirm )


Description:
Get the Global Preference Confirm status.
Input:
None
Output:
LOGICAL	confirm	Confirm Flag.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_confirm_get (p. 1389) in the MSC Acumen Toolkit - Code Example.


pref_display_method_get	(disp_meth )


Description:
Get the Graphics Display Method Preference type.
Input:
None
Output:
INTEGER	disp_meth	Display Method.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_display_method_get (p. 1390) in the MSC Acumen Toolkit - Code Example.


pref_entity_dp_get	(ed_prop )


Description:
Get the Entity Display Property Preference.
Input:
None
Output:
STRING	ed_prop[]	Entity Display Property.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_entity_dp_get (p. 1391) in the MSC Acumen Toolkit - Code Example.


pref_entity_dp_set	(ed_prop )


Description:
Set the Entity Display Property Preference.
Input:
STRING	ed_prop[]	Entity Display Property.
Output:
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

See example for pref_display_method_get, 569. See also pref_entity_dp_set (p. 1392) in the MSC Acumen Toolkit - Code Example.


pref_env_get_integer	(prefname, value )


Description:
Retrieve the value of an integer preference.
Input:
STRING	prefname[]	Name of preference to load.
Output:
INTEGER	value	Result preference integer.
INTEGER	<Return Value>	0: no error, else see error returned.
Error Conditions:
12002001	The environment preference was not found.
12002002	The environment preference is of the wrong datatype.

Remarks:

None.

Example:

Please see pref_env_get_integer (p. 1396) in the MSC Acumen Toolkit - Code Example.


pref_env_get_logical	(prefname, value )


Description:
Retrieve the value of a logical preference.
Input:
STRING	prefname[]	Name of preference to load.
Output:
LOGICAL	value	Result preference logical.
INTEGER	<Return Value>	0: no error, else see returned error.
Error Conditions:
12002001	The environment preference was not found.
12002002	The environment preference is of the wrong datatype.

Remarks:

None.

Example:

See example for pref_env_get_integer. See also pref_env_get_logical (p. 1397) in the MSC Acumen Toolkit - Code Example.


pref_env_get_real	(prefname, value)


Description:
Retrieve the value of a real preference.
Input:
STRING	prefname[]	Name of preference to load.
Output:
REAL	value	Result preference real.
INTEGER	<Return Value>	0: no error, else see error returned.
Error Conditions:
12002001	The environment preference was not found.
12002002	The environment preference is of the wrong datatype.

Remarks:

None.

Example:

See example for pref_env_get_integer, 571. See also pref_env_get_real (p. 1398) in the MSC Acumen Toolkit - Code Example.


pref_env_get_string	(prefname, maxlen, value )


Description:
Retrieve the value of a string preference.
Input:
STRING	prefname[]	Name of preference to load.
INTEGER	maxlen	Max length of return string w/o null.
Output:
STRING	value[]	Result preference string.
INTEGER	<Return Value>	0; no error, else see error returned.
Error Conditions:
12002001	The environment preference was not found.
12002002	The environment preference is of the wrong datatype.
12002003	The string buffer is too small for the preference.

Remarks:

None.

Example:

See example for pref_env_get_integer, 571. See also pref_env_get_string (p. 1399) in the MSC Acumen Toolkit - Code Example.


pref_fa_get	(<lbc_color>,<lbc_display>, <ep_color>,<ep_display>, <display_fem )


Description:
This function gets the color preferences and flags for the display of Loads/Boundary Conditions and Element Properties. The function pref_fa_set sets the attributes for display of Loads/ Boundary Conditions and Element Properties.
Input:
None
Output:
INTEGER ARRAY	lbc_color()	Load/Boundary Condition colors.
LOGICAL ARRAY	lbc_display()	Load/Boundary Condition display flags.
INTEGER ARRAY	ep_color()	Element Property colors.
LOGICAL ARRAY	ep_display()	Element Property display flags.
LOGICAL	display_fem	Display on FEM Only flag.
INTEGER	<Return Value>	0 for success , 1 for failure
Error Conditions:
None

Notes:

Refer to notes below the function pref_fa_set.

Example:

Please see pref_fa_get (p. 1400) in the MSC Acumen Toolkit - Code Example.


pref_fa_set	(<set_flags>, <lbc_color>, <lbc_display>, <ep_color>, <ep_display>, <display_fem> )


Description:
This function sets the color preferences, flags for the Display of Loads/Boundary Conditions and Element Properties. The function should preferably be used from the graphical user-interface menu, Display, Load/BC/Element Props.
Input:
LOGICAL ARRAY	set_flags()	Array of logical values used to determine if a preference is set.
INTEGER ARRAY	lbc_color()	Load/Boundary Condition colors.
LOGICAL ARRAY	lbc_display()	Load/Boundary Condition display flags.
INTEGER ARRAY	ep_color()	Element Property colors.
LOGICAL ARRAY	ep_display()	Element Property display flags.
LOGICAL	display_fem	Display on FEM Only flag.
Output:
INTEGER	<Return Value>	0 - no error , 1 - fatal error.
Error Conditions:
None

Notes:

The flag for the Load/BC/Element Properties, if set as TRUE, displays the attribute in the graphic screen. The property is hidden in the graphic screen if this value is set as FALSE. The color codes can be set from integers 0 to 15 – it is the color in which the property will be displayed. The “set flag” argument shows the change in the values over the previous ones. If any value of the flag or color is changed over the previous one, it is set as TRUE, else if previous value is to be used, it is set at FALSE. The order for the set flags is as follows:


1 - 40	: Color Change of LBC’s
41 - 80	: Flag change of LBC’s
81 - 90	: Color change of EP’s
91 – 100	: Flag change of EP’s
101	: Flag change of Display fem.

For example, if the color of the property “distributed load” is to be changed, then set_flag(19) is set as TRUE and set_flag(i) (i from 1 to 18 and 20 to 101 ) is set to FALSE. If the flag of the Element Property “Axis 1 Orientation Vector” is to be changed, then set-flag(93) is set as TRUE and set-flag(i) (i = 1 to 92 and 94 to 101) is set as FALSE. See tables below for serial numbers of the LBC’s and Element Properties.


Serial No.	Description of LBC
1	Displacement
2	Force
3	Pressure
4	Temperature
5	Inertial Load
6	Initial displacement
7	Initial Velocity
8
9
10
11	Convection ( To Ambient)
12	Applied Heat (Normal Fluxes)
13	Applied Heat (Nodal Source)
14	Initial Temperature
15
16	Temp (Thermal)
17	Applied Heat (Volumetric Generation)
18
19	Distributed Load
20
21	Applied Heat (Directional Fluxes)
22	Convection ( Flow tube to Ambient)
23	Convection ( Coupled)
24	Convection ( Coupled flow rate)
25	Convection (Advection)
26	Convection (Duct Flow)
27	Convection (Ambient space)
28	Convection (Ambient nodes)
29	Convection (Enclosures)
30
31
32
33	Contact (Slide line)
34
35
36	Beam splines
37	Surface splines
38
39	Control device
40	Mass flux


Serial No.	Description of Element Property
1	Beam XY Plane Vector
2	Beam nodal offset
3	Axis 1 Orientation Vector
4	Axis 2-3 Orientation Vector
5	General Vector
6	General Marker
7
8
9
10

Example:

Please see pref_fa_set (p. 1402) in the MSC Acumen Toolkit - Code Example.


pref_geo_cid_int_string	(cid, sdb_string )


Description:
Construct the selectdatabox string in SDB_STRING from the coordinate frame ID specified in CID. Assume CID is a valid coordinate frame. SDB_STRING on input should be long enough to accommodate the completed string.
Input:
INTEGER	cid	Default Coordinate Frame ID.
Output:
STRING	sdb_string[]	SelectDataBox string.
INTEGER	<Return Value>	0: no error, else see error returned.
Error Conditions:
12001005	The string representation of the selectdatabox label for a coordinate frame exceeds 25 characters.

Remarks:

None.

Example:

Please see pref_geo_cid_int_string (p. 1404) in the MSC Acumen Toolkit - Code Example.


pref_geo_cid_string_int	(sdb_string, cid )


Description:
Get the default coordinate frame ID in CID from the selectdatabox input string and verify the coordinate frame.
Input:
STRING	sdb_string[]	SelectDataBox string.
Output:
INTEGER	cid	Default Coordinate Frame ID.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_geo_cid_string_int (p. 1405) in the MSC Acumen Toolkit - Code Example.


pref_geo_get	(defcid, rgtol )


Description:
Get the Geometric Modeling Preference parameters.
Input:
None
Output:
INTEGER	defcid	Default Coordinate Frame ID.
REAL	rgtol	Relative Geometric Tolerance.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

See example for pref_geo_cid_int_string, 577. See also pref_geo_get (p. 1406) in the MSC Acumen Toolkit - Code Example.


pref_get_anal_attributes	(anal_code, anal_type, mod_suf, res_suf )


Description:
Get the Analysis Preference suffixes.
Input:
STRING	anal_code[31]	Analysis Code Name.
Output:
STRING	anal_type[31]	Analysis Type.
STRING	mod_suf[4]	Model File Suffix.
STRING	res_suf[4]	Results File Suffix.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_get_anal_attributes (p. 1407) in the MSC Acumen Toolkit - Code Example.


pref_get_anal_code_count	(num_codes )


Description:
Get the number of analysis codes and prepare for their fetch by calling DB_GET_ALL_ANAL_CODES.
Input:
None
Output:
INTEGER	num_codes	Number of Analysis Codes in d.b.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_get_anal_code_count (p. 1408) in the MSC Acumen Toolkit - Code Example.


pref_get_anal_type_count	(anal_code, num_types )


Description:
Get the number of analysis types associated with ANAL_CODE and prepare for their fetch by calling DB_GET_ALL_ANAL_TYPES.
Input:
STRING	anal_code [31]	Default analysis code.
Output:
INTEGER	num_types	Number of Analysis Types in d.b.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_get_anal_type_count (p. 1409) in the MSC Acumen Toolkit - Code Example.


pref_get_next_anal_code	(anal_code )


Description:
Get next analysis code name.
Input:
None
Output:
STRING	anal_code[31]	Analysis Code Name.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

See example for pref_get_anal_code_count, 580. See also pref_get_next_anal_code (p. 1410) in the MSC Acumen Toolkit - Code Example.


pref_get_next_anal_type	(anal_type )


Description:
Get next analysis type.
Input:
None
Output:
STRING	anal_type[31]	Analysis type.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

See example for pref_get_anal_type_count, 581. See also pref_get_next_anal_type (p. 1411) in the MSC Acumen Toolkit - Code Example.


pref_global_get	(confirm, wm_opt, glo_mod_tol )


Description:
Get the Global Preference parameters.
Input:
None
Output:
LOGICAL	confirm	Confirm Flag.
INTEGER	wm_opt	Warning Message Option. 1=none 2=ring bell 3=non-modal form
REAL	glo_mod_tol	Global Model Tolerance.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_global_get (p. 1412) in the MSC Acumen Toolkit - Code Example.


pref_graphics_get	(disp_meth, p_color, s_color, e_color, extend, fit_view, center, hard_rend, anti_alias, td_vector, rt_display, s_light, p_marker, s_marker, m_color, m_size, gm_size, nm_size, l_format, nsigd )


Description:
Get the Graphics Preference parameters.
Input:
None
Output:
INTEGER	disp_meth	Display Method.
INTEGER	p_color	Primary Color.
INTEGER	s_color	Secondary Color.
INTEGER	e_color	Error Color.
LOGICAL	extend	Autoextend Flag.
LOGICAL	fit_view	Autofitview Flag.
LOGICAL	center	Autocenter Flag.
LOGICAL	hard_rend	Hardware Rendering Flag.
LOGICAL	anti_alias	Anti-Alias Flag.
LOGICAL	td_vector	3-D Vector Display Flag.
LOGICAL	rt_display	Result Title Display Flag.
LOGICAL	s_light	Symmetric Light Flag .
INTEGER	p_marker	Primary Marker.
INTEGER	s_marker	Secondary Marker.
INTEGER	m_color	Marker Color.
INTEGER	m_size	Marker Size.
INTEGER	gm_size	Grid Marker Size.
INTEGER	nm_size	Node Marker Size.
INTEGER	l_format	Results Label Format.
INTEGER	nsigd	Number of significant results digits.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_graphics_get (p. 1413) in the MSC Acumen Toolkit - Code Example.


pref_graphics_marker_data_get	(p_marker, s_marker, m_color, m_size )


Description:
Get the Graphics Preference parameters for markers.
Input:
None
Output:
INTEGER	p_marker	Primary Marker.
INTEGER	s_marker	Secondary Marker.
INTEGER	m_color	Marker Color.
INTEGER	m_size	Marker Size.
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_graphics_marker_data_get (p. 1416) in the MSC Acumen Toolkit - Code Example.


pref_entity_set	(set_flag, ed_prop, r_style, precision, fa_vectors, dv_results, d_defo, shcolor, gcolor, lcolor, pcolor, hpcolor, tscolor, bdcolor, ncolor, pecolor, bcolor, trcolor, qcolor, tecolor, wcolor, hecolor, mcolor, g_label, l_label, p_label, hp_label, ts_label, bd_label, n_label, pe_label, b_label, tr_label, q_label, te_label, w_label, he_label, m_label )


Description:
Set the Graphics Entity Types Preference parameters.
Input:
LOGICAL	set_flag(37)	Flag array for setting individual Preferences.
STRING	ed_prop[]	Entity Type Display Property.
STRING	r_style[]	Render Style.
INTEGER	precision	0=fast. 1=accurate.
LOGICAL	fa_vectors	Display Functional Ass. Vectors.
LOGICAL	dv_results	Display Vector Results Flag.
LOGICAL	d_defo	Display Deformation Flag.
INTEGER	shcolor	Shade Color.
INTEGER	gcolor	Grid Color.
INTEGER	lcolor	Line Color.
INTEGER	pcolor	Patch Color.
INTEGER	hpcolor	Hyperpatch Color.
INTEGER	tscolor	Trimmed Surface Color.
INTEGER	bdcolor	Body Color.
INTEGER	ncolor	Node Color.
INTEGER	pecolor	Point Element Color.
INTEGER	bcolor	Bar Color.
INTEGER	trcolor	Tri Color.
INTEGER	qcolor	Quad Color.
INTEGER	tecolor	Tet Color.
INTEGER	wcolor	Wedge Color.
INTEGER	hecolor	Hex Color.
INTEGER	mcolor	MPC Color.
LOGICAL	g_label	Grid Label Flag.
LOGICAL	l_label	Line Label Flag.
LOGICAL	p_label	Patch Label Flag.
LOGICAL	hp_label	Hyperpatch Label Flag.
LOGICAL	ts_label	Trimmed Surface Label Flag.
LOGICAL	bd_label	Body Label Flag.
LOGICAL	n_label	Node Label Flag.
LOGICAL	pe_label	Point Element Label Flag.
LOGICAL	b_label	Bar Label Flag.
LOGICAL	tr_label	Tri Label Flag.
LOGICAL	q_label	Quad Label Flag.
LOGICAL	te_label	Tet Label Flag.
LOGICAL	w_label	Wedge Label Flag.
LOGICAL	he_label	Hex Label Flag.
LOGICAL	m_label	MPC Label Flag.
Output:
INTEGER	<Return Value>	0: no error. 1: fatal error.
Error Conditions:
None.

Remarks:

None.

Example:

Please see pref_entity_set (p. 1393) in the MSC Acumen Toolkit - Code Example.