PCL Reference Manual > Preference Functions > Global Preferences
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Global Preferences
This section is used to describe some of the functions used to govern some of the preferences used to control the global behavior of Patran
.
pref_geo_get_v1
(default_coord_frame, geometric_tolerance, working_plane)
Description:
 
 
This function will get geometry preference settings.
Input:
 
 
None.
 
 
Output:
 
 
INTEGER
default_coord_frame
This value returns the identifier value for the default coordinate frame.
REAL
geometric_tolerance
This value returns the relative geometric tolerance.
INTEGER
working_plane
This value returns the value defining the default working plane relative to the default coordinate frame.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
None.
 
 
Remarks:
This function is used in the implementation of the form that is displayed when “Preferences”, “Global...” is selected from the menu bar.
Example:
Please see pref_geo_get_v1.
pref_geo_get
(default_coord_frame, geometric_tolerance)
Description:
 
 
This function will get geometry preference settings.
Input:
 
 
None.
 
 
Output:
 
 
INTEGER
default_coord_frame
This value returns the identifier value for the default coordinate frame.
REAL
geometric_tolerance
This value returns the relative geometric tolerance.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
None.
 
 
Example:
Please see pref_geo_get.
pref_geo_set
(default_coord_frame, geometric_tolerance)
Description:
 
 
This function will set geometry preference settings.
Input:
 
 
INTEGER
default_coord_frame
This value specifies the identifier value for the default coordinate frame.
REAL
geometric_tolerance
This value specifies the relative geometric tolerance.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
None.
 
 
 
 
Remarks:
The geometric tolerance is set to 0.005 for the default value. This value needs to be changed depending on the model size. Users are advised to set this value so that CAD models and IGES geometry are imported properly. The suggested geometry tolerance is 0.005 times the model size.
Example:
Please see pref_geo_set.
pref_geo_set_v1
(default_coord_frame, geometric_tolerance, working_plane)
Description:
 
 
This function will set geometry preference settings.
Input:
 
 
INTEGER
default_coord_frame
This value specifies the identifier value for the default coordinate frame.
REAL
geometric_tolerance
This value specifies the relative geometric tolerance.
INTEGER
working_plane
This value specifies the value defining the default working plane relative to the default coordinate frame. Valid values are: 1 = to place the working plane along the X, Y axis, 2 = the Y, Z axis, and 3 = the X, Z axis.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
None.
 
 
Remarks:
This function is used in the implementation of the form that is displayed when “Preferences”, “Global...” is selected from the menu bar.
The geometric tolerance is set to 0.005 for the default value. This value needs to be changed depending on the model size. Users are advised to set this value so that CAD models and IGES geometry are imported properly. The suggested geometry tolerance is 0.005 times the model size.
Example:
Please see pref_geo_set_v1.
 
pref_global_get
(confirm, warning_message, global_tolerance)
Description:
 
 
This function will get global preference settings.
Input:
 
 
None.
 
 
Output:
 
 
LOGICAL
confirm
This value returns nothing as it is currently not used.
INTEGER
warning_message
This value returns the status for the warning message option. This value will be set to: 1 = no warnings, 2 = ring the bell, and 3 = present a warning in a popup form.
REAL
global_tolerance
This value returns the global model tolerance.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
None.
 
 
Remarks:
This function is used in the implementation of the form that is displayed when “Preferences”, “Global...” is selected from the menu bar.
Example:
Please see pref_global_get.
pref_global_set
(confirm, warning_message, global_tolerance)
Description:
 
 
This function will set global preference settings.
Input:
 
 
LOGICAL
confirm
This value specifies nothing as it is currently not used.
INTEGER
warning_message
This value specifies the status for the warning message option. This value will be set to: 1 = no warnings, 2 = ring the bell, and 3 = present a warning in a popup form.
REAL
global_tolerance
This value specifies the global model tolerance.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
None.
 
 
Remarks:
This function is used in the implementation of the form that is displayed when “Preferences”, “Global...” is selected from the menu bar.
Example:
Please see pref_global_set.
 
pref_env_get_integer
(preference_name, integer_value)
Description:
 
 
This function will get the value of the named integer preference.
Input:
 
 
STRING
preference_name[]
This value specifies the name of the preference from which the output value integer_value will be retrieved This name can be of any length or value.
Output:
 
 
INTEGER
integer_value
This value returns the integer setting for the preference.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
12002001
The environment preference was not found.
12002002
The environment preference is of the wrong datatype.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked list in memory. The contents of this linked list are saved and restored through the settings.pcl file mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Please see pref_env_get_integer.
 
pref_env_get_logical
(preference_name, logical_value)
Description:
 
 
This function will get the value of the named logical preference.
Input:
 
 
STRING
preference_name[]
This value specifies the name of the preference from which the output value logical_value will be retrieved. This name can be of any length.
Output:
 
 
LOGICAL
logical_value
This value returns the logical setting for the preference.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
12002001
The environment preference was not found.
12002002
The environment preference is of the wrong datatype.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked list in memory. The contents of this linked list are saved and restored through the settings.pcl file mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Please see pref_env_get_logical.
pref_env_get_real
(preference_name, real_value)
Descriptio:
 
 
This function will get the value of the named real preference.
Input:
 
 
STRING
preference_name[]
This value specifies the name of the preference from which the output value real_value will be retrieved. This name can be of any length.
Output:
 
 
REAL
real_value
This value returns the real setting for the preference.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
12002001
The environment preference was not found.
12002002
The environment preference is of the wrong datatype.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked list in memory. The contents of this linked list are saved and restored through the settings.pcl file mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Please see pref_env_get_real.
pref_env_get_string
(preference_name, string_value)
 
Description:
 
 
This function will get the value of the named string preference.
Input:
 
 
STRING
preference_name[]
This value specifies the name of the preference from which the output value string_value will be retrieved. This name can be of any length.
Output:
 
 
STRING
string_value[]
This value returns the string setting for the preference. Because this is not a VIRTUAL string and no storage space is allocated for this string by this function, it must be created big enough to contain the entire named string preference value or an error will occur.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
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:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked list in memory. The contents of this linked list are saved and restored through the settings.pcl file mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Please see pref_env_get_string.
pref_env_set_integer
(preference_name, integer_value)
Description:
 
 
This function will set the value of the named integer preference.
Input:
 
 
STRING
preference_name[]
This value specifies the name of the preference under which the input value integer_value will be stored. This name can be of any length.
INTEGER
integer_value
This value specifies the integer setting for the named preference.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
12002002
The environment preference is of the wrong datatype.
12002004
An error occurred creating an environment preference.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked list in memory. The contents of this linked list are saved and restored through the settings.pcl file mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Please see pref_env_set_integer.
pref_env_set_logical
(preference_name, logical_value)
Description:
 
 
This function will set the value of the named logical preference.
Input:
 
 
STRING
preference_name[]
This value specifies the name of the preference under which the input value logical_value will be stored. This name can be of any length.
LOGICAL
logical_value
This value specifies the logical setting for the named preference.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
12002002
The environment preference is of the wrong datatype.
12002004
An error occurred creating an environment preference.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked list in memory. The contents of this linked list are saved and restored through the settings.pcl file mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Please see pref_env_set_logical.
pref_env_set_real
(preference_name, real_value)
Description:
 
 
This function will set the value of the named real preference.
Input:
 
 
STRING
preference_name[]
This value specifies the name of the preference under which the input value real_value will be stored. This name can be of any length.
REAL
real_value
This value specifies the real setting for the named preference.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
12002002
The environment preference is of the wrong datatype.
12002004
An error occurred creating an environment preference.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked list in memory. The contents of this linked list are saved and restored through the settings.pcl file mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Please see pref_env_set_real.
pref_env_set_string
(preference_name, string_value)
Description:
 
 
This function will set the value of the named real preference.
Input:
 
 
STRING
preference_name[]
This value specifies the name of the preference under which the input value string_value will be stored. This name can be of any length.
STRING
string_value[]
This value specifies the string setting for the named preference and can be of any length.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
12002002
The environment preference is of the wrong datatype.
12002004
An error occurred creating an environment preference.
Remarks:
This is one of the functions used in the settings.pcl file to store various values used when Patran is started up.
The values retrieved or stored by this function are not placed in the database. They are stored in a linked list in memory. The contents of this linked list are saved and restored through the settings.pcl file mechanism. This settings.pcl file is written on exit from Patran and read when Patran is started up.
Example:
Please see pref_env_set_string.