op_hla_obj_destroy_notify()
Note: Requires High-Level Architecture functionality
Abstract
Notifies the RTI that the mapped HLA object should be destroyed.
Syntax
op_hla_obj_destroy_notify (objid)
| Argument | Type | Description |
|---|---|---|
objid |
Objid |
object ID of Riverbed Modeler object-of-interest |
Return Type
Compcode
Completion code indicating success or failure in notifying the RTI of the object destruction. The procedure returns OPC_COMPCODE_SUCCESS if the object was successfully destroyed. It returns OPC_COMPCODE_FAILURE otherwise.
Example
op_hla_obj_destroy_notify (node_id);
Details
A process model can request the destruction of an HLA instance mapped to a Riverbed Modeler object only if that mapping was initiated by the Riverbed Modeler federate. The Riverbed Modeler federate can initiate a mapping by specifying a creation mode of create in the class mapping file or by using op_hla_obj_create_notify(). If possible, the HLA instance is destroyed immediately. When an HLA instance is destroyed, registered process models are notified via remote interrupts. The same notification process occurs when the HLA-PM is being informed by the RTI that an instance was destroyed by another federate.
Purpose
Provides a mechanism to dynamically destroy HLA objects.
Errors
- Recoverable Error: No HLA object mapped to Objid (
<objid>).
Reference
- Use the KP op_hla_obj_info_get() to obtain the HLA information associated with a Riverbed Modeler object