op_hla_obj_create_notify()
Note: Requires High-Level Architecture functionality
Abstract
Notifies the RTI that an HLA object mapping the Riverbed Modeler object should be created.
Syntax
op_hla_obj_create_notify (objid, hla_name)
| Argument | Type | Description |
|---|---|---|
objid |
Objid |
object ID of Riverbed Modeler object-of-interest |
hla_name |
const char * |
name of the HLA object to create (or VOSC_NIL) |
Return Type
Compcode
Completion code indicating success or failure in creating the HLA object. The procedure returns OPC_COMPCODE_SUCCESS if the object was successfully created. It returns OPC_COMPCODE_FAILURE otherwise.
Example
op_hla_obj_create_notify (node_id, hla_name);
Details
If a simulation is responsible for creating HLA objects to map to Riverbed Modeler nodes and subnets, you can have the appropriate HLA instances created automatically by the HLA-PM when the simulation is started (creation mode of create) or you can delay these instantiations until later (creation mode of discover or dynamic). Later creation is initiated by a process model using op_hla_obj_create_notify(). This KP requests that the HLA-PM create an HLA instance. The creation (if possible) takes place immediately.
When Riverbed Modeler creates an HLA instance, registered process models are notified, using remote interrupts. The same notification process occurs when an object created by another federate is discovered.
Purpose
Provides a mechanism to dynamically create an HLA object.
Errors
- Recoverable Error: Objid (
<objid>) already mapped to an HLA object. - Recoverable Error: Unable to create HLA object to map Objid (
<objid>). - Recoverable Error: No HLA class can map to Objid (
<objid>). - Recoverable Error: The HLA class that can map Objid (
<objid>) does not allow dynamic creation in mapping file.
Reference
- Use the KP op_hla_obj_info_get() to obtain the HLA information associated with a Riverbed Modeler object