Home

Callback Functions
[Base Functionality]

Collaboration diagram for Callback Functions:

Classes

class  entity_notification_handler
 Allows an application to notify its sub-systems of ENTITY events. More...
class  exit_callback
 Executes standard exit for ACIS. More...
class  input_callback
 Creates the standard input for ACIS. More...
class  output_callback
 Creates output callback standard output for ACIS. More...
class  SPA_progress_info
 Abstract base class for providing progress information. More...
class  toolkit_callback
 Defines the toolkit_callback base class and the toolkit_callback_list class. More...
class  toolkit_callback_list
 Stores the list of toolkit_callbacks. More...
class  WCS_callback
 Provides notification of changes to the WCS. More...
class  WCS_callback_list
 Provides a type-safe interface to toolkit_callback_list class and the execute command. More...

Typedefs

typedef void(* ACIS_Interrupt_Checker )(const char *)
 Defined callback function type for set_acis_interrupt_checker.
typedef int(* SPA_progress_callback )(SPA_progress_info *)
 Pointer to a function implementing a generic ACIS progress meter.

Enumerations

enum  SPA_progress_info_type_id
 Specifies the ACIS functionality associated with a given progress metering. More...

Functions

void add_acis_exit_cb (exit_callback *cb)
 Registers a new exit callback for ACIS.
void add_acis_input_cb (input_callback *cb)
 Registers a new input callback for ACIS.
void add_acis_output_cb (output_callback *cb)
 Registers a new output callback for ACIS.
SPA_progress_callback get_progress_callback (SPA_progress_info_type_id pitid)
 Function for returning a registered progress callback function pointer.
void remove_acis_exit_cb (exit_callback *cb)
 Unregisters an exit callback for ACIS.
void remove_acis_input_cb (input_callback *cb)
 Unregisters a new input callback for ACIS.
void remove_acis_output_cb (output_callback *cb)
 Unregisters an output callback for ACIS.
ACIS_Interrupt_Checker set_acis_interrupt_checker (ACIS_Interrupt_Checker interrupt_checker)
 Installs an interrupt checker that can be used to interrupt ACIS.
logical set_progress_callback (SPA_progress_callback callback_func_ptr)
 Function for registering a progress callback function pointer.
logical set_progress_callback (SPA_progress_callback callback_func_ptr, SPA_progress_info_type_id type)
 Function for registering a progress callback function pointer.

Typedef Documentation

typedef void(* ACIS_Interrupt_Checker)(const char *)

Defined callback function type for set_acis_interrupt_checker.

Pointer to a function implementing a generic ACIS progress meter.


Enumeration Type Documentation

Specifies the ACIS functionality associated with a given progress metering.

Parameters:
SPA_progress_info_UNKNOWN unknown - progress metering is not in a valid state.
SPA_progress_info_RESTORE SAT file restore.
SPA_progress_info_STITCH tolerant stitching.
SPA_progress_info_ADV_COVER advanced covering.
SPA_progress_info_DEFEATURE defeaturing.
SPA_progress_info_HA_RENDER rendering.

include <spa_progress_info.hxx>


Function Documentation

void add_acis_exit_cb ( exit_callback cb  ) 

Registers a new exit callback for ACIS.



Parameters:
cb callback to register.

include <acexit.hxx>

void add_acis_input_cb ( input_callback cb  ) 

Registers a new input callback for ACIS.



Parameters:
cb callback to register.

include <acinput.hxx>

void add_acis_output_cb ( output_callback cb  ) 

Registers a new output callback for ACIS.



Parameters:
cb callback to register.

include <acoutput.hxx>

SPA_progress_callback get_progress_callback ( SPA_progress_info_type_id  pitid  ) 

Function for returning a registered progress callback function pointer.



Role: This routine returns the currently installed progress callback function for a specified SPA_progress_info_type_id callback type.

Parameters:
pitid the progress type id.

include <spa_progress_info.hxx>

void remove_acis_exit_cb ( exit_callback cb  ) 

Unregisters an exit callback for ACIS.



Parameters:
cb callback to register.

include <acexit.hxx>

void remove_acis_input_cb ( input_callback cb  ) 

Unregisters a new input callback for ACIS.



Parameters:
cb callback to register.

include <acinput.hxx>

void remove_acis_output_cb ( output_callback cb  ) 

Unregisters an output callback for ACIS.



Parameters:
cb callback to unregister.

include <acoutput.hxx>

ACIS_Interrupt_Checker set_acis_interrupt_checker ( ACIS_Interrupt_Checker  interrupt_checker  ) 

Installs an interrupt checker that can be used to interrupt ACIS.



Role: Installing an interrupt checker with set_acis_interrupt_checker allows the application to gracefully interrupt the current ACIS operation and regain control of the process. This is a useful feature when applications want to be responsive to end-user input, such as responding to Control-C input during lengthy operations. This function allows one to install a callback function that is frequently called from various places within ACIS code so that application side events can be evaluated. The callback function receives an informative string, which describes the current function in ACIS, as a passed in argument. The application can simply return from the callback, which allows the operation to continue; call the interrupt_acis function, which will interrupt the process in a synchronous manner; or call the sys_error function with the SIGINT_FAULT argument, which will interrupt the operation asynchronously (immediately).

Parameters:
interrupt_checker Customer callback function.

include <ctrlc.hxx>

logical set_progress_callback ( SPA_progress_callback  callback_func_ptr  ) 

Function for registering a progress callback function pointer.



Role: The callback mechanism is enabled by registering a user callback function with the set_progress_callback function. This signature of set_progress_callback takes a single argument: the user callback function, and registers it for all available ACIS functionality, which includes part restore, stitching, advanced covering, defeaturing, and rendering.

Parameters:
callback_func_ptr user callback function pointer.

include <spa_progress_info.hxx>

logical set_progress_callback ( SPA_progress_callback  callback_func_ptr,
SPA_progress_info_type_id  type 
)

Function for registering a progress callback function pointer.



Role: The callback mechanism is enabled by registering a user callback function with the set_progress_callback function. This signature of set_progress_callback takes two arguments: the user callback function, and the type of functionality being instrumented.

Parameters:
callback_func_ptr user callback function pointer.
type type of ACIS functionality being instrumented.

include <spa_progress_info.hxx>