General Access to the State Table

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">

AASTATE.record_dialog	(file_name, step_id, dialog_id)

Description:
This function will record dialog id as encountered. This is used to establish a work flow history.
Input:
STRING	file_name[4096]	This value specifies file name to the XML drive page. If the <file_name> starts with a “/” then it is assumed to be a full path, otherwise, the value for the environment variable AdvisorLIB is prepended to the file name.
STRING	step_id[4]	This value specifies the step id as listed on the page.
STRING	dialog_id[4096]	This value specifies the dialog id as listed on the page.
Output:
Error Conditions:
None.

Description:

This function will record dialog id as encountered. This is used to establish a work flow history.

Input:

STRING

file_name[4096]

This value specifies file name to the XML drive page. If the <file_name> starts with a “/” then it is assumed to be a full path, otherwise, the value for the environment variable AdvisorLIB is prepended to the file name.

STRING

step_id[4]

This value specifies the step id as listed on the page.

STRING

dialog_id[4096]

This value specifies the dialog id as listed on the page.

Output:

Error Conditions:

None.

The application author is not expected to use this interface call. The platform software automatically makes this call while processing <dialog>.

AASTATE.record_lrule	(file_name, step_id, rule_id)

Description:
This function will record link rule id as encountered and processed. This is used to establish a work flow history.
Input:
STRING	file_name[4096]	This value specifies file name to the XML drive page. If the <file_name> starts with a “/” then it is assumed to be a full path, otherwise, the value for the environment variable AdvisorLIB is prepended to the file name.
STRING	step_id[4]	This value specifies the step id as listed on the page.
STRING	rule_id[4096]	This value specifies the rule id as listed on the page.
Output:
Error Conditions:
None.

Description:

This function will record link rule id as encountered and processed. This is used to establish a work flow history.

Input:

STRING

file_name[4096]

STRING

step_id[4]

This value specifies the step id as listed on the page.

STRING

rule_id[4096]

This value specifies the rule id as listed on the page.

Output:

Error Conditions:

None.

The application author is not expected to make this interface call. The platform software automatically makes this call upon processing automated link rules when the user selects an analysis step.

AASTATE.previous_dialog	(file_name, step_id, dialog_id, null_flag)

Description:
This function will return the address of the previous dialog as recorded in the dialog history of the State Table
Input:
Output:
STRING	file_name[4096]	This value returns file name to the XML drive page.
STRING	step_id[4]	This value returns the step id as listed on the page.
STRING	dialog_id[4096]	This value returns the dialog id as listed on the page.
Error Conditions:
None.

Description:

This function will return the address of the previous dialog as recorded in the dialog history of the State Table

Input:

Output:

STRING

file_name[4096]

This value returns file name to the XML drive page.

STRING

step_id[4]

This value returns the step id as listed on the page.

STRING

dialog_id[4096]

This value returns the dialog id as listed on the page.

Error Conditions:

None.

The application author is not expected to make this interface call. The platform software uses this call to obtain previous dialog when the user selects the “Dialog Backup” button.

AASTATE.dumphistory	()

Description:
This function will print the history of link rule IDs and dialog IDs encountered plus the recorded user responses to a file or the history window for debug purposes.
Input:
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.

Description:

This function will print the history of link rule IDs and dialog IDs encountered plus the recorded user responses to a file or the history window for debug purposes.

Input:

Output:

INTEGER

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.

This call is useful for debugging purposes, or for obtaining a modeling session history of user choices made.

AASTATE.store_objectives	()

Description:
This function will write the State Table in present form to the database.
Input:
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:

Description:

This function will write the State Table in present form to the database.

Input:

Output:

INTEGER

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:

The application author is expected to call this function at the close of each analysis step.

AASTATE.restore_oldstate	()

Description:
This function reads a previously recorded State Table from an exiting database back into memory. The application author should call this function after re-opening an existing database.
Input:
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:

Description:

This function reads a previously recorded State Table from an exiting database back into memory. The application author should call this function after re-opening an existing database.

Input:

Output:

INTEGER

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:

After obtaining all State Table data and determining which steps have been completed, this function makes the lower level function call STATEUT.nextstep_switch_on(current_step) to automatically select the next uncompleted step and to display the first dialog of that step.