oms_buffer_enqueue()
Abstract
Attempts to enqueue a specified element in a buffer.
Syntax
oms_buffer_enqueue (buffer_handle, element, insert_data_ptr, insert_time)
| Argument | Type | Description |
|---|---|---|
buffer_handle |
OmsT_Buffer_Handle |
buffer object in which element is to be enqueued |
element |
void * |
element to attempt to enqueue |
insert_data_ptr |
void * |
user data pointer used with insertion criteria procedure |
insert_time |
double |
simulation time at which the element should be enqueued in the buffer |
Return Type
OmsT_Buffer_Enqueue
Result of the operation.
Details
This function attempts to enqueue the specified element in the buffer. Success depends on the availability of space in the buffer (in terms of elements and units) and an optional insertion procedure associated with the buffer. For more details on the insertion process, see Element Insertion.