OvisT_Anim_Receiver_Destroy_Proc
Abstract
Callback: Invoked before the simulation kernel destroys a receiver object.
Syntax
<anim_receiver_destroy_proc_name> (rcpt_ptr, state_ptr)
| Argument | Type | Description |
|---|---|---|
rcpt_ptr |
OvisT_Receiver * |
Pointer to the receiver object about to be destroyed by the simulation kernel |
state_ptr |
void * |
State information returned by the OvisT_Anim_Receiver_Init_Proc |
Return Type
void
No return value.
Header
ovis_transmission_anim.h
Details
This callback is invoked by the simulation kernel before the receiver object is destroyed. This occurs if any of the following conditions are true:
- The Ovis entity associated with the receiver's node is destroyed
- The receiver channel no longer belongs to a receiver group of a transmitter channel with a transmitter object
- All related transmitter objects have been destroyed
This allows any associated user state to be destroyed appropriately.