acumen_drive_page_trans | (source_page, converted_page) |
Description: | ||
This function serves as a PCL environment interface to the utility function that compiles or indexes XML “drive pages” for more efficient reading by the MSC Acumen software. The first argument references a source file with the .xml file extension. The second argument names the output indexed file with a .xio file extension. It is convenient for application authors to invoke this call from full featured MSC Patran by typing it into the command line. | ||
Input: | ||
STRING | source_page[ ] | This is a string representing the name of the XML drive page source file, for example, “model1.xml” |
STRING | converted_page[ ] | This is a string representing the name of the indexed or converted drive page, for example, “model1.xio” |
Output: | ||
An indexed and compressed .xio file is written out. |
aa_env.ret_acumen_app | (s_acumen_app, s_acumen_master, s_acumen_ext) |
Description: | ||
This function will retrieve the ACUMEN_APPLICATIONS directory and home drive page file name values. This function will also verify that the named directory and file exist. It will check date stamps on the named .xml and .xio file and translate the .xml file into a .xio file if needed. | ||
Status: | Public | |
Input: | ||
None. | ||
Output: | ||
STRING | s_acumen_app [ 1024 ] | |
This argument will return the ACUMEN_APPLICATIONS directory value. | ||
STRING | s_acumen_master [ 1024 ] | |
This argument will return the body of the home drive page file name defined by the ACUMEN_APPLICATIONS environment variable. | ||
STRING | s_acumen_ext [ 1024 ] | |
This argument will return the extension of the home drive page file name defined by the ACUMEN_APPLICATIONS environment variable. | ||
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: | ||
This function may return a nonzero value if an error occurs. |
1. | The master .xio and .xml files will be located directly in the home drive page directory defined by the environment variable ACUMEN_APPLICATIONS. |
2. | The .def file will have the same path and base file name as the application home drive page with a .def extension. |
3. | The labels file will have the same path and base file name as the application home drive page with a .labels extension. |
4. | All .html help files will be in a subdirectory named "help" under the home drive page directory. |
5. | The pulldown menu title definitions file will have the same path and base file name as the home drive page with a .dwn extension. |
6. | Application specific .plb files will have the same path and base file name as the home drive page with a .plb extension. If a file with the specified extension cannot be found, no application specific .plb’s will be linked in. |
7. | Application specific image files (.png) will be in a subdirectory named “app_images” located under the home drive page directory. |
aa_env.ret_acumen_app_aa | (s_acumen_app, s_acumen_master, s_acumen_ext) |
Description: | ||
This function will retrieve the ACUMEN_APPLICATIONS directory and home drive page file name values. This function will verify that the named directory and file exist. | ||
Input: | ||
None | ||
Output: | ||
STRING | s_acumen_app [ 1024 ] | This is a string representing the name of the XML drive page source file, for example, “model1.xml” |
STRING | s_acumen_master[ 1024 ] | This is a string representing the name of the indexed or converted drive page, for example, “model1.xio” |
STRING | s_acumen_ext [ 1024 ] | This argument will return the extension of the home drive page file name defined by the ACUMEN_APPLICATIONS environment variable. |
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: | ||
This function may return a nonzero value if an error occurs. |
aa_env.ret_acumen_brw | (s_acumen_brw) |
Description: | ||
This function will retrieve the directory and file name value defined by the "ACUMEN_BROWSER" environment variable. This function will verify that the named directory and file exist. | ||
Input: | ||
None | ||
Output: | ||
STRING | s_acumen_brw [ 1024 ] | This argument will return the path and filename of the browser application used to display Tutorial application help messages. |
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: | ||
This function may return a nonzero value if an error occurs. |
aa_env.ret_acumen_home | (s_acumen_home) |
Description: | ||
This function will retrieve the ACUMEN_HOME value and will check for the existance of the directory named. This value is used to identify the directory that contains the Tutorial core shared component. | ||
Input: | ||
None | ||
Output: | ||
STRING | s_acumen_home [ 1024 ] | This argument will return the current "ACUMEN_HOME" value. |
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: | ||
This function may return a nonzero value if an error occurs. |
aa_env.ret_acumen_html | (s_html) |
Description: | ||
This function returns the value of the "HTML_IMAGE_PATH" environment variable. This value is used to provide path information to the html browser widget used to implement the Tutorial user interface. | ||
Input: | ||
None | ||
Output: | ||
STRING | s_html [ 1024 ] | This argument will return the current "HTML_IMAGE_PATH" value. |
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: | ||
This function may return a nonzero value if an error occurs. |
aa_env.ret_acumen_int | (s_acumen_int) |
Description: | ||
This function will retrieve the "ACUMEN_INTERFACE" value. | ||
Input: | ||
None | ||
Output: | ||
STRING | s_acumen_int [ 1024 ] | This argument will the "ACUMEN_INTERFACE" value. |
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: | ||
This function may return a nonzero value if an error occurs. |
aa_env.ret_acumen_y_scale | (r_y_scale) |
Description: | ||
This function returns the "ACUMEN_Y_SCALE" value. This value is used to set a scaling factor for the form that comprises the Tutorial user interface. | ||
Input: | ||
None | ||
Output: | ||
STRING | r_y_scale | This argument will return the either a default value or the value to which "ACUMEN_Y_SCALE" has been set. |
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: | ||
This function may return a nonzero value if an error occurs. |
aa_env.set_acumen_html | (s_html) |
Description: | ||
This function sets the value of the "HTML_IMAGE_PATH" environment variable. This value is used to provide path information to the html browser widget used to implement the Tutorial user interface. | ||
Input: | ||
STRING | s_html [ 1024 ] | This argument will return the current "HTML_IMAGE_PATH" value. |
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: | ||
This function may return a nonzero value if an error occurs. |
aa_env.set_acumen_y_scale | (r_y_scale) |
Description: | ||
This function sets the "ACUMEN_Y_SCALE" value. This value is used to set a scaling factor for the form that comprises the Tutorial user interface. | ||
Input: | ||
STRING | r_y_scale | This argument will return the either a default value or the value to which "ACUMEN_Y_SCALE" has been set. |
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: | ||
This function may return a nonzero value if an error occurs. |
aa_env.validate_path | (s_src_path_file, s_trg_path_file) |
Description: | ||
This function will validate the existance of file with either no path, a partial path, or a full path exists. | ||
Input: | ||
STRING | s_src_path_file [ 1024 ] | This value defines the path and file name to be validated. |
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: | ||
This function may return a nonzero value if an error occurs. |
aaui_forms.html_refresh | ( ) |
Description: | ||
This function forces a refresh of the html browser widget in the Tutorial user interface. | ||
Input: | ||
None | ||
Output: | ||
None |
acumen_drive_page_trans | (source_page, converted_page) |
Description: | ||
This function compiles or indexes XML Tutorial drive pages efficient reading by the Tutorial software. | ||
Input: | ||
STRING | source_page[ ] | This is a string representing the name of the XML drive page source file, for example: “model1.xml” |
STRING | converted_page[ ] | This is a string representing the name of the converted drive page, for example: “model1.xio” |
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: | ||
This function will return a nonzero value if an error occurs. When an xio file is loaded the Tutorial code will automatically convert an xml drive page into an xio file if the xml file has a time stamp identifying it as newer than the xio file or if the xio file is missing. This makes it very easy to edit an xml file then see the results while a Tutorial application is running. Distributing xio pages without xml files will allow applications to be delivered without source files and preventing the application from being modified. |
get_acumen_app | (s_app) |
Description: | ||
This function returns the "ACUMEN_APPLICATIONS" value. | ||
Input: | ||
None | ||
Output: | ||
STRING | s_app [1024] | This string will return: 1. The value of the the acumen app string if set. 2. The value of the "ACUMEN_APPLICATIONS" environment variable if it is set and the acumen app string has not been set or is zero length. 3. A default value of "ACUMEN_HOME"/tutorial_apps/tutorial.xio 4. A value of "tutorial_apps/tutorial.xio" |
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: | ||
This function will return a nonzero value if an error occurs. |
get_acumen_brw | (s_brw) |
Description: | ||
This function returns the "ACUMEN_BROWSER" value. | ||
Input: | ||
None | ||
Output: | ||
STRING | s_brw [1024] | This string will return: 1. The value of the the acumen browser string if set. 2. The value of the "ACUMEN_BROWSER" environment variable if it is set and the acumen browser string has not been set or is zero length. |
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: | ||
This function will return a nonzero value if an error occurs. |
get_acumen_debug | (i_debug) |
Description: | ||
This function returns the "ACUMEN_DEBUG" value. | ||
Input: | ||
None | ||
Output: | ||
INTEGER | i_debug | This value is used to control or turn on the listing of debug information. This function will return: 1. The value of the the acumen debug value if set. 2. The value of the "ACUMEN_DEBUG" environment variable if it is set and the acumen browser string has not been set or is zero length. |
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: | ||
This function will return a nonzero value if an error occurs. |
get_acumen_home | (s_acumen_home) |
Description: | ||
This function will retrieve the ACUMEN_HOME value without checking for the existance of the directory named. This value is used to identify the directory that contains the Tutorial core shared component. | ||
Input: | ||
None | ||
Output: | ||
INTEGER | s_acumen_home [ 1024 ] | This argument will return the current "ACUMEN_HOME" value. |
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: | ||
This function will return a nonzero value if an error occurs. |
get_acumen_int | (s_acumen_int) |
Description: | ||
This function will retrieve the "ACUMEN_INTERFACE" value. | ||
Input: | ||
None | ||
Output: | ||
INTEGER | s_acumen_int [ 1024 ] | This argument will the "ACUMEN_INTERFACE" value. |
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: | ||
This function will return a nonzero value if an error occurs. |
get_acumen_y_scale | (r_y_scale) |
Description: | ||
This function returns the "ACUMEN_Y_SCALE" value. This value is used to set a scaling factor for the form that comprises the Tutorial user interface. | ||
Input: | ||
None | ||
Output: | ||
INTEGER | r_y_scale | This argument will return the either a default value or the value to which "ACUMEN_Y_SCALE" has been set. |
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: | ||
This function will return a nonzero value if an error occurs. |
set_acumen_app | (s_app) |
Description: | ||
This function sets the "ACUMEN_APPLICATIONS" value. | ||
Input: | ||
STRING | s_app [1024] | The value to which "ACUMEN_APPLICATONS" is set. |
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: | ||
This function will return a nonzero value if an error occurs. |
set_acumen_brw | (s_brw) |
Description: | ||
This function sets the "ACUMEN_BROWSER" value. | ||
Input: | ||
STRING | s_brw [1024] | This string is used to set the "ACUMEN_BROWSER" value. |
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: | ||
This function will return a nonzero value if an error occurs. |
set_acumen_debug | (i_debug) |
Description: | ||
This function sets the "ACUMEN_DEBUG" value. | ||
Input: | ||
STRING | i_debug | This value is used to control or turn on the listing of debug information. |
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: | ||
This function will return a nonzero value if an error occurs. |
set_acumen_home | (s_acumen_home) |
Description: | ||
This function set the ACUMEN_HOME value. | ||
Input: | ||
STRING | s_acumen_home [ 1024 ] | This argument will set the current "ACUMEN_HOME" value. |
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: | ||
This function will return a nonzero value if an error occurs. |
set_acumen_int | (s_acumen_int) |
Description: | ||
This function will set the "ACUMEN_INTERFACE" value. | ||
Input: | ||
STRING | s_acumen_int [ 1024 ] | This argument will the "ACUMEN_INTERFACE" value. |
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: | ||
This function will return a nonzero value if an error occurs. |
aa_env.ret_acumen_brw | (s_acumen_brw) |
Description: | ||
This function will retrieve the acumen_browser directory and file name value. This function will verify that the named directory and file exist. | ||
Status: | Public | |
Input: | ||
None. | ||
Output: | ||
STRING | s_acumen_brw [ 1024 ] | |
This argument will return the path and filename of the browser application used to display MSC Acumen application help messages. | ||
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: | ||
This function may return a nonzero value if an error occurs. |
aa_env.ret_acumen_home | (s_acumen_home) |
Description: | ||
This function will retrieve the acumen_home directory value and will check for the existance of the directory used to contain the MSC Acumen core shared component. | ||
Status: | Public | |
Input: | ||
None. | ||
Output: | ||
STRING | s_acumen_home [ 1024 ] | |
This argument will return the current acumen_home value. | ||
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: | ||
This function will return a nonzero value if an error occurs. |
aa_env.ret_acumen_int | ( s_acumen_int ) |
Description: | ||
This function will retrieve the acumen_interface value | ||
Status: | Public | |
Input: | ||
None. | ||
Output: | ||
STRING | s_acumen_int [1024 ] | This argument will return the path and filename of the browser application used to display MSC Acumen application help messages. |
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: | ||
This function may return a nonzero value if an error occurs. |
aa_env.validate_path | ( s_src_path_file, s_trg_path_file) |
Description: | ||
This function will validate the existance of file with either no path, a partial path, or a full path really exists. | ||
Status: | Public | |
Input: | ||
STRING | s_src_path_file [ 1024 ] | |
Output: | ||
STRING | s_trg_path_file [ 1024 ] | |
This value returns a string representing the path used for the test. | ||
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: | ||
This function may return a nonzero value if an error occurs. |