Ovis_Entity_From_Rti_Create()
Abstract
Creates an entity structure for an existing RTI object.
Syntax
Ovis_Entity_From_Rti_Create (obj_handle, objid, destroy_proc, state_ptr)
| Argument | Type | Description |
|---|---|---|
obj_handle |
RTI::ObjectHandle |
RTI object of interest |
objid |
Objid |
Simulation object ID |
destroy_proc |
OvisT_Entity_State_Destroy_Proc |
Callback function that will destroy the entity's state when the entity is destroyed |
state_ptr |
void * |
Optional user-provided state |
Return Type
OvisT_Entity *
Returns the entity, or OVISC_NIL.
Header
ovis_entity.h
Details
This function is defined only when an appropriate RTI development environment is available. (Riverbed does not provide such an environment.)
Errors
- Object ID (
<objid>) is out-of-range. - Object ID (
<objid>) refers to a restricted object. - Object (
<hname>) is not a fixed or mobile node or subnet.
Reference
- Use the function
Ovis_Entity_Create()to create an entity that can also create an RTI object (viaOvis_Entity_Animation_Enable()).