C API ZIEvent StructΒΆ
This struct holds event data forwarded by the Data Server.
ZIEvent is used to give out events like value changes or errors to the user. Event handling functionality is provided by ziAPIPollDataWithGroup. ziAPIPollDataWithGroup
| Name | Type | Description |
|---|---|---|
| valueType | uint32_t | Specifies the type of the data held by the ZIEvent, see ZIValueType_enum. |
| count | uint32_t | Number of values available in this event. |
| path | uint8_t | The path to the node from which the event originates. |
| untyped | void * | For convenience. The void field doesn't have a corresponding data type. |
| doubleData | ZIDoubleData * | when valueType == ZI_VALUE_TYPE_DOUBLE_DATA |
| doubleDataTS | __ ZIDoubleDataTS *__ | when valueType == ZI_VALUE_TYPE_DOUBLE_DATA_TS |
| integerData | ZIIntegerData * | when valueType == ZI_VALUE_TYPE_INTEGER_DATA |
| integerDataTS | __ ZIIntegerDataTS *__ | when valueType == ZI_VALUE_TYPE_INTEGER_DATA_TS |
| complexData | __ ZIComplexData *__ | when valueType == ZI_VALUE_TYPE_COMPLEX_DATA |
| byteArray | __ ZIByteArray *__ | when valueType == ZI_VALUE_TYPE_BYTE_ARRAY |
| byteArrayTS | __ ZIByteArrayTS *__ | when valueType == ZI_VALUE_TYPE_BYTE_ARRAY_TS |
| cntSample | __ ZICntSample *__ | when valueType == ZI_VALUE_TYPE_CNT_SAMPLE |
| trigSample | __ ZITrigSample *__ | when valueType == ZI_VALUE_TYPE_TRIG_SAMPLE |
| treeChangeData | __ ZITreeChangeData *__ | when valueType == ZI_VALUE_TYPE_TREE_CHANGE_DATA |
| treeChangeDataOld | __ TreeChange *__ | when valueType == ZI_VALUE_TYPE_TREE_CHANGE_DATA_OLD |
| demodSample | __ ZIDemodSample *__ | when valueType == ZI_VALUE_TYPE_DEMOD_SAMPLE |
| auxInSample | __ ZIAuxInSample *__ | when valueType == ZI_VALUE_TYPE_AUXIN_SAMPLE |
| dioSample | __ ZIDIOSample *__ | when valueType == ZI_VALUE_TYPE_DIO_SAMPLE |
| scopeWave | __ ZIScopeWave *__ | when valueType == ZI_VALUE_TYPE_SCOPE_WAVE |
| scopeWaveEx | __ ZIScopeWaveEx *__ | when valueType == ZI_VALUE_TYPE_SCOPE_WAVE_EX |
| scopeWaveOld | __ ScopeWave *__ | when valueType == ZI_VALUE_TYPE_SCOPE_WAVE_OLD |
| pwaWave | __ ZIPWAWave *__ | when valueType == ZI_VALUE_TYPE_PWA_WAVE |
| sweeperWave | ZISweeperWave * | when valueType == ZI_VALUE_TYPE_SWEEPER_WAVE |
| spectrumWave | ZISpectrumWave * | when valueType == ZI_VALUE_TYPE_SPECTRUM_WAVE |
| advisorWave | ZIAdvisorWave * | when valueType == ZI_VALUE_TYPE_ADVISOR_WAVE |
| asyncReply | ZIAsyncReply * | when valueType == ZI_VALUE_TYPE_ASYNC_REPLY |
| vectorData | __ ZIVectorData *__ | when valueType == ZI_VALUE_TYPE_VECTOR_DATA |
| impedanceSample | __ ZIImpedanceSample *__ | when valueType == ZI_VALUE_TYPE_IMPEDANCE_SAMPLE |
| error | ZIError * | when valueType == ZI_VALUE_TYPE_ERROR |
| alignment | uint64_t | ensure union size is 8 bytes |
| value | union ZIEvent::@6 | Convenience pointer to allow for access to the first entry in Data using the correct type according to ZIEvent.valueType field. |
| data | uint8_t | The raw value data. Never access the data field directly. When a ZIEvent is allocated internally by the API (e.g. by a call to ziAPIPollDataWithGroup) the data array may have a size different from MAX_EVENT_SIZE. The available amount of data is determined bycount andvalueType. |