op_hla_obj_notification_disable()
Note: Requires High-Level Architecture functionality
Abstract
Indicates to the HLA-PM that RTI object mapping, attribute updates, or object unmapping for the specified object should not generate a remote interrupt for the caller anymore.
Syntax
op_hla_obj_notification_disable (objid)
| Argument | Type | Description |
|---|---|---|
objid |
Objid |
object ID of object which was previously used in a op_hla_obj_notification_enable() call |
Return Type
Compcode
Completion code indicating success or failure in queuing the request. The procedure returns OPC_COMPCODE_SUCCESS if the request was successfully queued for later processing by the HLA-PM. It returns OPC_COMPCODE_FAILURE otherwise.
Example
Using an interaction to disable notification
Packet * pk_ptr;
unsigned long hla_id;
Objid opnet_id;
/* Extract the HLA ID from an incoming interaction */
pk_ptr = op_pk_get (op_intrpt_strm());
op_pk_nfd_get(pk_ptr, “HLA ID”, &hla_id);
op_pk_destroy(pk_ptr);
if (op_hla_id_hla_to_opnet_map(hla_id, &opnet_id) == OPC_COMPCODE_SUCCESS)
{
op_hla_obj_notification_disable(opnet_id);
}
Details
A request to stop being notified of mapping changes for an object is only processed by the HLA-PM when it executes later on during the same simulation time. If there are pending remote interrupts related to the object ID used in the KP, they will be delivered to the invoker of the KP before the HLA-PM processes the notification disable request.
Purpose
Provides a mechanism to stop being informed when RTI attribute updates are received for an object.
Errors
- Recoverable Error: Objid (
<objid>): Unable to queue attribute update notification cancellation for objid (<objid>). (due to memory allocation failure)
Reference
- Use the KP op_hla_obj_notification_enable() to request notification whenever an object is mapped/unmapped to an RTI object, or when the attribute of an object is modified by external simulations
- Use the KP op_hla_attr_update_list_get() to obtain the list of names of attributes that were modified in the last update