Public Attributes | List of all members
XsCallbackPlainC Struct Reference

Structure that contains callback functions for the Xsens Device API. More...

#include <xscallbackplainc.h>

Public Attributes

void(* m_onAllBufferedDataAvailable )(struct XsCallbackPlainC *thisPtr, struct XsDevicePtrArray *devs, const struct XsDataPacketPtrArray *packets)
 Called when new data has been received for devices connected to the same main device. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...
 
void(* m_onAllDataAvailable )(struct XsCallbackPlainC *thisPtr, struct XsDevicePtrArray *devs, const struct XsDataPacketPtrArray *packets)
 Called when new data has been received for devices connected to the same main device. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...
 
void(* m_onAllLiveDataAvailable )(struct XsCallbackPlainC *thisPtr, struct XsDevicePtrArray *devs, const struct XsDataPacketPtrArray *packets)
 Called when new data has been received for devices connected to the same main device. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...
 
void(* m_onAllRecordedDataAvailable )(struct XsCallbackPlainC *thisPtr, struct XsDevicePtrArray *devs, const struct XsDataPacketPtrArray *packets)
 Called when new data has been received for devices connected to the same main device in a recording state or read from file. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...
 
void(* m_onBufferedDataAvailable )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, const struct XsDataPacket *packet)
 Called when XDA has a data packet that could be written to a log file. More...
 
void(* m_onConnectivityChanged )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, XsConnectivityState newState)
 Called when XDA has detected a change in the connectivity state of a device. More...
 
void(* m_onDataAvailable )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, const struct XsDataPacket *packet)
 Called when new data has been received from a device or read from a file. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...
 
void(* m_onDataUnavailable )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, int64_t packetId)
 Called when XDA detects that data is forever unavailable. More...
 
void(* m_onDeviceStateChanged )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, XsDeviceState newState, XsDeviceState oldState)
 Called when a device's state has changed (ie config mode, measurement mode, recording mode) More...
 
void(* m_onError )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, XsResultValue error)
 Called when an error has occurred while handling incoming data. More...
 
void(* m_onInfoResponse )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, XsInfoRequest request)
 Called when an information request has resulted in a response. More...
 
void(* m_onLiveDataAvailable )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, const struct XsDataPacket *packet)
 Called when new data has been received from a device or read from a file. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...
 
void(* m_onMessageDetected )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, XsProtocolType type, struct XsByteArray const *rawMessage)
 Called just after a message is detected in raw data from the device. More...
 
void(* m_onMessageReceivedFromDevice )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, struct XsMessage const *message)
 Called just after a valid message (after parsing) is received from the device. More...
 
void(* m_onMessageSentToDevice )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, struct XsMessage const *message)
 Called just after a message is sent to the device. More...
 
void(* m_onMissedPackets )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, int count, int first, int last)
 Called when XDA detects that packets have been missed. More...
 
void(* m_onNonDataMessage )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, struct XsMessage const *message)
 Called when a non data, non reply message has been received. More...
 
void(* m_onProgressUpdated )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, int current, int total, const struct XsString *identifier)
 Called when a long-duration operation has made some progress or has completed. Examples include loadLogFile and flushing of retransmissions (Awinda). When current == total the operation has completed. More...
 
void(* m_onRecordedDataAvailable )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, const struct XsDataPacket *packet)
 Called when new data has been received from a device in a recording state or read from a file. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...
 
void(* m_onRestoreCommunication )(struct XsCallbackPlainC *thisPtr, const struct XsString *portName, XsResultValue result)
 Called when restore communication is completed, stopped or an error occurred. More...
 
void(* m_onTransmissionRequest )(struct XsCallbackPlainC *thisPtr, int channelId, const struct XsByteArray *data)
 Called when XDA needs to send raw data to a device connected using a custom communication channel. More...
 
void(* m_onWakeupReceived )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev)
 Called when a wakeup message has been received from a device. This indicates that the device has just been reset or plugged in. More...
 
int(* m_onWriteMessageToLogFile )(struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, const struct XsMessage *message)
 Called when XDA has a message that could be written to a log file. More...
 

Detailed Description

Structure that contains callback functions for the Xsens Device API.

When using C++, please use the overloaded class XsCallback instead.

This structure contains pointers to functions that will be called by XDA when certain events occur. To use it in C, set any callback you do not wish to use to 0 and put a valid function pointer in the others. Then pass the object to an XsControl or XsDevice object's addCallbackHandler function.

Note
XDA does not copy the structure contents and does not take ownership of it. So make sure it is allocated on the heap or at least removed from wherever it was added by calling removeCallbackHandler before it is destroyed.

Definition at line 99 of file xscallbackplainc.h.


The documentation for this struct was generated from the following file:


xsens_mti_driver
Author(s):
autogenerated on Sun Sep 3 2023 02:43:22