C Interface

Macros
#define	XS_BID_BROADCAST   0x00
	The bus broadcast bus identifier (all devices) More...
#define	XS_BID_DYNAMIC   0xFE
	A dynamic bus identifier. More...
#define	XS_BID_INVALID   0xFD
	An invalid bus identifier. More...
#define	XS_BID_MASTER   0xFF
	The bus identifier of the master device. More...
#define	XS_BID_MT   0x01
	The bus identifier for the first MT on the bus. More...

Typedefs
typedef union Itypes	Itypes
typedef FILE	XsFileHandle
	The type that is used for low-level identification of an open file. More...
typedef int64_t	XsFilePos
	The type that is used for positioning inside a file. More...
typedef int32_t	XsIoHandle
	The type that is used for low-level identification of an open I/O device. More...

Functions
uint8_t	byteSum (const uint8_t *buffer, XsSize count)
	Calculate the sum of the values in the buffer. More...
static XsVector *	convertedVector (const XsDataPacket *thisPtr, XsVector *returnVal, XsDataIdentifier id, XsUShortVector XsScrData::*field)
static double	convertFromFloat (float f)
static void	convertRawVector (XsUShortVector const &input, XsDataIdentifier id, XsVector &returnVal)
	Converts input vector input with data identifier id to output XsVector returnVal. More...
static float	convertToFloat (double d)
static int	fuzzyIsEqual (double a, double b, double tolerance)
	Checks whether a and b are equal with tolerance tolerance. More...
static FILE *	openFile (const struct XsString *filename, const struct XsString *mode)
	Helper for file opening. More...
static void	removeAllOrientations (XsDataPacket *thisPtr)
	Removes all orientations from the datapacket. More...
static XsReal	signed_cast (uint16_t v)
	helper for XsDataPacket_convertRawVector More...
static void	swapEndian (void *data, const XsSize size)
	Swap the endianness based on the data size. More...
static XsReal	unsigned_cast (uint16_t v)
	helper for XsDataPacket_convertRawVector More...
void	XsArray_append (void *thisPtr, void const *other)
	Appends the other list to thisArray list. More...
void	XsArray_assign (void *thisPtr, XsSize count, void const *src)
	Reinitializes the XsArray with space for count items and copies them from src. More...
void const *	XsArray_at (void const *thisPtr, XsSize index)
	Returns a pointer to the item at the supplied index or a null pointer if it is out of bounds. More...
void *	XsArray_atIndex (void *thisPtr, XsSize index)
	Returns a pointer to the item at the supplied index or a null pointer if it is out of bounds. More...
int	XsArray_compare (void const *a, void const *b)
	Returns non-zero if the lists are different, 0 if they're equal. More...
int	XsArray_comparePredicate (void const *a, void const *b, XsArrayItemCompareFunc predicate)
	Returns non-zero if the lists are different, 0 if they're equal. More...
int	XsArray_compareSet (void const *a, void const *b)
	Returns -1 if a is smaller in some way than b, 1 if it is larger in some way and 0 if both lists are equal. More...
void	XsArray_construct (void *thisPtr, XsArrayDescriptor const *const descriptor, XsSize count, void const *src)
	Initializes the XsArray with space for count items and copies them from src. More...
void	XsArray_copy (void *thisPtr, void const *src)
	Copy the contents of src to thisArray. More...
void	XsArray_copyConstruct (void *thisPtr, void const *src)
	Initializes the XsArray with a copy of src. More...
void	XsArray_destruct (void *thisPtr)
	Clears and frees memory allocated by the XsArray. More...
int	XsArray_empty (void const *thisPtr)
	Returns whether the array is empty. More...
void	XsArray_erase (void *thisPtr, XsSize index, XsSize count)
	Removes a count items from the list starting at index. More...
ptrdiff_t	XsArray_find (void const *thisPtr, void const *needle)
	Returns the index of needle in the list or -1 if it wasn't found. More...
ptrdiff_t	XsArray_findPredicate (void const *thisPtr, void const *needle, XsArrayItemCompareFunc predicate)
	Returns the index of needle in the list or -1 if it wasn't found. More...
void	XsArray_insert (void *thisPtr, XsSize index, XsSize count, void const *src)
	Insert count items from src at index in the array. More...
void	XsArray_rawCopy (void *to, void const *from, XsSize count, XsSize iSize)
	Copies items optimized in a direct way. More...
void	XsArray_removeDuplicates (void *thisPtr)
	Removes duplicate entries from the array, keeping only the first instance of each value. More...
void	XsArray_removeDuplicatesPredicate (void *thisPtr, XsArrayItemCompareFunc predicate)
	Removes duplicate entries from the array, keeping only the first instance of each value. More...
void	XsArray_reserve (void *thisPtr, XsSize count)
	Reserves space for count items. More...
void	XsArray_resize (void *thisPtr, XsSize count)
	Resizes the existing list to count items. More...
void	XsArray_reverse (void *thisPtr)
	Reverses the contents of the array by repeatedly using the itemSwap func in the XsArrayDescriptor. More...
void	XsArray_sort (void *thisPtr)
	Sorts the array using the itemCompare func in the XsArrayDescriptor. More...
void	XsArray_swap (void *a, void *b)
	Swap the contents of a with those of b. More...
XsBaudRate	XsBaud_codeToRate (XsBaudCode baudcode)
	Convert an Xsens baud code to XsBaudRate. More...
XsBaudRate	XsBaud_numericToRate (int numeric)
	Convert a numeric baudrate in bps to XsBaudrate. More...
XsBaudCode	XsBaud_rateToCode (XsBaudRate baudrate)
	Convert a XsBaudRate to an Xsens baud code. More...
int	XsBaud_rateToNumeric (XsBaudRate baudrate)
	Convert a XsBaudrate to a numeric baudrate in bps. More...
void	XsCalibratedData_construct (XsCalibratedData *thisPtr, const XsReal *acc, const XsReal *gyr, const XsReal *mag)
	Construct an XsCalibratedData object. More...
void	XsCalibratedData_destruct (XsCalibratedData *thisPtr)
	Destruct an XsCalibratedData object. More...
const char *	XsConnectivityState_toString (XsConnectivityState s)
	Convert the device state to a human readable string. More...
const char *	XsDataFlags_toString (XsDataFlags f)
	Convert the XsDataFlags to a human readable string. More...
XsVector *	XsDataPacket_accelerationHR (const XsDataPacket *thisPtr, XsVector *returnVal)
	Returns AccelerationHR. More...
double	XsDataPacket_altitude (const XsDataPacket *thisPtr)
	The position altitude component of a data item. More...
double	XsDataPacket_altitudeMsl (const XsDataPacket *thisPtr)
	The position altitude above MSL component of a data item. More...
XsAnalogInData *	XsDataPacket_analogIn1Data (const XsDataPacket *thisPtr, XsAnalogInData *returnVal)
	The analog in 1 component of a data item. More...
XsAnalogInData *	XsDataPacket_analogIn2Data (const XsDataPacket *thisPtr, XsAnalogInData *returnVal)
	The analog in 2 component of a data item. More...
XsSnapshot *	XsDataPacket_awindaSnapshot (const XsDataPacket *thisPtr, XsSnapshot *returnVal)
	Returns the Awinda Snapshot part of the XsDataPacket. More...
XsVector *	XsDataPacket_calibratedAcceleration (const XsDataPacket *thisPtr, XsVector *returnVal)
	The calibrated accelerometer component of a data item. More...
XsCalibratedData *	XsDataPacket_calibratedData (const XsDataPacket *thisPtr, XsCalibratedData *returnVal)
	Return the calibrated Data component of a data item. More...
XsVector *	XsDataPacket_calibratedGyroscopeData (const XsDataPacket *thisPtr, XsVector *returnVal)
	The calibrated gyroscope component of a data item. More...
XsVector *	XsDataPacket_calibratedMagneticField (const XsDataPacket *thisPtr, XsVector *returnVal)
	The calibrated magnetometer component of a data item. More...
void	XsDataPacket_clear (XsDataPacket *thisPtr, XsDataIdentifier id)
	Clears all data in an XsDataPacket. More...
void	XsDataPacket_construct (XsDataPacket *thisPtr)
	Inits a data packet, the packet will be empty after construction. More...
int	XsDataPacket_containsAccelerationHR (const XsDataPacket *thisPtr)
	Check if data item contains AccelerationHR. More...
int	XsDataPacket_containsAltitude (const XsDataPacket *thisPtr)
	Check if data item contains position altitude data. More...
int	XsDataPacket_containsAltitudeMsl (const XsDataPacket *thisPtr)
	Check if data item contains position altitude above MSL data. More...
int	XsDataPacket_containsAnalogIn1Data (const XsDataPacket *thisPtr)
	Check if data item contains analog in 1 data. More...
int	XsDataPacket_containsAnalogIn2Data (const XsDataPacket *thisPtr)
	Check if data item contains analog in 2 data. More...
int	XsDataPacket_containsAwindaSnapshot (const XsDataPacket *thisPtr)
	Returns true if the XsDataPacket contains Awinda Snapshot data. More...
int	XsDataPacket_containsCalibratedAcceleration (const XsDataPacket *thisPtr)
	Check if data item contains calibrated accelerometer data. More...
int	XsDataPacket_containsCalibratedData (const XsDataPacket *thisPtr)
	Check if data item contains calibrated Data. More...
int	XsDataPacket_containsCalibratedGyroscopeData (const XsDataPacket *thisPtr)
	Check if data item contains calibrated gyroscope data. More...
int	XsDataPacket_containsCalibratedMagneticField (const XsDataPacket *thisPtr)
	Check if data item contains calibrated magnetometer data. More...
int	XsDataPacket_containsCorrectedMagneticField (const XsDataPacket *thisPtr)
	Check if data item contains corrected magnetometer data (ICC result). More...
int	XsDataPacket_containsDetailedStatus (const XsDataPacket *thisPtr)
	Check if data item contains detailed status data. More...
int	XsDataPacket_containsFrameRange (const XsDataPacket *thisPtr)
	Returns whether the datapacket contains a framerange. More...
int	XsDataPacket_containsFreeAcceleration (const XsDataPacket *thisPtr)
	Check if data item contains free acceleration. More...
int	XsDataPacket_containsFullSnapshot (const XsDataPacket *thisPtr)
	Returns true if the XsDataPacket contains Full Snapshot data. More...
int	XsDataPacket_containsGloveData (const XsDataPacket *thisPtr, XsHandId hand)
	Check if data item contains glove data. More...
int	XsDataPacket_containsGloveSnapshot (const XsDataPacket *thisPtr, XsHandId hand)
	Returns true if the XsDataPacket contains Glove Snapshot data. More...
int	XsDataPacket_containsGnssAge (const XsDataPacket *thisPtr)
	Returns 1 if data item contains GnssAge, 0 otherwise. More...
int	XsDataPacket_containsGnssPvtPulse (const XsDataPacket *thisPtr)
	Check if data item XsDataPacket_contains a pvt pulse. More...
int	XsDataPacket_containsLatitudeLongitude (const XsDataPacket *thisPtr)
	Check if data item contains position latitude longitude data. More...
int	XsDataPacket_containsOrientation (const XsDataPacket *thisPtr)
	Check if data item contains orientation Data of any kind. More...
int	XsDataPacket_containsOrientationIncrement (const XsDataPacket *thisPtr)
	Check if data item contains delta quaternion data. More...
int	XsDataPacket_containsPacketCounter (const XsDataPacket *thisPtr)
	Check if data item contains a packet counter. More...
int	XsDataPacket_containsPacketCounter8 (const XsDataPacket *thisPtr)
	Check if data item contains an 8 bit packet counter. More...
int	XsDataPacket_containsPositionLLA (const XsDataPacket *thisPtr)
	Check if data item contains position lat lon alt data. More...
int	XsDataPacket_containsPressure (const XsDataPacket *thisPtr)
	Check if data item contains pressure data. More...
int	XsDataPacket_containsPressureAge (const XsDataPacket *thisPtr)
	Check if data item contains pressure age data. More...
int	XsDataPacket_containsRateOfTurnHR (const XsDataPacket *thisPtr)
	Check if data item contains RateOfTurnHR. More...
int	XsDataPacket_containsRawAcceleration (const XsDataPacket *thisPtr)
	Check if data item contains Raw Accelerometer data. More...
int	XsDataPacket_containsRawBlob (const XsDataPacket *thisPtr)
	Returns true if the XsDataPacket contains raw blob data. More...
int	XsDataPacket_containsRawData (const XsDataPacket *thisPtr)
	Check if data item contains raw data. More...
int	XsDataPacket_containsRawGnssPvtData (const XsDataPacket *thisPtr)
	Returns 1 if data item contains RawGnssPvtData, 0 otherwise. More...
int	XsDataPacket_containsRawGnssSatInfo (const XsDataPacket *thisPtr)
	Returns 1 if data item contains RawGnssPvtData, 0 otherwise. More...
int	XsDataPacket_containsRawGyroscopeData (const XsDataPacket *thisPtr)
	Check if data item contains raw gyroscope data. More...
int	XsDataPacket_containsRawGyroscopeTemperatureData (const XsDataPacket *thisPtr)
	Check if data item contains raw gyroscope temperature data. More...
int	XsDataPacket_containsRawMagneticField (const XsDataPacket *thisPtr)
	Check if data item contains raw magnetometer data. More...
int	XsDataPacket_containsRawTemperature (const XsDataPacket *thisPtr)
	Check if data item contains raw temperature data. More...
int	XsDataPacket_containsRssi (const XsDataPacket *thisPtr)
	Returns whether the datapacket contains an rssi value. More...
int	XsDataPacket_containsSampleTime64 (const XsDataPacket *thisPtr)
	Check if data item XsDataPacket contains a full 64-bit sample time. More...
int	XsDataPacket_containsSampleTimeCoarse (const XsDataPacket *thisPtr)
	Check if data item XsDataPacket_contains a sample time coarse. More...
int	XsDataPacket_containsSampleTimeFine (const XsDataPacket *thisPtr)
	Check if data item XsDataPacket_contains a sample time fine. More...
int	XsDataPacket_containsSdiData (const XsDataPacket *thisPtr)
	Check if data item contains strapdown integration data. More...
int	XsDataPacket_containsStatus (const XsDataPacket *thisPtr)
	Check if data item contains legacy status data. More...
int	XsDataPacket_containsStoredDeviceId (const XsDataPacket *thisPtr)
	Return non-zero if this data packet stores a device ID. More...
int	XsDataPacket_containsStoredLocationId (const XsDataPacket *thisPtr)
	Return non-zero if this data packet stores a location ID. More...
int	XsDataPacket_containsTemperature (const XsDataPacket *thisPtr)
	Check if data item contains temperature data. More...
int	XsDataPacket_containsTriggerIndication (const XsDataPacket *thisPtr, XsDataIdentifier triggerId)
	Check if data item contains trigger indication data. More...
int	XsDataPacket_containsUtcTime (const XsDataPacket *thisPtr)
	Check if data item contains utc time data. More...
int	XsDataPacket_containsVelocity (const XsDataPacket *thisPtr)
	Check if data item contains velocity NED data. More...
int	XsDataPacket_containsVelocityIncrement (const XsDataPacket *thisPtr)
	Check if data item contains delta velocity data. More...
XsDataIdentifier	XsDataPacket_coordinateSystemOrientation (const XsDataPacket *thisPtr)
	Returns the coordinate system of the first orientation data of any kind in the packet. More...
XsDataIdentifier	XsDataPacket_coordinateSystemVelocity (const XsDataPacket *thisPtr)
	Returns the coordinate system of the first velocity data of any kind in the packet. More...
void	XsDataPacket_copy (XsDataPacket *copy, XsDataPacket const *src)
	Copy the XsDataPacket to copy. More...
void	XsDataPacket_copyConstruct (XsDataPacket *thisPtr, XsDataPacket const *src)
	Initializes a data packet as a (referenced) copy of src. More...
XsVector *	XsDataPacket_correctedMagneticField (const XsDataPacket *thisPtr, XsVector *returnVal)
	The corrected magnetometer component of a data item (ICC result). More...
XsDataIdentifier	XsDataPacket_dataFormat (const XsDataPacket *thisPtr, XsDataIdentifier id)
	Returns the dataformat of a specific data identifier in the packet. More...
void	XsDataPacket_destruct (XsDataPacket *thisPtr)
	Clears and frees data in an XsDataPacket. More...
int	XsDataPacket_empty (const XsDataPacket *thisPtr)
	Returns whether the datapacket is empty. More...
XsRange *	XsDataPacket_frameRange (const XsDataPacket *thisPtr, XsRange *returnVal)
	Returns the frame range contained in the datapacket. More...
XsVector *	XsDataPacket_freeAcceleration (const XsDataPacket *thisPtr, XsVector *returnVal)
	The free acceleration component of a data item. More...
XsSnapshot *	XsDataPacket_fullSnapshot (const XsDataPacket *thisPtr, XsSnapshot *returnVal)
	Returns the Full Snapshot part of the XsDataPacket. More...
XsGloveData *	XsDataPacket_gloveData (const XsDataPacket *thisPtr, XsGloveData *returnVal, XsHandId hand)
	Return the glove data component of a data item. More...
XsGloveSnapshot *	XsDataPacket_gloveSnapshot (const XsDataPacket *thisPtr, XsGloveSnapshot *returnVal, XsHandId hand)
	Returns the Glove Snapshot part of the XsDataPacket. More...
uint8_t	XsDataPacket_gnssAge (const XsDataPacket *thisPtr)
	Returns the age of the GNSS data (in samples) More...
uint32_t	XsDataPacket_gnssPvtPulse (const XsDataPacket *thisPtr)
	Returns the timestamp of a PVT Pulse. More...
int	XsDataPacket_isAwindaSnapshotARetransmission (const XsDataPacket *thisPtr)
	Returns true if the contained Awinda Snapshot is marked as a retransmission. More...
int	XsDataPacket_itemCount (const XsDataPacket *thisPtr)
	Returns the number of individual items in the XsDataPacket. More...
XsVector *	XsDataPacket_latitudeLongitude (const XsDataPacket *thisPtr, XsVector *returnVal)
	The position latitude longitude component of a data item. More...
XsDataPacket *	XsDataPacket_merge (XsDataPacket *thisPtr, const XsDataPacket *other, int overwrite)
	Merge the data items from other into the packet. More...
XsEuler *	XsDataPacket_orientationEuler (const XsDataPacket *thisPtr, XsEuler *returnVal, XsDataIdentifier coordinateSystem)
	Return the orientation component of a data item as a euler angles. More...
XsDataIdentifier	XsDataPacket_orientationIdentifier (const XsDataPacket *thisPtr)
	Returns the data identifier of the first orientation data of any kind in the packet. More...
XsQuaternion *	XsDataPacket_orientationIncrement (const XsDataPacket *thisPtr, XsQuaternion *returnVal)
	The delta quaternion (deltaQ) component of a data item. More...
XsMatrix *	XsDataPacket_orientationMatrix (const XsDataPacket *thisPtr, XsMatrix *returnVal, XsDataIdentifier coordinateSystem)
	Return the orientation component of a data item as a orientation matrix. More...
XsQuaternion *	XsDataPacket_orientationQuaternion (const XsDataPacket *thisPtr, XsQuaternion *returnVal, XsDataIdentifier coordinateSystem)
	Return the orientation component of a data item as a quaternion. More...
uint16_t	XsDataPacket_packetCounter (const XsDataPacket *thisPtr)
	Return the packet/frame counter of a packet. More...
uint8_t	XsDataPacket_packetCounter8 (const XsDataPacket *thisPtr)
	Return the 8 bit packet counter of a packet. More...
XsVector *	XsDataPacket_positionLLA (const XsDataPacket *thisPtr, XsVector *returnVal)
	The position lat lon alt component of a data item. More...
XsPressure *	XsDataPacket_pressure (const XsDataPacket *thisPtr, XsPressure *returnVal)
	The air pressure component of a data item. More...
int	XsDataPacket_privateCount ()
	Returns the number of private data items for all XsDataPacket combined currently in memory. More...
XsVector *	XsDataPacket_rateOfTurnHR (const XsDataPacket *thisPtr, XsVector *returnVal)
	Returns RateOfTurnHR. More...
XsUShortVector *	XsDataPacket_rawAcceleration (const XsDataPacket *thisPtr, XsUShortVector *returnVal)
	The raw accelerometer component of a data item. More...
XsVector *	XsDataPacket_rawAccelerationConverted (const XsDataPacket *thisPtr, XsVector *returnVal)
	The raw accelerometer component of a data item, converted to floating point values. More...
XsByteArray *	XsDataPacket_rawBlob (const XsDataPacket *thisPtr, XsByteArray *returnVal)
	Returns the raw blob part of the XsDataPacket. More...
XsScrData *	XsDataPacket_rawData (const XsDataPacket *thisPtr, XsScrData *returnVal)
	Return the raw data component of a data item. More...
XsRawGnssPvtData *	XsDataPacket_rawGnssPvtData (const XsDataPacket *thisPtr, XsRawGnssPvtData *returnVal)
	Returns a struct with RawGnssPvtData. More...
XsRawGnssSatInfo *	XsDataPacket_rawGnssSatInfo (const XsDataPacket *thisPtr, XsRawGnssSatInfo *returnVal)
	Returns a struct with RawGnssSatInfo. More...
XsUShortVector *	XsDataPacket_rawGyroscopeData (const XsDataPacket *thisPtr, XsUShortVector *returnVal)
	The raw gyroscope component of a data item. More...
XsVector *	XsDataPacket_rawGyroscopeDataConverted (const XsDataPacket *thisPtr, XsVector *returnVal)
	The raw gyroscope component of a data item, converted to floating point values. More...
XsUShortVector *	XsDataPacket_rawGyroscopeTemperatureData (const XsDataPacket *thisPtr, XsUShortVector *returnVal)
	The raw gyroscope temperature component of a data item. More...
XsVector *	XsDataPacket_rawGyroscopeTemperatureDataConverted (const XsDataPacket *thisPtr, XsVector *returnVal)
	The raw gyroscope temperature component of a data item, converted to floating point values. More...
XsUShortVector *	XsDataPacket_rawMagneticField (const XsDataPacket *thisPtr, XsUShortVector *returnVal)
	The raw magnetometer component of a data item. More...
XsVector *	XsDataPacket_rawMagneticFieldConverted (const XsDataPacket *thisPtr, XsVector *returnVal)
	The raw magnetometer component of a data item, converted to floating point values. More...
uint16_t	XsDataPacket_rawTemperature (const XsDataPacket *thisPtr)
	The raw temperature component of a data item. More...
int	XsDataPacket_rssi (const XsDataPacket *thisPtr)
	Returns the rssi value contained in the datapacket. More...
uint64_t	XsDataPacket_sampleTime64 (const XsDataPacket *thisPtr)
	Return the full 64-bit sample time of a packet, combined from the fine and coarse sample times or received directly from the device. The 64-bit sample time runs at 10kHz. More...
uint32_t	XsDataPacket_sampleTimeCoarse (const XsDataPacket *thisPtr)
uint32_t	XsDataPacket_sampleTimeFine (const XsDataPacket *thisPtr)
	Return the fine sample time of a packet. More...
XsSdiData *	XsDataPacket_sdiData (const XsDataPacket *thisPtr, XsSdiData *returnVal)
	Return the strapdown integration data component of a data item. More...
void	XsDataPacket_setAccelerationHR (XsDataPacket *thisPtr, const XsVector *vec)
	Add/update the AccelerationHR for the item. More...
void	XsDataPacket_setAltitude (XsDataPacket *thisPtr, double data)
	Add/update altitude data for the item. More...
void	XsDataPacket_setAltitudeMsl (XsDataPacket *thisPtr, double data)
	Add/update altitude above MSL data for the item. More...
void	XsDataPacket_setAnalogIn1Data (XsDataPacket *thisPtr, const XsAnalogInData *data)
	Add/update analog in 1 data for the item. More...
void	XsDataPacket_setAnalogIn2Data (XsDataPacket *thisPtr, const XsAnalogInData *data)
	Add/update analog in 2 data for the item. More...
void	XsDataPacket_setAwindaSnapshot (XsDataPacket *thisPtr, XsSnapshot const *data, int retransmission)
	Sets the Awinda Snapshot part of the XsDataPacket. More...
void	XsDataPacket_setCalibratedAcceleration (XsDataPacket *thisPtr, const XsVector *vec)
	Add/update calibrated accelerometer data for the item. More...
void	XsDataPacket_setCalibratedData (XsDataPacket *thisPtr, const XsCalibratedData *data)
	Add/update calibrated Data for the item. More...
void	XsDataPacket_setCalibratedGyroscopeData (XsDataPacket *thisPtr, const XsVector *vec)
	Add/update calibrated gyroscope data for the item. More...
void	XsDataPacket_setCalibratedMagneticField (XsDataPacket *thisPtr, const XsVector *vec)
	Add/update calibrated magnetometer data for the item. More...
void	XsDataPacket_setCorrectedMagneticField (XsDataPacket *thisPtr, const XsVector *vec)
	Add/update corrected magnetometer data for the item (ICC result). More...
void	XsDataPacket_setFrameRange (XsDataPacket *thisPtr, const XsRange *r)
	Sets or updates the frame range in the datapacket. More...
void	XsDataPacket_setFreeAcceleration (XsDataPacket *thisPtr, const XsVector *g)
	Add/update free acceleration data for the item. More...
void	XsDataPacket_setFullSnapshot (XsDataPacket *thisPtr, XsSnapshot const *data, int retransmission)
	Sets the Awinda Snapshot part of the XsDataPacket. More...
void	XsDataPacket_setGloveData (XsDataPacket *thisPtr, const XsGloveData *data, XsHandId hand)
	Add/update strapdown integration data for the item. More...
void	XsDataPacket_setGloveSnapshot (XsDataPacket *thisPtr, XsGloveSnapshot const *data, int retransmission, XsHandId hand)
	Sets the Glove Snapshot part of the XsDataPacket. More...
void	XsDataPacket_setGnssAge (XsDataPacket *thisPtr, uint8_t age)
	Sets or updates the GnssAge value in the datapacket. More...
void	XsDataPacket_setGnssPvtPulse (XsDataPacket *thisPtr, uint32_t counter)
	Add/update pvt pulse timestamp data for the item. More...
void	XsDataPacket_setLatitudeLongitude (XsDataPacket *thisPtr, const XsVector *data)
	Add/update position latitude longitude data for the item. More...
void	XsDataPacket_setMessage (XsDataPacket *thisPtr, const XsMessage *msg)
	Overwrite the contents of the XsDataPacket with the contents of the supplied XsMessage. More...
void	XsDataPacket_setOrientationEuler (XsDataPacket *thisPtr, const XsEuler *data, XsDataIdentifier coordinateSystem)
	Add/update quaternion orientation Data for the item. More...
void	XsDataPacket_setOrientationIncrement (XsDataPacket *thisPtr, const XsQuaternion *quat)
	Add/update delta quaternion data for the item. More...
void	XsDataPacket_setOrientationMatrix (XsDataPacket *thisPtr, const XsMatrix *data, XsDataIdentifier coordinateSystem)
	Add/update quaternion orientation Data for the item. More...
void	XsDataPacket_setOrientationQuaternion (XsDataPacket *thisPtr, const XsQuaternion *data, XsDataIdentifier coordinateSystem)
	Add/update quaternion orientation Data for the item. More...
void	XsDataPacket_setPacketCounter (XsDataPacket *thisPtr, uint16_t counter)
	Add/update packet counter data for the item. More...
void	XsDataPacket_setPacketCounter8 (XsDataPacket *thisPtr, uint8_t counter)
	Add/update 8 bit packet counter data for the item. More...
void	XsDataPacket_setPositionLLA (XsDataPacket *thisPtr, const XsVector *data)
	Add/update position lat lon alt data for the item. More...
void	XsDataPacket_setPressure (XsDataPacket *thisPtr, const XsPressure *data)
	Add/update pressure data for the item. More...
void	XsDataPacket_setRateOfTurnHR (XsDataPacket *thisPtr, const XsVector *vec)
	Add/update the RateOfTurnHR for the item. More...
void	XsDataPacket_setRawAcceleration (XsDataPacket *thisPtr, const XsUShortVector *vec)
	Add/update raw accelerometer data for the item. More...
void	XsDataPacket_setRawBlob (XsDataPacket *thisPtr, const XsByteArray *data)
	Sets the raw blob part of the XsDataPacket. More...
void	XsDataPacket_setRawData (XsDataPacket *thisPtr, const XsScrData *data)
	Add/update raw data for the item. More...
void	XsDataPacket_setRawGnssPvtData (XsDataPacket *thisPtr, const XsRawGnssPvtData *r)
	Sets or updates the RawGnssPvtData value in the datapacket. More...
void	XsDataPacket_setRawGnssSatInfo (XsDataPacket *thisPtr, const XsRawGnssSatInfo *data)
	Sets or updates the RawGnssSatInfo value in the datapacket. More...
void	XsDataPacket_setRawGyroscopeData (XsDataPacket *thisPtr, const XsUShortVector *vec)
	Add/update raw gyroscope data for the item. More...
void	XsDataPacket_setRawGyroscopeTemperatureData (XsDataPacket *thisPtr, const XsUShortVector *vec)
	Add/update raw gyroscope temperature data for the item. More...
void	XsDataPacket_setRawMagneticField (XsDataPacket *thisPtr, const XsUShortVector *vec)
	Add/update raw magnetometer data for the item. More...
void	XsDataPacket_setRawTemperature (XsDataPacket *thisPtr, uint16_t temp)
	Add/update raw temperature data for the item. More...
void	XsDataPacket_setRssi (XsDataPacket *thisPtr, int r)
	Sets or updates the rssi value in the datapacket. More...
void	XsDataPacket_setSampleTime64 (XsDataPacket *thisPtr, uint64_t counter)
	Add/update sample tine coarse data for the item. More...
void	XsDataPacket_setSampleTimeCoarse (XsDataPacket *thisPtr, uint32_t counter)
	Add/update sample tine coarse data for the item. More...
void	XsDataPacket_setSampleTimeFine (XsDataPacket *thisPtr, uint32_t counter)
	Add/update sample tine fine data for the item. More...
void	XsDataPacket_setSdiData (XsDataPacket *thisPtr, const XsSdiData *data)
	Add/update strapdown integration data for the item. More...
void	XsDataPacket_setStatus (XsDataPacket *thisPtr, uint32_t data)
	Add/update status data for the item. More...
void	XsDataPacket_setStatusByte (XsDataPacket *thisPtr, uint8_t data)
	Add/update status data for the item. More...
void	XsDataPacket_setStoredDeviceId (XsDataPacket *thisPtr, const XsDeviceId *data)
	Add or update device id for the item. More...
void	XsDataPacket_setStoredLocationId (XsDataPacket *thisPtr, uint16_t data)
	Add or update location ID for the item. More...
void	XsDataPacket_setTemperature (XsDataPacket *thisPtr, double temperature)
	Adds or updates the temperature data in the datapacket. More...
void	XsDataPacket_setTriggerIndication (XsDataPacket *thisPtr, XsDataIdentifier triggerId, const XsTriggerIndicationData *triggerIndicationData)
	Add/update trigger indication data for the item. More...
void	XsDataPacket_setUtcTime (XsDataPacket *thisPtr, const XsTimeInfo *data)
	Add/update utc time data for the item. More...
void	XsDataPacket_setVelocity (XsDataPacket *thisPtr, const XsVector *data, XsDataIdentifier coordinateSystem)
	Add/update velocity NED data for the item. More...
void	XsDataPacket_setVelocityIncrement (XsDataPacket *thisPtr, const XsVector *vec)
	Add/update delta velocity data for the item. More...
uint32_t	XsDataPacket_status (const XsDataPacket *thisPtr)
	The status component of a data item. More...
XsDeviceId *	XsDataPacket_storedDeviceId (const XsDataPacket *thisPtr, XsDeviceId *returnVal)
	The device id of a data item. More...
uint16_t	XsDataPacket_storedLocationId (const XsDataPacket *thisPtr)
	The location ID of a data item. More...
void	XsDataPacket_swap (XsDataPacket *thisPtr, XsDataPacket *other)
	Swaps the XsDataPackets in thisPtr and other. More...
double	XsDataPacket_temperature (const XsDataPacket *thisPtr)
	The temperature component of a data item. More...
void	XsDataPacket_toMessage (const XsDataPacket *thisPtr, XsMessage *msg)
	Write the contents of the XsDataPacket to an XsMessage in MtData2 format. More...
XsTriggerIndicationData *	XsDataPacket_triggerIndication (const XsDataPacket *thisPtr, XsDataIdentifier triggerId, XsTriggerIndicationData *returnVal)
	Returns the trigger indication data of a packet If the packet does not contain the requested data, the return val struct will be set to all zeroes. More...
XsTimeInfo *	XsDataPacket_utcTime (const XsDataPacket *thisPtr, XsTimeInfo *returnVal)
	The utc time component of a data item. More...
XsVector *	XsDataPacket_velocity (const XsDataPacket *thisPtr, XsVector *returnVal, XsDataIdentifier coordinateSystem)
	The velocity NWU component of a data item. More...
XsDataIdentifier	XsDataPacket_velocityIdentifier (const XsDataPacket *thisPtr)
	Returns the data identifier of the first velocity data of any kind in the packet. More...
XsVector *	XsDataPacket_velocityIncrement (const XsDataPacket *thisPtr, XsVector *returnVal)
	The delta velocity (deltaV) component of a data item. More...
int	XsDeviceCapabilities_hasAccelerometer (const struct XsDeviceCapabilities *thisPtr)
	Test if the device has an operational accelerometer. More...
int	XsDeviceCapabilities_hasBarometer (const struct XsDeviceCapabilities *thisPtr)
	Test if the device has an operational barometer. More...
int	XsDeviceCapabilities_hasGnss (const struct XsDeviceCapabilities *thisPtr)
	Test if the device has an operational GNSS receiver. More...
int	XsDeviceCapabilities_hasGyroscope (const struct XsDeviceCapabilities *thisPtr)
	Test if the device has an operational gyroscope. More...
int	XsDeviceCapabilities_hasMagnetometer (const struct XsDeviceCapabilities *thisPtr)
	Test if the device has an operational magnetometer. More...
int	XsDeviceCapabilities_isAhrs (const struct XsDeviceCapabilities *thisPtr)
	Test if the device has an AHRS. More...
int	XsDeviceCapabilities_isGnssIns (const struct XsDeviceCapabilities *thisPtr)
	Test if the device is a GNSS/INS. More...
int	XsDeviceCapabilities_isImu (const struct XsDeviceCapabilities *thisPtr)
	Test if the device is an IMU. More...
int	XsDeviceCapabilities_isRtk (const struct XsDeviceCapabilities *thisPtr)
	Test if the device is an RTK device. More...
int	XsDeviceCapabilities_isValid (const struct XsDeviceCapabilities *thisPtr)
	Test if the given XsDeviceCapabilities is valid. More...
int	XsDeviceCapabilities_isVru (const struct XsDeviceCapabilities *thisPtr)
	Test if the device has a VRU. More...
void	XsDeviceConfiguration_assign (XsDeviceConfiguration *thisPtr, XsSize numberOfDevices, const XsDeviceConfiguration *src)
	Reinitializes the XsDeviceConfiguration with space for numberOfDevices devices and copies them from src. More...
void	XsDeviceConfiguration_construct (XsDeviceConfiguration *thisPtr)
	Initializes the XsDeviceConfiguration object. More...
void	XsDeviceConfiguration_copy (XsDeviceConfiguration *copy, XsDeviceConfiguration const *src)
	Copy the XsDeviceConfiguration to copy. More...
void	XsDeviceConfiguration_destruct (XsDeviceConfiguration *thisPtr)
	Clears and frees data in the XsDeviceConfiguration. More...
int	XsDeviceConfiguration_empty (const XsDeviceConfiguration *thisPtr)
	Returns true if the XsDeviceConfiguration is empty. More...
XsSize	XsDeviceConfiguration_findDevice (const XsDeviceConfiguration *thisPtr, const XsDeviceId *deviceId)
	Returns a (naive) bus ID if deviceId is available in this configuration, 0 otherwise. More...
void	XsDeviceConfiguration_readFromMessage (XsDeviceConfiguration *thisPtr, const XsMessage *msg)
	Sets up a XsDeviceConfiguration based upon msg. More...
void	XsDeviceConfiguration_writeToMessage (const XsDeviceConfiguration *thisPtr, XsMessage *msg)
	Creates a message msg that represents the XsDeviceConfiguration. More...
int	XsDeviceId_contains (XsDeviceId const *thisPtr, XsDeviceId const *other)
	Returns true if this is equal to other or this is a type-specifier that matches other. More...
void	XsDeviceId_deviceType (struct XsDeviceId const *thisPtr, int detailed, struct XsDeviceId *type)
	Returns the device type identified by this id (eg 10, 300 and Awinda2 Master) More...
void	XsDeviceId_deviceTypeMask (struct XsDeviceId const *thisPtr, int detailed, struct XsDeviceId *type)
	Returns the mask which can be used to get the detailed device type (eg 10, 300 and Awinda2 Master) More...
void	XsDeviceId_fromDeviceTypeString (XsDeviceId *thisPtr, const XsString *str)
	Read a device ID from the supplied string. More...
void	XsDeviceId_fromString (XsDeviceId *thisPtr, const XsString *str)
	Read a device ID from the supplied string. More...
int	XsDeviceId_hasInternalGnss (struct XsDeviceId const *thisPtr)
	Test if this device ID represents a device with internal GNSS receiver. More...
int	XsDeviceId_isAhrs (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an AHRS. More...
int	XsDeviceId_isAwinda2 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an Awinda2 device. More...
int	XsDeviceId_isAwinda2Dongle (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an Awinda2 Dongle. More...
int	XsDeviceId_isAwinda2Oem (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an Awinda2 OEM board. More...
int	XsDeviceId_isAwinda2Station (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an Awinda2 Station. More...
int	XsDeviceId_isAwindaX (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an Awinda device. More...
int	XsDeviceId_isAwindaXDongle (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an Awinda Dongle. More...
int	XsDeviceId_isAwindaXOem (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an Awinda OEM board. More...
int	XsDeviceId_isAwindaXStation (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an Awinda Station. More...
int	XsDeviceId_isBodyPack (const struct XsDeviceId *thisPtr)
	Test if this device ID represents a bodypack (any version) device. More...
int	XsDeviceId_isBodyPackV1 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents a bodypack V1 device. More...
int	XsDeviceId_isBodyPackV2 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents a bodypack V2 device. More...
int	XsDeviceId_isContainerDevice (const struct XsDeviceId *thisPtr)
	Test if this device ID represents any of the container devices such as Bodypack and Awinda Station. More...
int	XsDeviceId_isDot (struct XsDeviceId const *thisPtr)
	Test if the device ID represents a Dot series device. More...
int	XsDeviceId_isGlove (const struct XsDeviceId *thisPtr)
	Test if the device ID represents a Glove series device. More...
int	XsDeviceId_isGnss (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an GNSS (capable) device. More...
int	XsDeviceId_isHilDevice (const struct XsDeviceId *thisPtr)
	Test if this device ID represents a Hardware In the Loop test device. More...
int	XsDeviceId_isImu (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an IMU. More...
int	XsDeviceId_isLegacyDeviceId (const struct XsDeviceId *thisPtr)
	Test if the device ID represents a legacy device identification. More...
int	XsDeviceId_isMt (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MT device (any Mti, Mtig, Mtx or Mtw) More...
int	XsDeviceId_isMti (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTi device (1, 10 or 100 series, 1 includes MTi-7) More...
int	XsDeviceId_isMti3X0 (const struct XsDeviceId *thisPtr)
	Test if the device ID represents an MTi-3X0 device. More...
int	XsDeviceId_isMti6X0 (const struct XsDeviceId *thisPtr)
	Test if the device ID represents an MTi-600 series device. More...
int	XsDeviceId_isMti8X0 (const struct XsDeviceId *thisPtr)
	Test if the device ID represents an MTi-800 series device. More...
int	XsDeviceId_isMtig (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTig device (700 or 710 series) More...
int	XsDeviceId_isMtigX00 (const struct XsDeviceId *thisPtr)
	Test if the device ID represents an Mtig 700 device. More...
int	XsDeviceId_isMtigX10 (const struct XsDeviceId *thisPtr)
	Test if the device ID represents an Mtig 710 device. More...
int	XsDeviceId_isMtiX (const struct XsDeviceId *thisPtr)
	Test if the device ID represents an Mti 1-series device. More...
int	XsDeviceId_isMtiX0 (const struct XsDeviceId *thisPtr)
	Test if the device ID represents an Mti 10-series device. More...
int	XsDeviceId_isMtiX00 (const struct XsDeviceId *thisPtr)
	Test if the device ID represents an Mti 100-series device. More...
int	XsDeviceId_isMtMark4 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an Mk4 generation MT device. More...
int	XsDeviceId_isMtMark5 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an Mk5 generation MT device. More...
int	XsDeviceId_isMtMk4 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4. More...
int	XsDeviceId_isMtMk4_1 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 1. More...
int	XsDeviceId_isMtMk4_10 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 10. More...
int	XsDeviceId_isMtMk4_100 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 100. More...
int	XsDeviceId_isMtMk4_2 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 2. More...
int	XsDeviceId_isMtMk4_20 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 20. More...
int	XsDeviceId_isMtMk4_200 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 200. More...
int	XsDeviceId_isMtMk4_3 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 3. More...
int	XsDeviceId_isMtMk4_30 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 30. More...
int	XsDeviceId_isMtMk4_300 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 300. More...
int	XsDeviceId_isMtMk4_400 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 400. More...
int	XsDeviceId_isMtMk4_500 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 500. More...
int	XsDeviceId_isMtMk4_600 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 600. More...
int	XsDeviceId_isMtMk4_7 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 7. More...
int	XsDeviceId_isMtMk4_700 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 700. More...
int	XsDeviceId_isMtMk4_710 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents either an MTMk4 710 or Mk5 710. More...
int	XsDeviceId_isMtMk4_800 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 800. More...
int	XsDeviceId_isMtMk4_900 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 900. More...
int	XsDeviceId_isMtMk4_X (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 1 series. More...
int	XsDeviceId_isMtMk4_X0 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 10 series. More...
int	XsDeviceId_isMtMk4_X00 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk4 100 series (including 700 and 710) More...
int	XsDeviceId_isMtMk5 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk5. More...
int	XsDeviceId_isMtMk5_10 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk5 10. More...
int	XsDeviceId_isMtMk5_100 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk5 100. More...
int	XsDeviceId_isMtMk5_20 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk5 20. More...
int	XsDeviceId_isMtMk5_200 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk5 200. More...
int	XsDeviceId_isMtMk5_30 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk5 30. More...
int	XsDeviceId_isMtMk5_300 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk5 300. More...
int	XsDeviceId_isMtMk5_710 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk5 710. More...
int	XsDeviceId_isMtMk5_X0 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk5 10 series. More...
int	XsDeviceId_isMtMk5_X00 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTMk5 100 series. More...
int	XsDeviceId_isMtw (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTw. More...
int	XsDeviceId_isMtw2 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTw2. More...
int	XsDeviceId_isMtx (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTx. More...
int	XsDeviceId_isMtx2 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an MTx2. More...
int	XsDeviceId_isRtk (const struct XsDeviceId *thisPtr)
	Test if this device ID represents an RTK (capable) device. More...
int	XsDeviceId_isRugged (struct XsDeviceId const *thisPtr)
	Test if this device ID represents an Rugged Version. More...
int	XsDeviceId_isSyncStation2 (const struct XsDeviceId *thisPtr)
	Test if this device ID represents a SyncStation v2. More...
int	XsDeviceId_isSyncStationX (const struct XsDeviceId *thisPtr)
	Test if this device ID represents a SyncStation. More...
int	XsDeviceId_isType (XsDeviceId const *thisPtr)
	Returns true if the ID is just a device type, not an actual device ID. More...
int	XsDeviceId_isValid (const struct XsDeviceId *thisPtr)
	Test if the device ID is a valid id (not 0). More...
int	XsDeviceId_isVru (const struct XsDeviceId *thisPtr)
	Test if this device ID represents a VRU. More...
int	XsDeviceId_isWirelessMaster (const struct XsDeviceId *thisPtr)
	Test if this device ID represents a Wireless Master device (Awinda Station, Awinda Dongle, Awinda OEM) More...
uint64_t	XsDeviceId_legacyBit (const struct XsDeviceId *thisPtr)
XsHandId	XsDeviceId_side (struct XsDeviceId const *thisPtr)
	Return the side the device should be worn on. More...
void	XsDeviceId_swap (XsDeviceId *a, XsDeviceId *b)
	Swap the contents of a with those of b. More...
void	XsDeviceId_toDeviceTypeString (const XsDeviceId *thisPtr, XsString *str, int makeType)
	Get a string with a readable representation of this device ID. Either full or as a type. More...
void	XsDeviceId_toString (const XsDeviceId *thisPtr, XsString *str)
	Get a string with a readable representation of this device ID. More...
void	XsDeviceId_type (struct XsDeviceId const *thisPtr, struct XsDeviceId *type)
	Returns the type of device identified by this id. More...
void	XsDeviceId_typeName (XsDeviceId const *thisPtr, XsString *str)
	Returns the name of the type of device identified by this id. More...
const char *	XsDeviceState_toString (XsDeviceState s)
	Convert the device state to a human readable string. More...
void	XsEuler_destruct (XsEuler *thisPtr)
	Clears all angles in the XsEuler object by setting them to 0. More...
int	XsEuler_empty (const XsEuler *thisPtr)
	Returns true if all angles in this object are zero. More...
void	XsEuler_fromQuaternion (XsEuler *thisPtr, const XsQuaternion *quat)
	Get an euler angle representation of the quaternion. More...
XsResultValue	XsFile_close (struct XsFile *thisPtr)
	Closes the file. More...
XsResultValue	XsFile_create (struct XsFile *thisPtr, const struct XsString *filename, int writeOnly)
	Creates a new binary file with name filename, contents of existing files will be discarded. More...
XsResultValue	XsFile_createText (struct XsFile *thisPtr, const struct XsString *filename, int writeOnly)
	Creates a new text file with name filename, contents of existing files will be discarded. More...
void	XsFile_destruct (struct XsFile *thisPtr)
	Frees the resources of this object by closing the file if it is open. More...
int	XsFile_eof (struct XsFile const *thisPtr)
XsResultValue	XsFile_erase (const struct XsString *filename)
	Deletes a file with name filename. More...
XsResultValue	XsFile_error (struct XsFile const *thisPtr)
int	XsFile_exists (const struct XsString *filename)
	Checks if the file exists (can be accessed) More...
XsResultValue	XsFile_flush (struct XsFile *thisPtr)
	Writes unwritten data to the file. More...
XsResultValue	XsFile_fullPath (const struct XsString *filename, struct XsString *fullPath)
	Retrieves the full path for a filename. More...
int	XsFile_getc (struct XsFile *thisPtr)
	Gets and returns the next byte from a file. More...
XsResultValue	XsFile_getline (struct XsFile *thisPtr, struct XsString *line)
	Reads a full line from the file. More...
char *	XsFile_gets (struct XsFile *thisPtr, char *str, int num)
	Reads characters from this file and stores them into str until (num-1) characters have been read or either a newline or the end-of-file is reached, whichever happens first. More...
FILE *	XsFile_handle (struct XsFile *thisPtr)
int	XsFile_isOpen (const struct XsFile *thisPtr)
	Checks if a file is open. More...
XsResultValue	XsFile_open (struct XsFile *thisPtr, const struct XsString *filename, int readOnly)
	Opens an existing binary file with name filename. More...
XsResultValue	XsFile_openText (struct XsFile *thisPtr, const struct XsString *filename, int readOnly)
	Opens an existing binary file with name filename. More...
XsResultValue	XsFile_putc (struct XsFile *thisPtr, int character)
	Writes a character to the file. More...
XsResultValue	XsFile_puts (struct XsFile *thisPtr, const char *str)
	Writes a null terminated c-string to the file. More...
XsFilePos	XsFile_read (struct XsFile *thisPtr, void *destination, XsFilePos size, XsFilePos count)
	Reads a number of elements from a file. More...
XsResultValue	XsFile_reopen (struct XsFile *thisPtr, const struct XsString *filename, const struct XsString *mode)
	Reopens a file. More...
XsResultValue	XsFile_resize (struct XsFile *thisPtr, XsFilePos fileSize)
	Resizes the file to fileSize bytes. More...
XsResultValue	XsFile_seek (struct XsFile *thisPtr, XsFilePos offset)
	Moves the current file position relative to the start of the file. More...
XsResultValue	XsFile_seek_r (struct XsFile *thisPtr, XsFilePos offset)
	Moves the current file position relative to the end of the file. More...
XsFilePos	XsFile_tell (struct XsFile const *thisPtr)
	Returns the current position in the file. More...
XsResultValue	XsFile_truncate (struct XsFile *thisPtr, XsFilePos fileSize)
	Reduces the file to a maximum size of fileSize bytes. More...
XsFilePos	XsFile_write (struct XsFile *thisPtr, const void *source, XsFilePos size, XsFilePos count)
	Writes a number of elements to a file. More...
int	XsFilterProfile_empty (XsFilterProfile const *thisPtr)
	Checks if the filter profile is empty. More...
void	XsFilterProfile_swap (XsFilterProfile *a, XsFilterProfile *b)
	Swap the contents of a with b. More...
void	XsFilterProfile_toString (XsFilterProfile const *thisPtr, XsString *out)
	Converts filter profile version and type information to string. More...
void	XsFingerData_construct (struct XsFingerData *thisPtr)
	Initialize an XsFingerData object. More...
void	XsFingerData_copy (struct XsFingerData *copy, struct XsFingerData const *src)
	Copy the contents of an XsFingerData object. More...
void	XsFingerData_destruct (struct XsFingerData *thisPtr)
	Destruct an XsFingerData object. More...
void	XsFingerData_swap (struct XsFingerData *lhs, struct XsFingerData *rhs)
	Swap the contents of two XsGloveData objects. More...
void	XsGloveData_construct (struct XsGloveData *thisPtr)
	Initialize an XsGloveData object. More...
void	XsGloveData_copy (struct XsGloveData *copy, struct XsGloveData const *src)
	Copy the contents of an XsGloveData object. More...
void	XsGloveData_destruct (struct XsGloveData *thisPtr)
	Destruct an XsGloveData object. More...
void	XsGloveData_swap (struct XsGloveData *lhs, struct XsGloveData *rhs)
	Swap the contents of two XsGloveData objects. More...
XsSyncLine	xsl4ToXsl (SyncLineMk4 mk4Line)
	Translate an SyncLineMk4 into a generic XsSyncLine. More...
XsSyncLine	xslgmtToXsl (SyncLineGmt mk4Line)
	Translate an SyncLineGmt into a generic XsSyncLine. More...
SyncLineMk4	xslToXsl4 (XsSyncLine line)
	Translate an XsSyncLine into a Mk4-specififc SyncLineMk4. More...
SyncLineGmt	xslToXslgmt (XsSyncLine line)
	Translate an XsSyncLine into a SyncLineGmt. More...
XSMATHINLINE XsReal	XsMath_asinClamped (const XsReal x)
	Returns asin(x) for -1 < x < 1. More...
XSMATHINLINE XsReal	XsMath_deg2rad (XsReal degrees)
	Convert degrees to radians. More...
XSMATHINLINE2 int64_t	XsMath_doubleToInt64 (double d)
	Returns d integer converted from a double precision floating point value. More...
XSMATHINLINE2 int32_t	XsMath_doubleToLong (double d)
	Returns d integer converted from a double precision floating point value. More...
XSMATHINLINE2 int64_t	XsMath_floatToInt64 (float d)
	Returns d integer converted from a single precision floating point value. More...
XSMATHINLINE2 int32_t	XsMath_floatToLong (float d)
	Returns d integer converted from a single precision floating point value. More...
XSMATHINLINE2 int	XsMath_isFinite (XsReal x)
	Returns non-zero if x is finite. More...
XSMATHINLINE XsReal	XsMath_pow2 (XsReal a)
	Returns a to the power of 2. More...
XSMATHINLINE XsReal	XsMath_pow3 (XsReal a)
	Returns a to the power of 3. More...
XSMATHINLINE XsReal	XsMath_pow5 (XsReal a)
	Returns a to the power of 5. More...
XSMATHINLINE XsReal	XsMath_rad2deg (XsReal radians)
	Convert radians to degrees. More...
void	XsMatrix3x3_assign (XsMatrix3x3 *thisPtr, const XsReal *src, XsSize srcStride)
	Init the XsMatrix3x3 and copy the data from src into the matrix if src is not null. More...
void	XsMatrix3x3_construct (XsMatrix3x3 *thisPtr)
	Init the XsMatrix3x3. More...
void	XsMatrix3x3_copy (XsMatrix *copy, XsMatrix3x3 const *src)
	Copy the contents of the XsMatrix3x3 to copy. More...
void	XsMatrix3x3_destruct (XsMatrix3x3 *thisPtr)
	Frees the Matrix3x3. More...
void	XsMatrix_assign (XsMatrix *thisPtr, XsSize rows, XsSize cols, XsSize stride, const XsReal *src, XsSize srcStride)
	Init the XsMatrix and copy the data from src into the matrix if src is not null. More...
void	XsMatrix_construct (XsMatrix *thisPtr, XsSize rows, XsSize cols, XsSize stride, const XsReal *src, XsSize srcStride)
	Init the XsMatrix and copy the data from src into the matrix if src is not null. More...
void	XsMatrix_copy (XsMatrix *copy, XsMatrix const *src)
	Copy the contents of copy to the XsMatrix. More...
void	XsMatrix_destruct (XsMatrix *thisPtr)
	Clear the XsMatrix and release allocated resources. More...
int	XsMatrix_dimensionsMatch (const XsMatrix *thisPtr, XsSize rows, XsSize columns)
	Returns not zero if the dimensions of the XsMatrix are equal to rows and columns. More...
int	XsMatrix_empty (const XsMatrix *thisPtr)
	Returns not zero if the matrix contains no values. More...
void	XsMatrix_fromQuaternion (XsMatrix *thisPtr, const XsQuaternion *quat)
	Get an orientation matrix representation of the quaternion. More...
void	XsMatrix_multiplyScalar (const XsMatrix *thisPtr, XsReal scalar, XsMatrix *dest)
	Multiplies all values in this XsMatrix by scalar. More...
XsSize	XsMatrix_offset (const XsMatrix *thisPtr, XsSize row, XsSize column)
	Returns the offset in the data for accessing the value at row and column. More...
void	XsMatrix_ref (XsMatrix *thisPtr, XsSize rows, XsSize cols, XsSize stride, XsReal *buffer, XsDataFlags flags)
	Construct the XsMatrix as a reference to data in buffer. More...
void	XsMatrix_setValue (XsMatrix *thisPtr, XsSize row, XsSize column, XsReal value)
	Sets the data value at row and column. More...
void	XsMatrix_setZero (XsMatrix *thisPtr)
	Set all the values in the matrix to zero. More...
void	XsMatrix_swap (XsMatrix *a, XsMatrix *b)
	Swap the contents of a and b. More...
XsReal	XsMatrix_value (const XsMatrix *thisPtr, XsSize row, XsSize column)
	Returns the data value at row and column. More...
void	XsMessage_assign (XsMessage *thisPtr, XsSize dataSize)
	This function reinitializes the XsMessage object and reserves dataSize bytes for data. More...
static const uint8_t *	XsMessage_cdataAtOffset (XsMessage const *thisPtr, XsSize offset)
	return the const data at offset offset More...
int	XsMessage_compare (XsMessage const *a, XsMessage const *b)
	Compare the contents of the messages a and b, returning non-0 if they are different. More...
uint8_t	XsMessage_computeChecksum (XsMessage const *thisPtr)
	Computes the checksum for the message. More...
const uint8_t *	XsMessage_constData (XsMessage const *thisPtr, XsSize offset)
	This function returns a const pointer to the offset in the data of the message in thisptr. More...
void	XsMessage_construct (XsMessage *thisPtr)
	This function initializes the XsMessage object. More...
void	XsMessage_constructSized (XsMessage *thisPtr, XsSize dataSize)
	This function initializes the XsMessage object and reserves dataSize bytes for data. More...
void	XsMessage_copy (XsMessage *copy, XsMessage const *thisPtr)
	This function copies from thisPtr to copy. More...
void	XsMessage_copyConstruct (XsMessage *thisPtr, XsMessage const *src)
	Construct an XsMessage as a copy of XsMessage src. More...
static uint8_t *	XsMessage_dataAtOffset (XsMessage *thisPtr, XsSize offset)
	Get the buffer at offset offset. More...
XsSize	XsMessage_dataSize (XsMessage const *thisPtr)
	This function returns the datasize of the message in thisptr. More...
void	XsMessage_deleteData (XsMessage *thisPtr, XsSize count, XsSize offset)
	Remove count bytes of data from the message at offset. More...
void	XsMessage_destruct (XsMessage *thisPtr)
	This function clears the data in the message. More...
int	XsMessage_empty (XsMessage const *thisPtr)
	Test if this message is empty. More...
static void	XsMessage_ensureDataSize (XsMessage *thisPtr, XsSize offset, XsSize sizeofValue)
	Make sure the data buffer is large enough to hold a new data item of sizeofValue. More...
const XsMessageHeader *	XsMessage_getConstHeader (XsMessage const *thisPtr)
const uint8_t *	XsMessage_getDataBuffer (XsMessage const *thisPtr, XsSize offset)
	Returns a const pointer to the data buffer of the message. More...
uint8_t	XsMessage_getDataByte (XsMessage const *thisPtr, XsSize offset)
	Returns the byte value at offset in the data of the message. More...
double	XsMessage_getDataDouble (XsMessage const *thisPtr, XsSize offset)
	Returns the double at offset in the data of the message. More...
double	XsMessage_getDataF1220 (XsMessage const *thisPtr, XsSize offset)
	Returns the F12.20 value at offset in the data of the message. More...
float	XsMessage_getDataFloat (XsMessage const *thisPtr, XsSize offset)
	Returns the float value at offset in the data of the message. More...
double	XsMessage_getDataFP1632 (XsMessage const *thisPtr, XsSize offset)
	Returns the F16.32 value at offset in the data of the message. More...
void	XsMessage_getDataFPValuesById (XsMessage const *thisPtr, XsDataIdentifier dataIdentifier, double *dest, XsSize offset, XsSize numValues)
	Return current data values as double, conversion depends on outputSetting. More...
uint32_t	XsMessage_getDataLong (XsMessage const *thisPtr, XsSize offset)
	Returns the long value at offset in the data of the message. More...
uint64_t	XsMessage_getDataLongLong (XsMessage const *thisPtr, XsSize offset)
	Returns the long value at offset in the data of the message. More...
void	XsMessage_getDataRealValuesById (XsMessage const *thisPtr, XsDataIdentifier dataIdentifier, XsReal *dest, XsSize offset, XsSize numValues)
	Return current data values as XsReal, conversion is done automatically based on data identifier. More...
uint16_t	XsMessage_getDataShort (XsMessage const *thisPtr, XsSize offset)
	Returns the short value at offset in the data of the message. More...
void	XsMessage_getEndianCorrectData (XsMessage const *thisPtr, void *value, XsSize size, XsSize offset)
	Get data of size size at offset, and put it byteswapped into value. More...
uint8_t	XsMessage_getFPValueSize (XsDataIdentifier id)
	Returns the byte size of id if the format is a floating point format. More...
XsMessageHeader *	XsMessage_getHeader (XsMessage *thisPtr)
	Returns a pointer to the message header for this message. More...
const uint8_t *	XsMessage_getMessageStart (XsMessage const *thisPtr)
	This function returns a const pointer to the header of the message in thisptr. More...
XsSize	XsMessage_getTotalMessageSize (XsMessage const *thisPtr)
	Return the length of the message buffer. More...
void	XsMessage_insertData (XsMessage *thisPtr, XsSize count, XsSize offset)
	Create count bytes of empty space at offset in this message. More...
int	XsMessage_isChecksumOk (XsMessage const *thisPtr)
	Returns non-zero if the checksum inside the message is correct for the message, zero otherwise. More...
void	XsMessage_load (XsMessage *thisPtr, XsSize msgSize, unsigned char const *src)
	This function initializes the XsMessage object and reserves msgSize bytes for data, it then copies in the data from src. More...
void	XsMessage_recomputeChecksum (XsMessage *thisPtr)
	Update the checksum for the message. More...
void	XsMessage_resizeData (XsMessage *thisPtr, XsSize newSize)
	Resize the buffer of message to newSize bytes. More...
void	XsMessage_setBusId (XsMessage *thisPtr, uint8_t busId)
	Set the bus id for this message to busId. More...
void	XsMessage_setDataBuffer (XsMessage *thisPtr, const uint8_t *buffer, XsSize size, XsSize offset)
	Puts size number of bytes from buffer into the message at offset. More...
void	XsMessage_setDataByte (XsMessage *thisPtr, uint8_t value, XsSize offset)
	Set the byte at offset in the message to value. More...
void	XsMessage_setDataDouble (XsMessage *thisPtr, double value, XsSize offset)
	Sets the double at offset in the message to value. More...
void	XsMessage_setDataF1220 (XsMessage *thisPtr, double value, XsSize offset)
	Sets the F12.20 at offset in the message to value. More...
void	XsMessage_setDataFloat (XsMessage *thisPtr, float value, XsSize offset)
	Sets the float at offset in the message to value. More...
void	XsMessage_setDataFP1632 (XsMessage *thisPtr, double value, XsSize offset)
	Sets the F16.32 at offset in the message to value. More...
void	XsMessage_setDataFPValuesById (XsMessage *thisPtr, XsDataIdentifier dataIdentifier, double const *data, XsSize offset, XsSize numValues)
	Write a number of floating/fixed point values into to the data buffer, conversion depends on outputSettings. More...
void	XsMessage_setDataLong (XsMessage *thisPtr, uint32_t value, XsSize offset)
	Sets the long at offset in the message to value. More...
void	XsMessage_setDataLongLong (XsMessage *thisPtr, uint64_t value, XsSize offset)
	Sets the long at offset in the message to value. More...
void	XsMessage_setDataRealValuesById (XsMessage *thisPtr, XsDataIdentifier dataIdentifier, XsReal const *data, XsSize offset, XsSize numValues)
	Write a number of floating/fixed point values into to the data buffer, conversion depends on data identifier. More...
void	XsMessage_setDataShort (XsMessage *thisPtr, uint16_t value, XsSize offset)
	Sets the short at offset in the message to value. More...
void	XsMessage_setEndianCorrectData (XsMessage *thisPtr, void const *value, XsSize size, XsSize offset)
	Set value value of size size byteswapped at offset. More...
void	XsMessage_setMessageId (XsMessage *thisPtr, enum XsXbusMessageId msgId)
	Set the message id for this message to msgId. More...
void	XsMessage_swap (XsMessage *a, XsMessage *b)
	Swap the contents of a and b. More...
void	XsMessage_toHexString (XsMessage const *thisPtr, XsSize maxBytes, XsString *resultValue)
	Return a string containing the first maxBytes bytes of the message in hex format. More...
static void	XsMessage_updateChecksumWithValue (XsMessage *thisPtr, const void *value, XsSize sizeofValue, XsSize offset)
	Update the message checksum with the passed value. More...
void XSTYPES_DLL_API	xsNameThisThread (const char *threadName)
	Set the name of the current thread to threadName. More...
const char *	XsPortInfo_bluetoothAddress (const struct XsPortInfo *thisPtr)
	Returns the bluetooth address. More...
void	XsPortInfo_clear (XsPortInfo *thisPtr)
	Initializes the object to the empty state. More...
int	XsPortInfo_empty (const struct XsPortInfo *thisPtr)
	Returns true if the XsPortInfo object is empty. More...
int	XsPortInfo_isBluetooth (const struct XsPortInfo *thisPtr)
	Returns true if this port info object contains a bluetooth device. More...
int	XsPortInfo_isNetwork (const struct XsPortInfo *thisPtr)
	Returns true if this port info object contains a network device. More...
int	XsPortInfo_isUsb (const struct XsPortInfo *thisPtr)
	Returns true if this port info object contains a USB device. More...
const char *	XsPortInfo_networkServiceName (const struct XsPortInfo *thisPtr)
	Returns the network service name of this port. More...
int	XsPortInfo_portNumber (const struct XsPortInfo *thisPtr)
	The port number. More...
void	XsPortInfo_swap (struct XsPortInfo *a, struct XsPortInfo *b)
	Swap the contents of a with those of b. More...
int	XsPortInfo_usbAddress (const struct XsPortInfo *thisPtr)
	The usb address. More...
int	XsPortInfo_usbBus (const struct XsPortInfo *thisPtr)
	The usb bus. More...
int	XsQuaternion_compare (XsQuaternion const *thisPtr, XsQuaternion const *other, XsReal tolerance)
	Returns non-zero if the values at thisPtr and other are within tolerance of each other. More...
void	XsQuaternion_copy (XsQuaternion *copy, XsQuaternion const *src)
	Copies the contents of thisPtr into copy. More...
void	XsQuaternion_destruct (XsQuaternion *thisPtr)
	Sets the contents to 0, which is an invalid XsQuaternion. More...
XsReal	XsQuaternion_dotProduct (XsQuaternion const *thisPtr, XsQuaternion const *other)
	Returns the dot product of the thisPtr with other. More...
int	XsQuaternion_empty (const XsQuaternion *thisPtr)
	Test if this is a null object. More...
int	XsQuaternion_equal (XsQuaternion const *a, XsQuaternion const *b)
	returns non-zero if a and b are numerically equal More...
void	XsQuaternion_fromEulerAngles (XsQuaternion *thisPtr, const XsEuler *src)
	Create a quaternion representation from euler angles. More...
void	XsQuaternion_fromRotationMatrix (XsQuaternion *thisPtr, const XsMatrix *ori)
	Create a quaternion representation of orientation matrix ori. More...
const XsQuaternion *	XsQuaternion_identity (void)
	Returns an XsQuaternion that represents the identity quaternion. More...
void	XsQuaternion_inverse (const XsQuaternion *thisPtr, XsQuaternion *dest)
	Compute the inverse/conjugate of this quaternion. More...
void	XsQuaternion_invert (XsQuaternion *thisPtr)
	Invert this quaternion. More...
void	XsQuaternion_multiply (const XsQuaternion *left, const XsQuaternion *right, XsQuaternion *dest)
	Multiply left quaternion with right quaternion and put the result in dest. The parameters may point to the same XsQuaternion(s). More...
XsReal	XsQuaternion_normalize (XsQuaternion *thisPtr)
	Normalize this quaternion. More...
XsReal	XsQuaternion_normalized (const XsQuaternion *thisPtr, XsQuaternion *dest)
	Create a normalized version of this quaternion. More...
void	XsQuaternion_swap (XsQuaternion *a, XsQuaternion *b)
	Swap the contents of a and b. More...
int	XsRange_contains (const XsRange *thisPtr, int i)
	Test if the range contains the given value i. More...
int	XsRange_count (const XsRange *thisPtr)
	Get the number of values in the range. More...
int	XsRange_empty (const XsRange *thisPtr)
	Test if the range is empty. More...
int	XsRange_interval (const XsRange *thisPtr)
	Get the number of values in the range. More...
void	XsRange_setRange (XsRange *thisPtr, int f, int l)
	Set a new range. More...
const char *	XsRejectReason_toString (XsRejectReason r)
	Convert the XsRejectReason to a human readable string. More...
const char *	XsResultValue_toString (XsResultValue result)
	Retrieve a character string corresponding to the given result code. More...
XSTYPES_DLL_API int	XsRssi_max (void)
	The maximum RSSI value. More...
XSTYPES_DLL_API int	XsRssi_unbiased (int raw)
	Returns the raw RSSI value transformed into a usable (unbiased) number. More...
XSTYPES_DLL_API int	XsRssi_unknown (void)
	The RSSI value that was reserved for when the RSSI is unknown. More...
void	XsSdiData_construct (XsSdiData *thisPtr, const XsReal *orientationIncrement, const XsReal *velocityIncrement)
	Initialize an XsSdiData object with the optional arguments. More...
void	XsSdiData_destruct (XsSdiData *thisPtr)
	Destruct the object, makes the fields invalid. More...
int	XsSimpleVersion_compare (XsSimpleVersion const *a, XsSimpleVersion const *b)
	Compare two XsSimpleVersion objects. More...
int	XsSimpleVersion_empty (const XsSimpleVersion *thisPtr)
	Test if this is a null-version. More...
void	XsSimpleVersion_osVersion (XsSimpleVersion *thisPtr)
	Platdorm independent request of the OS version. Results are cached and of course platform dependent. More...
void	XsSimpleVersion_swap (struct XsSimpleVersion *a, struct XsSimpleVersion *b)
	Swap the contents of a with those of b. More...
void	XsSnapshot_construct (XsSnapshot *thisPtr)
	Construct an XsSnapshot object. More...
void	XsSnapshot_destruct (XsSnapshot *thisPtr)
	Destruct an XsSnapshot object. More...
int	XsSyncSetting_compare (const struct XsSyncSetting *a, const struct XsSyncSetting *b)
	Compares a with b. More...
int	XsSyncSetting_isInput (const XsSyncSetting *thisPtr)
	Returns whether the selected line is configured as an input line. More...
int	XsSyncSetting_isOutput (const XsSyncSetting *thisPtr)
	Returns whether the selected line is configured as an output line. More...
void	XsSyncSetting_swap (XsSyncSetting *a, XsSyncSetting *b)
	Swap the contents of a with b. More...
void	XsTime_getDateAsString (char *dest, const struct tm *date)
	Retrieves the date as string representation The format is YYYYMMDD so 25 dec 2010 is stored as an array dest[9] = { '2', '0', '1', '0', '1', '2', '2', '5' }. More...
void	XsTime_getDateAsWString (wchar_t *dest, const struct tm *date)
	Retrieves the date as wstring representation The format is YYYYMMDD so 25 dec 2010 is stored as an array dest[8] = {'2', '0', '1', '0', '1', '2', '2', '5' }. More...
int64_t	XsTime_getDateTime (struct tm *date)
	Retrieves the date and time (platform-independent) More...
void	XsTime_getTimeAsString (char *dest, const struct tm *date)
	Retrieves the time as binary The format is HHMMSShh (where H is hour and 'h' is hundredths) so 14:25:01.23 is stored as an array dest[8] = { '1', '4', '2', '5', '0', '1', '2', '3'}. More...
void	XsTime_getTimeAsWString (wchar_t *dest, const struct tm *date)
	Retrieves the time as binary The format is HHMMSShh (where H is hour and 'h' is hundredths) so 14:25:01.23 is stored as an array dest[8] = { '1', '4', '2', '5', '0', '1', '2', '3'}. More...
uint32_t	XsTime_getTimeOfDay (struct tm *date_, time_t *secs_)
	The function returns the current time of day in ms since midnight. More...
void	XsTime_initializeTime ()
	Stabilize the clock. More...
int64_t	XsTime_localToUtc ()
	Returns the conversion value from local time to UTC time in ms. More...
void	XsTime_msleep (uint32_t ms)
	Make the current thread sleep for at least ms milliseconds. More...
int64_t	XsTime_timeStampNow (XsTimeStamp *now)
	Returns the current time in ms since the epoch (Jan 1st 1970) More...
void	XsTime_udelay (uint64_t us)
	Delays the current thread for at least us microseconds. More...
int64_t	XsTime_utcToLocal ()
	Returns the conversion value from UTC time to local time in ms. More...
void	XsTimeInfo_currentLocalTime (struct XsTimeInfo *thisPtr)
	Returns the current local time. More...
void	XsTimeInfo_currentTime (struct XsTimeInfo *thisPtr)
	Returns the current UTC time. More...
void	XsTimeInfo_makeUtc (struct XsTimeInfo *thisPtr)
	Removes the local time information, making the object pure UTC. More...
int64_t	XsTimeStamp_fromTimeInfo (struct XsTimeStamp *thisPtr, const struct XsTimeInfo *info)
	Creates a (UTC) XsTimeStamp from an XsTimeInfo object. More...
int32_t	XsTimeStamp_hourPart (const XsTimeStamp *thisPtr)
	Returns the hours part of the time (in the range 0-23) More...
void	XsTimeStamp_localToUtcTime (struct XsTimeStamp const *thisPtr, struct XsTimeStamp *utc)
	Convert the supplied time from (assumed) local time to UTC, using the system's local time zone knowledge. More...
void	XsTimeStamp_localToUtcTime2 (struct XsTimeStamp const *thisPtr, struct XsTimeStamp *utc, const struct XsTimeInfo *info)
	Convert the supplied time from (assumed) local time to UTC, using the offset in info. More...
void	XsTimeStamp_localToUtcTime_ms (struct XsTimeStamp const *thisPtr, struct XsTimeStamp *utc, int64_t utcOffset)
	Convert the supplied time from (assumed) local time to UTC, using the offset in utcOffset. More...
int64_t	XsTimeStamp_maxValue (void)
	Returns the maximum value of an XsTimeStamp. More...
int32_t	XsTimeStamp_milliSecondPart (const XsTimeStamp *thisPtr)
	Returns the millisecond part of the time (in the range 0-999) More...
int32_t	XsTimeStamp_minutePart (const XsTimeStamp *thisPtr)
	Returns the minutes part of the time (in the range 0-59) More...
int64_t	XsTimeStamp_now (XsTimeStamp *dest)
	Returns the current time in ms since the epoch (Jan 1st 1970) More...
int32_t	XsTimeStamp_secondPart (const XsTimeStamp *thisPtr)
	Returns the seconds part of the time (in the range 0-59) More...
int64_t	XsTimeStamp_secondTime (const XsTimeStamp *thisPtr)
	Returns the number of seconds elapsed since the epoch as stored in the XsTimeStamp. More...
void	XsTimeStamp_setMilliSecondTime (XsTimeStamp *thisPtr, int64_t t)
	Set the stored time to miliseconds. More...
double	XsTimeStamp_timeOfDay (const XsTimeStamp *thisPtr)
	Get the time of day component of the stored timestamp in seconds as a double precision value. More...
void	XsTimeStamp_toString (struct XsTimeStamp const *thisPtr, struct XsString *result)
	Converts the timestamp into an XsString object in format YYYY/MM/DD hh:mm:ss.nnn. More...
void	XsTimeStamp_toTimeInfo (struct XsTimeStamp const *thisPtr, struct XsTimeInfo *info)
	Converts the timestamp into an XsTimeInfo object. More...
void	XsTimeStamp_utcToLocalTime (struct XsTimeStamp const *thisPtr, struct XsTimeStamp *local)
	Convert the supplied time from (assumed) UTC to local time, using the system's local time zone knowledge. More...
void	XsTimeStamp_utcToLocalTime2 (struct XsTimeStamp const *thisPtr, struct XsTimeStamp *local, const struct XsTimeInfo *info)
	Convert the supplied time from (assumed) UTC to local time, using the offset in info. More...
void	XsTimeStamp_utcToLocalTime_ms (struct XsTimeStamp const *thisPtr, struct XsTimeStamp *local, int64_t utcOffset)
	Convert the supplied time from (assumed) UTC to local time, using the offset in utcOffset. More...
void	XsTriggerIndicationData_destruct (XsTriggerIndicationData *thisPtr)
	Destroy the XsTriggerIndicationData object. More...
int	XsTriggerIndicationData_valid (const XsTriggerIndicationData *thisPtr)
	Returns true if the object is valid (line and polarity may not be 0) More...
void	XsUsbHubInfo_assign (XsUsbHubInfo *thisPtr, XsHubIdentifier hub)
	Assign a new hub identifier to the XsUsbHubInfo. More...
void	XsUsbHubInfo_construct (XsUsbHubInfo *thisPtr, XsHubIdentifier hub)
	Initialize the XsUsbHubInfo with hub. More...
void	XsUsbHubInfo_copy (XsUsbHubInfo *copy, XsUsbHubInfo const *src)
	Copy the contents of the XsUsbHubInfo to copy. More...
void	XsUsbHubInfo_destruct (XsUsbHubInfo *thisPtr)
	Destroy the XsUsbHubInfo. More...
int	XsUsbHubInfo_parentPathMatches (const XsUsbHubInfo *left, const XsUsbHubInfo *right)
	Returns true if the two hub info objects share the same device path. More...
void	XsUsbHubInfo_swap (XsUsbHubInfo *thisPtr, XsUsbHubInfo *thatPtr)
	Swap the two XsUsbHubInfo items. More...
void	XsUtcTime_currentTime (struct XsTimeInfo *thisPtr)
	Returns the current time in UTC date time format. More...
void	XsVector3_assign (XsVector3 *thisPtr, const XsReal *src)
	Init the XsVector3 and copy the data from src into the vector if src is not null. More...
void	XsVector3_construct (XsVector3 *thisPtr, const XsReal *src)
	Init the XsVector3 and copy the data from src into the vector if src is not null. More...
void	XsVector3_copy (XsVector *copy, XsVector3 const *src)
	Copy the contents of the XsVector3 to copy. More...
void	XsVector3_destruct (XsVector3 *thisPtr)
	Frees the XsVector3. More...
void	XsVector_angularVelocityFromQuaternion (XsVector *thisPtr, XsReal deltaT, const XsQuaternion *quat)
	Get an effective angular velocity from the quaternion, which must represent a delta angle. More...
void	XsVector_assign (XsVector *thisPtr, XsSize sz, const XsReal *src)
	Initialize the XsVector using sz number of items from src. More...
XsReal	XsVector_cartesianLength (const XsVector *thisPtr)
	Compute and return the cartesian length. More...
int	XsVector_compare (const struct XsVector *thisPtr, const struct XsVector *thatPtr, XsReal epsilon)
	Returns non-zero if the two vectors are equal within epsilon. More...
void	XsVector_construct (XsVector *thisPtr, XsSize sz, const XsReal *src)
	Initialize the XsVector using sz number of items from src. More...
void	XsVector_copy (XsVector *copy, XsVector const *src)
	Copy the contents of the XsVector to copy. More...
void	XsVector_destruct (XsVector *thisPtr)
	Release and clear the contents of the vector. More...
XsReal	XsVector_dotProduct (const XsVector *a, const XsVector *b)
	Compute and return the dot product of XsVectors a and b. More...
int	XsVector_empty (const XsVector *thisPtr)
	Returns a non-zero value if the XsVector does not contain any values. More...
int	XsVector_equal (const struct XsVector *a, const struct XsVector *b)
	Returns non-zero when the two vectors are identical. More...
void	XsVector_fill (struct XsVector *thisPtr, XsReal value)
	Sets all elements of the XsVector to value. More...
void	XsVector_multiplyScalar (const XsVector *thisPtr, XsReal scalar, XsVector *dest)
	Multiplies all values in this XsVector by scalar and puts the result in XsVector dest. More...
void	XsVector_normalize (XsVector *thisPtr)
	Normalize the vector. More...
void	XsVector_ref (XsVector *thisPtr, XsSize sz, XsReal *buffer, XsDataFlags flags)
	Initialize the XsVector to refer to the supplied buffer. More...
void	XsVector_setZero (XsVector *thisPtr)
	Sets all elements of the XsVector to 0. More...
void	XsVector_swap (XsVector *a, XsVector *b)
	Swap the contents of a and b. More...
int	XsVersion_empty (const XsVersion *thisPtr)
	Test if this is a null-version. More...
void	XsVersion_fromSimpleVersion (XsVersion *thisPtr, const XsSimpleVersion *simpleVersion)
	Create a XsVersion a XsSimpleVersion, simpleVersion. More...
void	XsVersion_fromString (XsVersion *thisPtr, const XsString *version)
	Set the version to the values in the string. More...
void	XsVersion_toSimpleString (const XsVersion *thisPtr, XsString *version)
	Get a string with the version expressed in a readable format. More...
void	XsVersion_toSimpleVersion (const XsVersion *thisPtr, XsSimpleVersion *simpleVersion)
	Create a XsSimpleVersion (version) from a XsVersion. More...
void	XsVersion_toString (const XsVersion *thisPtr, XsString *version)
	Get a string with the version expressed in a readable format. More...

Variables
const typedef char *	XsHubIdentifier
XSMATHCONST XsReal	XsMath_deg2radValue = 0.017453292519943295769236907684886
	Value to convert degrees to radians by multiplication. More...
XSMATHCONST XsReal	XsMath_denormalized = 1e-307
	Value that represents the subnormal number in floating point wizardry. More...
XSMATHCONST XsReal	XsMath_e = 2.7182818284590452353602874713527
	The value e. More...
XSMATHCONST XsReal	XsMath_epsilon = 2.2204460492503131e-016
	A value related to the precision of floating point arithmetic (2.2204460492503131e-016) More...
XSMATHCONST XsReal	XsMath_four = 4.0
	4 More...
XSMATHCONST XsReal	XsMath_halfPi = 1.5707963267948966192313216916397514420985846996875529104874
	pi/2 More...
XSMATHCONST XsReal	XsMath_hugeValue = 1.0e+16
	A convincingly large number. More...
XSMATHCONST XsReal	XsMath_infinity = DBL_MAX
	infinity value More...
XSMATHCONST XsReal	XsMath_minusHalfPi = -1.5707963267948966192313216916397514420985846996875529104874
	-pi/2 More...
XSMATHCONST XsReal	XsMath_minusOne = -1.0
	-1.0 More...
XSMATHCONST XsReal	XsMath_minusPt5 = -0.5
	-0.5 More...
XSMATHCONST XsReal	XsMath_minusTwo = -2.0
	-2 More...
XSMATHCONST XsReal	XsMath_one = 1.0
	1.0 More...
XSMATHCONST XsReal	XsMath_pi = 3.1415926535897932384626433832795028841971693993751058209749
	The value pi. More...
XSMATHCONST XsReal	XsMath_pt25 = 0.25
	0.25 More...
XSMATHCONST XsReal	XsMath_pt5 = 0.5
	0.5 More...
XSMATHCONST XsReal	XsMath_rad2degValue = 57.295779513082320876798154814105
	Value to convert radians to degrees by multiplication. More...
XSMATHCONST XsReal	XsMath_sqrt2 = 1.4142135623730950488016887242097
	sqrt(2) More...
XSMATHCONST XsReal	XsMath_sqrtDenormalized = 3.1622776601683793319988935444327e-154
	Square root of XsMath_denormalized. More...
XSMATHCONST XsReal	XsMath_sqrtEpsilon = 1.4901161193847656e-008
	Square root of XsMath_epsilon. More...
XSMATHCONST XsReal	XsMath_sqrtHalf = 0.5 * 1.4142135623730950488016887242097
	sqrt(0.5) More...
XSMATHCONST XsReal	XsMath_tinyValue = 1.0e-16
	A really small value. More...
XSMATHCONST XsReal	XsMath_two = 2.0
	2 More...
XSMATHCONST XsReal	XsMath_twoPi = 6.2831853071795864769252867665590057683943387987502116419498
	2*pi More...
XSMATHCONST XsReal	XsMath_zero = 0.0
	0 More...

Detailed Description

Macro Definition Documentation

XS_BID_BROADCAST

#define XS_BID_BROADCAST   0x00

The bus broadcast bus identifier (all devices)

Definition at line 76 of file xsbusid.h.

XS_BID_DYNAMIC

#define XS_BID_DYNAMIC   0xFE

A dynamic bus identifier.

Definition at line 87 of file xsbusid.h.

XS_BID_INVALID

#define XS_BID_INVALID   0xFD

An invalid bus identifier.

Note

This value may change between API releases as it is not strictly part of the Xbus protocol but only used internally

Definition at line 84 of file xsbusid.h.

XS_BID_MASTER

#define XS_BID_MASTER   0xFF

The bus identifier of the master device.

Definition at line 73 of file xsbusid.h.

XS_BID_MT

#define XS_BID_MT   0x01

The bus identifier for the first MT on the bus.

Definition at line 79 of file xsbusid.h.

Typedef Documentation

Itypes

typedef union Itypes Itypes

Definition at line 193 of file xsmessage.c.

XsFileHandle

XsFileHandle

The type that is used for low-level identification of an open file.

Definition at line 106 of file xsfilepos.h.

XsFilePos

XsFilePos

The type that is used for positioning inside a file.

Definition at line 102 of file xsfilepos.h.

XsIoHandle

XsIoHandle

The type that is used for low-level identification of an open I/O device.

Definition at line 104 of file xsfilepos.h.

Function Documentation

byteSum()

uint8_t byteSum	(	const uint8_t *	buffer,
		XsSize	count
	)

Calculate the sum of the values in the buffer.

This function calculates the sum of the byte values for the first count bytes in the buffer

Parameters

buffer	An array of (unsigned) bytes
count	The number of bytes in the buffer

Returns

The unsigned sum of the byte values in the buffer modulo 256

Definition at line 201 of file xsmessage.c.

convertedVector()

static XsVector* convertedVector ( const XsDataPacket *  thisPtr, XsVector *  returnVal, XsDataIdentifier  id, XsUShortVector XsScrData::*  field  )

static

Returns

the data component specified by id and field, converted to floating point values

Parameters

[in]	id	The data identifier of the data component
[in]	field	Pointer to a member in XsScrData, pointing to the data to retrieve
[out]	returnVal	the returned floating point values

Definition at line 2473 of file xsdatapacket.cpp.

convertFromFloat()

static double convertFromFloat ( float  f )

static

Returns

a double converted from float f

\param[in] f The float to convert

Definition at line 769 of file xsmessage.c.

convertRawVector()

static void convertRawVector ( XsUShortVector const &  input, XsDataIdentifier  id, XsVector &  returnVal  )

static

Converts input vector input with data identifier id to output XsVector returnVal.

Definition at line 2458 of file xsdatapacket.cpp.

convertToFloat()

static float convertToFloat ( double  d )

static

Returns

a float converted from double d

\param[in] d The double to cenvert

Definition at line 782 of file xsmessage.c.

fuzzyIsEqual()

static int fuzzyIsEqual ( double  a, double  b, double  tolerance  )

static

Checks whether a and b are equal with tolerance tolerance.

Parameters

[in]	a	double a
[in]	b	double b
[in]	tolerance	The tolerance

Returns

a positive value when a and b are considered equal

Definition at line 315 of file xsquaternion.c.

openFile()

static FILE * openFile ( const struct XsString *  filename, const struct XsString *  mode  )

static

Helper for file opening.

Definition at line 245 of file xsfile.c.

removeAllOrientations()

static void removeAllOrientations ( XsDataPacket *  thisPtr )

static

Removes all orientations from the datapacket.

Definition at line 999 of file xsdatapacket.cpp.

signed_cast()

static XsReal signed_cast ( uint16_t  v )

static

helper for XsDataPacket_convertRawVector

Definition at line 537 of file xsdatapacket.cpp.

swapEndian()

static void swapEndian ( void *  data, const XsSize  size  )

inlinestatic

Swap the endianness based on the data size.

Definition at line 246 of file xsmessage.c.

unsigned_cast()

static XsReal unsigned_cast ( uint16_t  v )

static

helper for XsDataPacket_convertRawVector

Definition at line 543 of file xsdatapacket.cpp.

XsArray_append()

void XsArray_append ( void *  thisPtr, void const *  other  )

related

Appends the other list to thisArray list.

Parameters

other

The list to append to thisArray list. other may point to thisArray list

Definition at line 319 of file xsarray.c.

XsArray_assign()

void XsArray_assign ( void *  thisPtr, XsSize  count, void const *  src  )

related

Reinitializes the XsArray with space for count items and copies them from src.

This function reinitializes the object reserving space for at least count items in the buffer. count may be 0. If src is not 0, count items will be copied from src. Previous data will be cleared automatically, but the reserved space will not be reduced.

Parameters

count	the number of items in src
src	a pointer to an array of items

See also

XsArray_reserve

Definition at line 186 of file xsarray.c.

XsArray_at()

void const * XsArray_at ( void const *  thisPtr, XsSize  index  )

related

Returns a pointer to the item at the supplied index or a null pointer if it is out of bounds.

Parameters

index

The index of the item to return

Returns

A pointer to the item or NULL if index is out of bounds

Definition at line 625 of file xsarray.c.

XsArray_atIndex()

void * XsArray_atIndex ( void *  thisPtr, XsSize  index  )

related

Returns a pointer to the item at the supplied index or a null pointer if it is out of bounds.

Parameters

index

The index of the item to return

Returns

A pointer to the item or NULL if index is out of bounds

Definition at line 638 of file xsarray.c.

XsArray_compare()

int XsArray_compare ( void const *  a, void const *  b  )

related

Returns non-zero if the lists are different, 0 if they're equal.

This function compares the two lists in-order

Parameters

a	The left hand side of the comparison
b	The right hand side of the comparison

Returns

-1 if a is smaller in some way than b, 1 if it is larger in some way and 0 if both lists are equal. Please note that not all lists have items that can be accurately tested for less than or greater than, but can be tested for (in-)equality. So the sign of the return value should be treated with knowledge of the data type in mind.

See also

XsArray_compareSet

XsArray_comparePredicate

Definition at line 479 of file xsarray.c.

XsArray_comparePredicate()

int XsArray_comparePredicate ( void const *  a, void const *  b, XsArrayItemCompareFunc  predicate  )

related

Returns non-zero if the lists are different, 0 if they're equal.

This function compares the two lists in-order

Parameters

a	The left hand side of the comparison
b	The right hand side of the comparison
predicate	The custom comparison predicate to use. It should return 0 when the items are considered equal (see return values below).

Returns

-1 if a is smaller in some way than b, 1 if it is larger in some way and 0 if both lists are equal. Please note that not all lists have items that can be accurately tested for less than or greater than, but can be tested for (in-)equality. So the sign of the return value should be treated with knowledge of the data type in mind.

See also

XsArray_compareSet

XsArray_compare

Definition at line 514 of file xsarray.c.

XsArray_compareSet()

int XsArray_compareSet ( void const *  a, void const *  b  )

related

Returns -1 if a is smaller in some way than b, 1 if it is larger in some way and 0 if both lists are equal.

This function compares the two lists out-of-order

Parameters

a	The left hand side of the comparison
b	The right hand side of the comparison

Returns

-1 if a is smaller in some way than b, 1 if it is larger in some way

Note

It is assumed that both arguments are sets i.e. they contain no duplicates. It is the responsibility of the caller to provide sets as arguments and 0 if both lists are equal. Please note that not all lists have items that can be accurately tested for less than or greater than, but can be tested for (in-)equality. So the sign of the return value should be treated with knowledge of the data type in mind.

See also

XsArray_compare

XsArray_comparePredicate

Definition at line 549 of file xsarray.c.

XsArray_construct()

void XsArray_construct ( void *  thisPtr, XsArrayDescriptor const *const  descriptor, XsSize  count, void const *  src  )

related

Initializes the XsArray with space for count items and copies them from src.

This function initializes the object reserving count items in the buffer. count may be 0. If src is not 0, count items from src will be copied.

Parameters

descriptor	The descriptor of the data in the list
count	The number of items to reserve space for. When src is not NULL, thisArray is also the number of items copied from src
src	A pointer to an array of objects to copy, may be NULL, ignored when count is 0

Definition at line 102 of file xsarray.c.

XsArray_copy()

void XsArray_copy ( void *  thisPtr, void const *  src  )

related

Copy the contents of src to thisArray.

Definition at line 305 of file xsarray.c.

XsArray_copyConstruct()

void XsArray_copyConstruct ( void *  thisPtr, void const *  src  )

related

Initializes the XsArray with a copy of src.

Parameters

src	A pointer to the objects to copy. The object may be empty, but src may not be 0

Definition at line 144 of file xsarray.c.

XsArray_destruct()

void XsArray_destruct ( void *  thisPtr )

related

Clears and frees memory allocated by the XsArray.

Note

After XsArray_destruct is called, the object is empty but valid, ie. it can be used as if XsArray_construct has been called on it.

Definition at line 157 of file xsarray.c.

XsArray_empty()

int XsArray_empty ( void const *  thisPtr )

related

Returns whether the array is empty.

This differs slightly from a straight check for size() != 0 in that it also works for fixed-size XsArrays.

Returns

true if the array is empty.

Definition at line 693 of file xsarray.c.

XsArray_erase()

void XsArray_erase ( void *  thisPtr, XsSize  index, XsSize  count  )

related

Removes a count items from the list starting at index.

Definition at line 448 of file xsarray.c.

XsArray_find()

ptrdiff_t XsArray_find ( void const *  thisPtr, void const *  needle  )

related

Returns the index of needle in the list or -1 if it wasn't found.

The search does not assume any kind of ordering of the items so in a worst-case scenario it will go through the entire list.

Parameters

needle

A pointer to the value to search for

Returns

The index of where needle was found or -1 if it wasn't found.

Definition at line 585 of file xsarray.c.

XsArray_findPredicate()

ptrdiff_t XsArray_findPredicate ( void const *  thisPtr, void const *  needle, XsArrayItemCompareFunc  predicate  )

related

Returns the index of needle in the list or -1 if it wasn't found.

The search does not assume any kind of ordering of the items so in a worst-case scenario it will go through the entire list. It will use the supplied predicate to match items against needle.

Parameters

needle	A pointer to the value to search for
predicate	A compare function that returns 0 if the values are equal. The arguments are (const void) pointers to items, supplied as such: predicate(item, needle)

Returns

The index of where needle was found or -1 if it wasn't found.

Definition at line 607 of file xsarray.c.

XsArray_insert()

void XsArray_insert ( void *  thisPtr, XsSize  index, XsSize  count, void const *  src  )

related

Insert count items from src at index in the array.

Parameters

index	The index to use for inserting. Anything beyond the end of the array (ie. -1) will append to the actual end of the array.
count	The number of items to insert
src	The items to insert, may not be 0 unless count is 0

Definition at line 372 of file xsarray.c.

XsArray_rawCopy()

void XsArray_rawCopy ( void *  to, void const *  from, XsSize  count, XsSize  iSize  )

related

Copies items optimized in a direct way.

This function copies items directly, using memcpy. This works for simple types only.

Parameters

to	Pointer to array to copy to.
from	Pointer to array to copy from.
count	The number of items to copy.
iSize	The size of an individual item

Definition at line 707 of file xsarray.c.

XsArray_removeDuplicates()

void XsArray_removeDuplicates ( void *  thisPtr )

related

Removes duplicate entries from the array, keeping only the first instance of each value.

Definition at line 649 of file xsarray.c.

XsArray_removeDuplicatesPredicate()

void XsArray_removeDuplicatesPredicate ( void *  thisPtr, XsArrayItemCompareFunc  predicate  )

related

Removes duplicate entries from the array, keeping only the first instance of each value.

Parameters

predicate

A compare function that returns 0 if the values are equal. The arguments are (const void)

Definition at line 670 of file xsarray.c.

XsArray_reserve()

void XsArray_reserve ( void *  thisPtr, XsSize  count  )

related

Reserves space for count items.

This function reserves space for at least count items. The function will retain the current data in the list.

Parameters

count

The number of items to reserve space for. When set to 0 or 1, the buffer is resized to the minimum required size to contain the current contents. Otherwise reserving data will only expand the buffer, never shrink it.

See also

XsArray_assign

Definition at line 256 of file xsarray.c.

XsArray_resize()

void XsArray_resize ( void *  thisPtr, XsSize  count  )

related

Resizes the existing list to count items.

This function will keep the data of the remaining items intact.

Parameters

count

the number of items the list should have

See also

XsArray_reserve

XsArray_assign

Definition at line 227 of file xsarray.c.

XsArray_reverse()

void XsArray_reverse ( void *  thisPtr )

related

Reverses the contents of the array by repeatedly using the itemSwap func in the XsArrayDescriptor.

This reverses the contents in-place

Definition at line 726 of file xsarray.c.

XsArray_sort()

void XsArray_sort ( void *  thisPtr )

related

Sorts the array using the itemCompare func in the XsArrayDescriptor.

This function sorts using qsort

Definition at line 716 of file xsarray.c.

XsArray_swap()

void XsArray_swap ( void *  a, void *  b  )

related

Swap the contents of a with those of b.

Where possible, the pointers and administrative values are swapped. If for some reason thisArray is not possible, the lists are swapped one element at a time.

Parameters

a	The list to swap with b
b	The list to swap with a

Definition at line 408 of file xsarray.c.

XsBaud_codeToRate()

XsBaudRate XsBaud_codeToRate

(

XsBaudCode

baudcode

)

Convert an Xsens baud code to XsBaudRate.

\param baudcode : The code to convert to an XsBaudRate

\returns An XsBaudrate

Definition at line 83 of file xsbaud.c.

XsBaud_numericToRate()

XsBaudRate XsBaud_numericToRate

(

int

numeric

)

Convert a numeric baudrate in bps to XsBaudrate.

\param numeric : The numeric baudrate to convert to XsBaudRate

\returns A XsBaudrate

Definition at line 223 of file xsbaud.c.

XsBaud_rateToCode()

XsBaudCode XsBaud_rateToCode

(

XsBaudRate

baudrate

)

Convert a XsBaudRate to an Xsens baud code.

\param baudrate : The code to convert to an XsBaudCode

\returns An XsBaudCode

Definition at line 129 of file xsbaud.c.

XsBaud_rateToNumeric()

int XsBaud_rateToNumeric

(

XsBaudRate

baudrate

)

Convert a XsBaudrate to a numeric baudrate in bps.

\param baudrate : The XsBaudRate to convert to a numeric baudrate

\returns A baudrate in bps

Definition at line 176 of file xsbaud.c.

XsCalibratedData_construct()

void XsCalibratedData_construct ( XsCalibratedData *  thisPtr, const XsReal *  acc, const XsReal *  gyr, const XsReal *  mag  )

related

Construct an XsCalibratedData object.

Definition at line 79 of file xscalibrateddata.c.

XsCalibratedData_destruct()

void XsCalibratedData_destruct ( XsCalibratedData *  thisPtr )

related

Destruct an XsCalibratedData object.

Definition at line 89 of file xscalibrateddata.c.

XsConnectivityState_toString()

const char* XsConnectivityState_toString

(

XsConnectivityState

s

)

Convert the device state to a human readable string.

Definition at line 73 of file xsconnectivitystate.c.

XsDataFlags_toString()

const char* XsDataFlags_toString

(

XsDataFlags

f

)

Convert the XsDataFlags to a human readable string.

Parameters

f	The flags to translate

Returns

A pointer to a statically allocated memory buffer. Do not free this buffer.

Note

This function is NOT reentrant, multiple simultaneous calls may cause crashes. Also, later calls will invalidate the results of earlier calls.

Definition at line 78 of file xstypedefs.c.

XsDataPacket_accelerationHR()

XsVector* XsDataPacket_accelerationHR	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

Returns AccelerationHR.

Parameters

returnVal

: An XsVector to put the requested in

Returns

A XsVector containing the x, y and z axis values in that order

Definition at line 2572 of file xsdatapacket.cpp.

XsDataPacket_altitude()

double XsDataPacket_altitude

(

const XsDataPacket *

thisPtr

)

The position altitude component of a data item.

\returns The altitude stored in the packet or XsMath_infinity if no altitude is available
\sa XsDataPacket_containsAltitude
\sa XsDataPacket_positionLLA \sa XsDataPacket_latitudeLongitude

Definition at line 1535 of file xsdatapacket.cpp.

XsDataPacket_altitudeMsl()

double XsDataPacket_altitudeMsl

(

const XsDataPacket *

thisPtr

)

The position altitude above MSL component of a data item.

\returns The altitude stored in the packet or XsMath_infinity if no altitude is available
\sa XsDataPacket_containsAltitudeMsl

Definition at line 1563 of file xsdatapacket.cpp.

XsDataPacket_analogIn1Data()

XsAnalogInData* XsDataPacket_analogIn1Data	(	const XsDataPacket *	thisPtr,
		XsAnalogInData *	returnVal
	)

The analog in 1 component of a data item.

Parameters

returnVal

: The XsAnalogInData object that the analog in 1 value will be assigned to

Returns

An XsAnalogInData containing the analog in 1 value

Definition at line 1397 of file xsdatapacket.cpp.

XsDataPacket_analogIn2Data()

XsAnalogInData* XsDataPacket_analogIn2Data	(	const XsDataPacket *	thisPtr,
		XsAnalogInData *	returnVal
	)

The analog in 2 component of a data item.

Parameters

returnVal

: The XsAnalogInData object that the analog in 2 value will be assigned to

Returns

An XsAnalogInData containing the analog in 2 value

Definition at line 1423 of file xsdatapacket.cpp.

XsDataPacket_awindaSnapshot()

XsSnapshot* XsDataPacket_awindaSnapshot	(	const XsDataPacket *	thisPtr,
		XsSnapshot *	returnVal
	)

Returns the Awinda Snapshot part of the XsDataPacket.

Awinda Snapshot is an internal format used by Xsens devices for high accuracy data trasnfer. In most cases XDA processing will remove this item from the XsDataPacket and replace it with items that are more directly usable.

Parameters

returnVal

The object to store the requested data in. This must be a properly constructed object.

Returns

The supplied returnVal, filled with the requested data or cleared if it was not available

Definition at line 2359 of file xsdatapacket.cpp.

XsDataPacket_calibratedAcceleration()

XsVector* XsDataPacket_calibratedAcceleration	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

The calibrated accelerometer component of a data item.

\param returnVal : The XsVector that the calibrated acceleration will be assigned to

\returns A XsVector containing the x, y and z axis values in that order

Definition at line 792 of file xsdatapacket.cpp.

XsDataPacket_calibratedData()

XsCalibratedData* XsDataPacket_calibratedData	(	const XsDataPacket *	thisPtr,
		XsCalibratedData *	returnVal
	)

Return the calibrated Data component of a data item.

Parameters

returnVal

Storage for the requested data

Returns

Returns the supplied returnVal filled with the requested data

Definition at line 897 of file xsdatapacket.cpp.

XsDataPacket_calibratedGyroscopeData()

XsVector* XsDataPacket_calibratedGyroscopeData	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

The calibrated gyroscope component of a data item.

\param returnVal : An XsVector to put the requested data in

\returns A XsUShortVector containing the x, y and z axis values in that order

Definition at line 845 of file xsdatapacket.cpp.

XsDataPacket_calibratedMagneticField()

XsVector* XsDataPacket_calibratedMagneticField	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

The calibrated magnetometer component of a data item.

\param returnVal : An XsVector to put the requested in

\returns A XsUShortVector containing the x, y and z axis values in that order

Definition at line 872 of file xsdatapacket.cpp.

XsDataPacket_clear()

void XsDataPacket_clear	(	XsDataPacket *	thisPtr,
		XsDataIdentifier	id
	)

Clears all data in an XsDataPacket.

Parameters

id	The id to clear, supply XDI_None to clear the entire object

Definition at line 459 of file xsdatapacket.cpp.

XsDataPacket_construct()

void XsDataPacket_construct

(

XsDataPacket *

thisPtr

)

Inits a data packet, the packet will be empty after construction.

Definition at line 425 of file xsdatapacket.cpp.

XsDataPacket_containsAccelerationHR()

int XsDataPacket_containsAccelerationHR

(

const XsDataPacket *

thisPtr

)

Check if data item contains AccelerationHR.

Returns

true if this packet contains AccelerationHR

Definition at line 2580 of file xsdatapacket.cpp.

XsDataPacket_containsAltitude()

int XsDataPacket_containsAltitude

(

const XsDataPacket *

thisPtr

)

Check if data item contains position altitude data.

Returns

true if this packet contains position altitude data

See also

XsDataPacket_containsPositionLLA

XsDataPacket_containsLatitudeLongitude

Definition at line 1544 of file xsdatapacket.cpp.

XsDataPacket_containsAltitudeMsl()

int XsDataPacket_containsAltitudeMsl

(

const XsDataPacket *

thisPtr

)

Check if data item contains position altitude above MSL data.

\returns true if this packet contains position altitude data

Definition at line 1572 of file xsdatapacket.cpp.

XsDataPacket_containsAnalogIn1Data()

int XsDataPacket_containsAnalogIn1Data

(

const XsDataPacket *

thisPtr

)

Check if data item contains analog in 1 data.

Returns

true if this packet contains analog in 1 data

Definition at line 1405 of file xsdatapacket.cpp.

XsDataPacket_containsAnalogIn2Data()

int XsDataPacket_containsAnalogIn2Data

(

const XsDataPacket *

thisPtr

)

Check if data item contains analog in 2 data.

Returns

true if this packet contains analog in 2 data

Definition at line 1431 of file xsdatapacket.cpp.

XsDataPacket_containsAwindaSnapshot()

int XsDataPacket_containsAwindaSnapshot

(

const XsDataPacket *

thisPtr

)

Returns true if the XsDataPacket contains Awinda Snapshot data.

Returns

true if the XsDataPacket contains Awinda Snapshot data

Definition at line 2367 of file xsdatapacket.cpp.

XsDataPacket_containsCalibratedAcceleration()

int XsDataPacket_containsCalibratedAcceleration

(

const XsDataPacket *

thisPtr

)

Check if data item contains calibrated accelerometer data.

Returns

true if this packet contains calibrated accelerometer data

Definition at line 800 of file xsdatapacket.cpp.

XsDataPacket_containsCalibratedData()

int XsDataPacket_containsCalibratedData

(

const XsDataPacket *

thisPtr

)

Check if data item contains calibrated Data.

Returns

Returns whether the packet contains calibrated data or not

Note

Calibrated data is only present if all components are present.

Definition at line 912 of file xsdatapacket.cpp.

XsDataPacket_containsCalibratedGyroscopeData()

int XsDataPacket_containsCalibratedGyroscopeData

(

const XsDataPacket *

thisPtr

)

Check if data item contains calibrated gyroscope data.

Returns

true if this packet contains calibrated gyroscope data

Definition at line 853 of file xsdatapacket.cpp.

XsDataPacket_containsCalibratedMagneticField()

int XsDataPacket_containsCalibratedMagneticField

(

const XsDataPacket *

thisPtr

)

Check if data item contains calibrated magnetometer data.

Returns

true if this packet contains calibrated magnetometer data

Definition at line 880 of file xsdatapacket.cpp.

XsDataPacket_containsCorrectedMagneticField()

int XsDataPacket_containsCorrectedMagneticField

(

const XsDataPacket *

thisPtr

)

Check if data item contains corrected magnetometer data (ICC result).

Returns

true if this packet contains corrected magnetometer data

Definition at line 944 of file xsdatapacket.cpp.

XsDataPacket_containsDetailedStatus()

int XsDataPacket_containsDetailedStatus

(

const XsDataPacket *

thisPtr

)

Check if data item contains detailed status data.

Returns

true if this packet contains detailed status data

Definition at line 1735 of file xsdatapacket.cpp.

XsDataPacket_containsFrameRange()

int XsDataPacket_containsFrameRange

(

const XsDataPacket *

thisPtr

)

Returns whether the datapacket contains a framerange.

\returns Whether the datapacket contains a framerange

Definition at line 2054 of file xsdatapacket.cpp.

XsDataPacket_containsFreeAcceleration()

int XsDataPacket_containsFreeAcceleration

(

const XsDataPacket *

thisPtr

)

Check if data item contains free acceleration.

Free acceleration is the acceleration with the local gravity vector subtracted.

Returns

true if this packet contains free acceleration

Definition at line 2025 of file xsdatapacket.cpp.

XsDataPacket_containsFullSnapshot()

int XsDataPacket_containsFullSnapshot

(

const XsDataPacket *

thisPtr

)

Returns true if the XsDataPacket contains Full Snapshot data.

Returns

true if the XsDataPacket contains Full Snapshot data

Definition at line 2338 of file xsdatapacket.cpp.

XsDataPacket_containsGloveData()

int XsDataPacket_containsGloveData	(	const XsDataPacket *	thisPtr,
		XsHandId	hand
	)

Check if data item contains glove data.

Parameters

hand	Which hand to get data for, must be either XHI_LeftHand or XHI_RightHand for a particular side or XHI_Unknown for any side

Returns

Returns true if this packet contains sdi data

Definition at line 1280 of file xsdatapacket.cpp.

XsDataPacket_containsGloveSnapshot()

int XsDataPacket_containsGloveSnapshot	(	const XsDataPacket *	thisPtr,
		XsHandId	hand
	)

Returns true if the XsDataPacket contains Glove Snapshot data.

Parameters

hand	Which hand to get data for, must be either XHI_LeftHand or XHI_RightHand for a particular side or XHI_Unknown for any side

Returns

true if the XsDataPacket contains Glove Snapshot data

Definition at line 2421 of file xsdatapacket.cpp.

XsDataPacket_containsGnssAge()

int XsDataPacket_containsGnssAge

(

const XsDataPacket *

thisPtr

)

Returns 1 if data item contains GnssAge, 0 otherwise.

Returns

true if this XsDataPacket containts GNSS age data

Definition at line 2157 of file xsdatapacket.cpp.

XsDataPacket_containsGnssPvtPulse()

int XsDataPacket_containsGnssPvtPulse

(

const XsDataPacket *

thisPtr

)

Check if data item XsDataPacket_contains a pvt pulse.

Returns

true if this packet XsDataPacket_contains a spvt pulse

Definition at line 2133 of file xsdatapacket.cpp.

XsDataPacket_containsLatitudeLongitude()

int XsDataPacket_containsLatitudeLongitude

(

const XsDataPacket *

thisPtr

)

Check if data item contains position latitude longitude data.

Returns

true if this packet contains position latitude longitude data

See also

XsDataPacket_containsPositionLLA

XsDataPacket_containsAltitude

Definition at line 1514 of file xsdatapacket.cpp.

XsDataPacket_containsOrientation()

int XsDataPacket_containsOrientation

(

const XsDataPacket *

thisPtr

)

Check if data item contains orientation Data of any kind.

Returns

true if this packet contains orientation data

Definition at line 1137 of file xsdatapacket.cpp.

XsDataPacket_containsOrientationIncrement()

int XsDataPacket_containsOrientationIncrement

(

const XsDataPacket *

thisPtr

)

Check if data item contains delta quaternion data.

Returns

true if this packet contains delta quaternion data

Definition at line 826 of file xsdatapacket.cpp.

XsDataPacket_containsPacketCounter()

int XsDataPacket_containsPacketCounter

(

const XsDataPacket *

thisPtr

)

Check if data item contains a packet counter.

Returns

true if this packet contains a packet counter

Definition at line 1860 of file xsdatapacket.cpp.

XsDataPacket_containsPacketCounter8()

int XsDataPacket_containsPacketCounter8

(

const XsDataPacket *

thisPtr

)

Check if data item contains an 8 bit packet counter.

Returns

true if this packet contains an 8 bit packet counter

Definition at line 1822 of file xsdatapacket.cpp.

XsDataPacket_containsPositionLLA()

int XsDataPacket_containsPositionLLA

(

const XsDataPacket *

thisPtr

)

Check if data item contains position lat lon alt data.

Returns

true if this packet contains position lat lon alt data

Definition at line 1477 of file xsdatapacket.cpp.

XsDataPacket_containsPressure()

int XsDataPacket_containsPressure

(

const XsDataPacket *

thisPtr

)

Check if data item contains pressure data.

Returns

true if this packet contains pressure data

Definition at line 1175 of file xsdatapacket.cpp.

XsDataPacket_containsPressureAge()

int XsDataPacket_containsPressureAge

(

const XsDataPacket *

thisPtr

)

Check if data item contains pressure age data.

Returns

true if this packet contains pressure age data

Definition at line 1183 of file xsdatapacket.cpp.

XsDataPacket_containsRateOfTurnHR()

int XsDataPacket_containsRateOfTurnHR

(

const XsDataPacket *

thisPtr

)

Check if data item contains RateOfTurnHR.

Returns

true if this packet contains RateOfTurnHR

Definition at line 2605 of file xsdatapacket.cpp.

XsDataPacket_containsRawAcceleration()

int XsDataPacket_containsRawAcceleration

(

const XsDataPacket *

thisPtr

)

Check if data item contains Raw Accelerometer data.

Returns

true if this packet contains raw acceleration data

Definition at line 562 of file xsdatapacket.cpp.

XsDataPacket_containsRawBlob()

int XsDataPacket_containsRawBlob

(

const XsDataPacket *

thisPtr

)

Returns true if the XsDataPacket contains raw blob data.

Returns

true if the XsDataPacket contains raw blob data

Definition at line 2555 of file xsdatapacket.cpp.

XsDataPacket_containsRawData()

int XsDataPacket_containsRawData

(

const XsDataPacket *

thisPtr

)

Check if data item contains raw data.

Returns

true if this packet contains raw data

Definition at line 739 of file xsdatapacket.cpp.

XsDataPacket_containsRawGnssPvtData()

int XsDataPacket_containsRawGnssPvtData

(

const XsDataPacket *

thisPtr

)

Returns 1 if data item contains RawGnssPvtData, 0 otherwise.

Returns

true if this XsDataPacket contains Raw GNSS data

Definition at line 2108 of file xsdatapacket.cpp.

XsDataPacket_containsRawGnssSatInfo()

int XsDataPacket_containsRawGnssSatInfo

(

const XsDataPacket *

thisPtr

)

Returns 1 if data item contains RawGnssPvtData, 0 otherwise.

Returns

true if this XsDataPacket containts raw GNSS Sat Info

Definition at line 2182 of file xsdatapacket.cpp.

XsDataPacket_containsRawGyroscopeData()

int XsDataPacket_containsRawGyroscopeData

(

const XsDataPacket *

thisPtr

)

Check if data item contains raw gyroscope data.

Returns

true if this packet contains raw gyroscope data

Definition at line 594 of file xsdatapacket.cpp.

XsDataPacket_containsRawGyroscopeTemperatureData()

int XsDataPacket_containsRawGyroscopeTemperatureData

(

const XsDataPacket *

thisPtr

)

Check if data item contains raw gyroscope temperature data.

Returns

true if this packet contains raw gyroscope temperature data

Definition at line 691 of file xsdatapacket.cpp.

XsDataPacket_containsRawMagneticField()

int XsDataPacket_containsRawMagneticField

(

const XsDataPacket *

thisPtr

)

Check if data item contains raw magnetometer data.

Returns

true if this packet contains raw magnetometer data

Definition at line 621 of file xsdatapacket.cpp.

XsDataPacket_containsRawTemperature()

int XsDataPacket_containsRawTemperature

(

const XsDataPacket *

thisPtr

)

Check if data item contains raw temperature data.

Returns

true if this packet contains raw temperature data

Definition at line 651 of file xsdatapacket.cpp.

XsDataPacket_containsRssi()

int XsDataPacket_containsRssi

(

const XsDataPacket *

thisPtr

)

Returns whether the datapacket contains an rssi value.

\returns Whether the datapacket contains an rssi value

Definition at line 2082 of file xsdatapacket.cpp.

XsDataPacket_containsSampleTime64()

int XsDataPacket_containsSampleTime64

(

const XsDataPacket *

thisPtr

)

Check if data item XsDataPacket contains a full 64-bit sample time.

Returns

true if this packet XsDataPacket contains both a fine and coarse sample time

Definition at line 1969 of file xsdatapacket.cpp.

XsDataPacket_containsSampleTimeCoarse()

int XsDataPacket_containsSampleTimeCoarse

(

const XsDataPacket *

thisPtr

)

Check if data item XsDataPacket_contains a sample time coarse.

Returns

true if this packet XsDataPacket_contains a sample time coarse

Definition at line 1916 of file xsdatapacket.cpp.

XsDataPacket_containsSampleTimeFine()

int XsDataPacket_containsSampleTimeFine

(

const XsDataPacket *

thisPtr

)

Check if data item XsDataPacket_contains a sample time fine.

Returns

true if this packet XsDataPacket_contains a sample time fine

Definition at line 1887 of file xsdatapacket.cpp.

XsDataPacket_containsSdiData()

int XsDataPacket_containsSdiData

(

const XsDataPacket *

thisPtr

)

Check if data item contains strapdown integration data.

Returns

Returns true if this packet contains sdi data

Definition at line 1241 of file xsdatapacket.cpp.

XsDataPacket_containsStatus()

int XsDataPacket_containsStatus

(

const XsDataPacket *

thisPtr

)

Check if data item contains legacy status data.

Returns

true if this packet contains legacy status data

Definition at line 1743 of file xsdatapacket.cpp.

XsDataPacket_containsStoredDeviceId()

int XsDataPacket_containsStoredDeviceId

(

const XsDataPacket *

thisPtr

)

Return non-zero if this data packet stores a device ID.

Returns

non-zero (true) if a device ID is available, zero (false) otherwise

Definition at line 1329 of file xsdatapacket.cpp.

XsDataPacket_containsStoredLocationId()

int XsDataPacket_containsStoredLocationId

(

const XsDataPacket *

thisPtr

)

Return non-zero if this data packet stores a location ID.

Returns

non-zero (true) if a location ID is available, zero (false) otherwise

Definition at line 1354 of file xsdatapacket.cpp.

XsDataPacket_containsTemperature()

int XsDataPacket_containsTemperature

(

const XsDataPacket *

thisPtr

)

Check if data item contains temperature data.

Returns

true if this packet contains temperature data

Definition at line 1378 of file xsdatapacket.cpp.

XsDataPacket_containsTriggerIndication()

int XsDataPacket_containsTriggerIndication	(	const XsDataPacket *	thisPtr,
		XsDataIdentifier	triggerId
	)

Check if data item contains trigger indication data.

Parameters

[in]

triggerId

The trigger data identifier to check (e.g. XDI_TriggerIn1 or XDI_TriggerIn2)

Returns

true if this packet contains trigger indication data

Definition at line 1794 of file xsdatapacket.cpp.

XsDataPacket_containsUtcTime()

int XsDataPacket_containsUtcTime

(

const XsDataPacket *

thisPtr

)

Check if data item contains utc time data.

Returns

true if this packet contains utc time data

Definition at line 1997 of file xsdatapacket.cpp.

XsDataPacket_containsVelocity()

int XsDataPacket_containsVelocity

(

const XsDataPacket *

thisPtr

)

Check if data item contains velocity NED data.

Returns

true if this packet contains velocity NED data

Definition at line 1677 of file xsdatapacket.cpp.

XsDataPacket_containsVelocityIncrement()

int XsDataPacket_containsVelocityIncrement

(

const XsDataPacket *

thisPtr

)

Check if data item contains delta velocity data.

Returns

true if this packet contains delta velocity data

Definition at line 773 of file xsdatapacket.cpp.

XsDataPacket_coordinateSystemOrientation()

XsDataIdentifier XsDataPacket_coordinateSystemOrientation

(

const XsDataPacket *

thisPtr

)

Returns the coordinate system of the first orientation data of any kind in the packet.

Returns

The XsDataIdentifier of the coordinate system of the first orientation data of any kind in the packet

Definition at line 1167 of file xsdatapacket.cpp.

XsDataPacket_coordinateSystemVelocity()

XsDataIdentifier XsDataPacket_coordinateSystemVelocity

(

const XsDataPacket *

thisPtr

)

Returns the coordinate system of the first velocity data of any kind in the packet.

Returns

The XsDataIdentifier of the coordinate system of the first velocity data of any kind in the packet

Definition at line 1710 of file xsdatapacket.cpp.

XsDataPacket_copy()

void XsDataPacket_copy	(	XsDataPacket *	copy,
		XsDataPacket const *	src
	)

Copy the XsDataPacket to copy.

Parameters

copy	The object to copy to
src	The source to copy from

Definition at line 475 of file xsdatapacket.cpp.

XsDataPacket_copyConstruct()

void XsDataPacket_copyConstruct	(	XsDataPacket *	thisPtr,
		XsDataPacket const *	src
	)

Initializes a data packet as a (referenced) copy of src.

Parameters

src	The data packet to reference-copy from

Definition at line 437 of file xsdatapacket.cpp.

XsDataPacket_correctedMagneticField()

XsVector* XsDataPacket_correctedMagneticField	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

The corrected magnetometer component of a data item (ICC result).

Parameters

returnVal

: An XsVector to put the requested in

Returns

A XsUShortVector containing the x, y and z axis values in that order

Definition at line 936 of file xsdatapacket.cpp.

XsDataPacket_dataFormat()

XsDataIdentifier XsDataPacket_dataFormat	(	const XsDataPacket *	thisPtr,
		XsDataIdentifier	id
	)

Returns the dataformat of a specific data identifier in the packet.

Parameters

id	: The XsDataIdentifier to query

Returns

Returns XDI_None if the packet does not contain the dataidentifier, the data format otherwise

See also

XsDataIdentifier

Definition at line 528 of file xsdatapacket.cpp.

XsDataPacket_destruct()

void XsDataPacket_destruct

(

XsDataPacket *

thisPtr

)

Clears and frees data in an XsDataPacket.

Definition at line 449 of file xsdatapacket.cpp.

XsDataPacket_empty()

int XsDataPacket_empty

(

const XsDataPacket *

thisPtr

)

Returns whether the datapacket is empty.

Returns

True when the XsDataPacket is empty

Definition at line 506 of file xsdatapacket.cpp.

XsDataPacket_frameRange()

XsRange* XsDataPacket_frameRange	(	const XsDataPacket *	thisPtr,
		XsRange *	returnVal
	)

Returns the frame range contained in the datapacket.

\param returnVal : The XsRange object that will get the range from the packet

\returns Returns an XsRange object with the range from the packet

Definition at line 2045 of file xsdatapacket.cpp.

XsDataPacket_freeAcceleration()

XsVector* XsDataPacket_freeAcceleration	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

The free acceleration component of a data item.

Free acceleration is the acceleration with the local gravity vector subtracted.

Parameters

returnVal

: An XsVector to put the requested in

Returns

An XsVector containing the gravity acceleration

Definition at line 2016 of file xsdatapacket.cpp.

XsDataPacket_fullSnapshot()

XsSnapshot* XsDataPacket_fullSnapshot	(	const XsDataPacket *	thisPtr,
		XsSnapshot *	returnVal
	)

Returns the Full Snapshot part of the XsDataPacket.

Full Snapshot is an internal format used by Xsens devices for high accuracy data transfer. In most cases XDA processing will remove this item from the XsDataPacket and replace it with items that are more directly usable.

Parameters

returnVal

The object to store the requested data in. This must be a properly constructed object.

Returns

The supplied returnVal, filled with the requested data or cleared if it was not available

Definition at line 2327 of file xsdatapacket.cpp.

XsDataPacket_gloveData()

XsGloveData* XsDataPacket_gloveData	(	const XsDataPacket *	thisPtr,
		XsGloveData *	returnVal,
		XsHandId	hand
	)

Return the glove data component of a data item.

Parameters

returnVal	Storage for the requested data
hand	Which hand to get data for, must be either XHI_LeftHand or XHI_RightHand

Returns

Returns the supplied returnVal filled with the requested data

Definition at line 1261 of file xsdatapacket.cpp.

XsDataPacket_gloveSnapshot()

XsGloveSnapshot* XsDataPacket_gloveSnapshot	(	const XsDataPacket *	thisPtr,
		XsGloveSnapshot *	returnVal,
		XsHandId	hand
	)

Returns the Glove Snapshot part of the XsDataPacket.

Glove Snapshot is an internal format used by Xsens devices for high accuracy data transfer. In most cases XDA processing will remove this item from the XsDataPacket and replace it with items that are more directly usable.

Parameters

returnVal	The object to store the requested data in. This must be a properly constructed object.
hand	Which hand to get data for, must be either XHI_LeftHand or XHI_RightHand

Returns

The supplied returnVal, filled with the requested data or cleared if it was not available

Definition at line 2402 of file xsdatapacket.cpp.

XsDataPacket_gnssAge()

uint8_t XsDataPacket_gnssAge

(

const XsDataPacket *

thisPtr

)

Returns the age of the GNSS data (in samples)

Returns

the age of the GNSS data

Definition at line 2149 of file xsdatapacket.cpp.

XsDataPacket_gnssPvtPulse()

uint32_t XsDataPacket_gnssPvtPulse

(

const XsDataPacket *

thisPtr

)

Returns the timestamp of a PVT Pulse.

\returns Returns the timestamp of a PVT Pulse

Definition at line 2125 of file xsdatapacket.cpp.

XsDataPacket_isAwindaSnapshotARetransmission()

int XsDataPacket_isAwindaSnapshotARetransmission

(

const XsDataPacket *

thisPtr

)

Returns true if the contained Awinda Snapshot is marked as a retransmission.

Returns

true if the XsDataPacket contains Awinda Snapshot data and it is marked as a retransmission

Definition at line 2384 of file xsdatapacket.cpp.

XsDataPacket_itemCount()

int XsDataPacket_itemCount

(

const XsDataPacket *

thisPtr

)

Returns the number of individual items in the XsDataPacket.

Returns

The number of individual items in the XsDataPacket

Definition at line 514 of file xsdatapacket.cpp.

XsDataPacket_latitudeLongitude()

XsVector* XsDataPacket_latitudeLongitude	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

The position latitude longitude component of a data item.

\param returnVal : The XsVector to return the requested data in

\returns An XsVector containing the latitude and longitude values in that order
\sa XsDataPacket_containsLatitudeLongitude
\sa XsDataPacket_positionLLA \sa XsDataPacket_altitude

Definition at line 1505 of file xsdatapacket.cpp.

XsDataPacket_merge()

XsDataPacket* XsDataPacket_merge	(	XsDataPacket *	thisPtr,
		const XsDataPacket *	other,
		int	overwrite
	)

Merge the data items from other into the packet.

\details The data items contained in XsDataPacket \a other will be added to
            this packet. Items that are already present will be
            overwritten depending on the value of \a overwrite.

\param other The XsDataPacket to read the data items from
\param overwrite When set to true, existing items will be overwritten, otherwise they will not be modified

\returns Returns the updated data packet

Definition at line 2206 of file xsdatapacket.cpp.

XsDataPacket_orientationEuler()

XsEuler* XsDataPacket_orientationEuler	(	const XsDataPacket *	thisPtr,
		XsEuler *	returnVal,
		XsDataIdentifier	coordinateSystem
	)

Return the orientation component of a data item as a euler angles.

\param returnVal An %XsEuler to put the requested orientation in
\param coordinateSystem The coordinate system of the requested orientation. If this does not match
the stored coordinate system, it will be transformed to the requested orientation.

\returns A %XsEuler containing the orientation data

Definition at line 1026 of file xsdatapacket.cpp.

XsDataPacket_orientationIdentifier()

XsDataIdentifier XsDataPacket_orientationIdentifier

(

const XsDataPacket *

thisPtr

)

Returns the data identifier of the first orientation data of any kind in the packet.

Returns

The XsDataIdentifier of the first orientation data of any kind in the packet

Definition at line 1147 of file xsdatapacket.cpp.

XsDataPacket_orientationIncrement()

XsQuaternion* XsDataPacket_orientationIncrement	(	const XsDataPacket *	thisPtr,
		XsQuaternion *	returnVal
	)

The delta quaternion (deltaQ) component of a data item.

Parameters

returnVal

: The XsQuaternion that the deltaQ will be assigned to

Returns

An XsQuaternion containing the deltaQ value

Definition at line 818 of file xsdatapacket.cpp.

XsDataPacket_orientationMatrix()

XsMatrix* XsDataPacket_orientationMatrix	(	const XsDataPacket *	thisPtr,
		XsMatrix *	returnVal,
		XsDataIdentifier	coordinateSystem
	)

Return the orientation component of a data item as a orientation matrix.

\param returnVal An %XsMatrix to put the requested orientation in
\param coordinateSystem The coordinate system of the requested orientation. If this does not match
the stored coordinate system, it will be transformed to the requested orientation.

\returns An %XsMatrix containing the orientation data

Definition at line 1086 of file xsdatapacket.cpp.

XsDataPacket_orientationQuaternion()

XsQuaternion* XsDataPacket_orientationQuaternion	(	const XsDataPacket *	thisPtr,
		XsQuaternion *	returnVal,
		XsDataIdentifier	coordinateSystem
	)

Return the orientation component of a data item as a quaternion.

\param returnVal An %XsQuaternion to put the requested orientation in
\param coordinateSystem The coordinate system of the requested orientation. If this does not match
the stored coordinate system, it will be transformed to the requested orientation.

\returns An XsQuaternion containing the orientation data

Definition at line 965 of file xsdatapacket.cpp.

XsDataPacket_packetCounter()

uint16_t XsDataPacket_packetCounter

(

const XsDataPacket *

thisPtr

)

Return the packet/frame counter of a packet.

\details For strapdown integration data, this function will return the m_wlastFrameNumber
For other data, this function will return the m_sc

This way there is a function that will always return the counter of a packet

\returns Returns the packet/frame counter of a packet

Definition at line 1844 of file xsdatapacket.cpp.

XsDataPacket_packetCounter8()

uint8_t XsDataPacket_packetCounter8

(

const XsDataPacket *

thisPtr

)

Return the 8 bit packet counter of a packet.

\details This function returns an 8 bit packet counter as used by some third party devices

\returns Returns the 8 bit packet counter of a packet

Definition at line 1814 of file xsdatapacket.cpp.

XsDataPacket_positionLLA()

XsVector* XsDataPacket_positionLLA	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

The position lat lon alt component of a data item.

\param returnVal : The XsVector to return the requested data in

\returns An XsVector containing the latitude, longitude and altitude values in that order

Definition at line 1451 of file xsdatapacket.cpp.

XsDataPacket_pressure()

XsPressure* XsDataPacket_pressure	(	const XsDataPacket *	thisPtr,
		XsPressure *	returnVal
	)

The air pressure component of a data item.

\param returnVal : An XsPressure object to put the requested in

\returns An XsPressure object containing the pressure and if available the pressure age

Definition at line 1194 of file xsdatapacket.cpp.

XsDataPacket_privateCount()

int XsDataPacket_privateCount

(

)

Returns the number of private data items for all XsDataPacket combined currently in memory.

This is an internal value and should not be used for any other purpose.

Returns

The current number of items.

Definition at line 2622 of file xsdatapacket.cpp.

XsDataPacket_rateOfTurnHR()

XsVector* XsDataPacket_rateOfTurnHR	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

Returns RateOfTurnHR.

Parameters

returnVal

: An XsVector to put the requested in

Returns

A XsVector containing the x, y and z axis values in that order

Definition at line 2597 of file xsdatapacket.cpp.

XsDataPacket_rawAcceleration()

XsUShortVector* XsDataPacket_rawAcceleration	(	const XsDataPacket *	thisPtr,
		XsUShortVector *	returnVal
	)

The raw accelerometer component of a data item.

Parameters

returnVal

: An XsUShortVector to put the requested data in

Returns

A XsUShortVector containing the x, y and z axis values in that order

Definition at line 554 of file xsdatapacket.cpp.

XsDataPacket_rawAccelerationConverted()

XsVector* XsDataPacket_rawAccelerationConverted	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

The raw accelerometer component of a data item, converted to floating point values.

Parameters

returnVal

: An XsVector to put the requested data in

Returns

A XsVector containing the x, y and z axis values in that order

Definition at line 2499 of file xsdatapacket.cpp.

XsDataPacket_rawBlob()

XsByteArray* XsDataPacket_rawBlob	(	const XsDataPacket *	thisPtr,
		XsByteArray *	returnVal
	)

Returns the raw blob part of the XsDataPacket.

Parameters

returnVal

The object to store the requested data in. This must be a properly constructed object.

Returns

The supplied returnVal, filled with the requested data or cleared if it was not available

Definition at line 2547 of file xsdatapacket.cpp.

XsDataPacket_rawData()

XsScrData* XsDataPacket_rawData	(	const XsDataPacket *	thisPtr,
		XsScrData *	returnVal
	)

Return the raw data component of a data item.

Parameters

returnVal

The object to store the requested data in

Returns

The raw data component of a data item.

Definition at line 717 of file xsdatapacket.cpp.

XsDataPacket_rawGnssPvtData()

XsRawGnssPvtData* XsDataPacket_rawGnssPvtData	(	const XsDataPacket *	thisPtr,
		XsRawGnssPvtData *	returnVal
	)

Returns a struct with RawGnssPvtData.

Parameters

returnVal

The object to store the requested data in

Returns

a struct with RawGnssPvtData

Definition at line 2100 of file xsdatapacket.cpp.

XsDataPacket_rawGnssSatInfo()

XsRawGnssSatInfo* XsDataPacket_rawGnssSatInfo	(	const XsDataPacket *	thisPtr,
		XsRawGnssSatInfo *	returnVal
	)

Returns a struct with RawGnssSatInfo.

Parameters

returnVal

The object to store the requested data in

Returns

a struct with RawGnssSatInfo

Definition at line 2174 of file xsdatapacket.cpp.

XsDataPacket_rawGyroscopeData()

XsUShortVector* XsDataPacket_rawGyroscopeData	(	const XsDataPacket *	thisPtr,
		XsUShortVector *	returnVal
	)

The raw gyroscope component of a data item.

\param returnVal : An XsUShortVector to put the requested data in

\returns A XsUShortVector containing the x, y and z axis values in that order

Definition at line 586 of file xsdatapacket.cpp.

XsDataPacket_rawGyroscopeDataConverted()

XsVector* XsDataPacket_rawGyroscopeDataConverted	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

The raw gyroscope component of a data item, converted to floating point values.

Parameters

returnVal

: An XsVector to put the requested data in

Returns

A XsVector containing the x, y and z axis values in that order

Definition at line 2510 of file xsdatapacket.cpp.

XsDataPacket_rawGyroscopeTemperatureData()

XsUShortVector* XsDataPacket_rawGyroscopeTemperatureData	(	const XsDataPacket *	thisPtr,
		XsUShortVector *	returnVal
	)

The raw gyroscope temperature component of a data item.

\param returnVal : An XsUShortVector to put the requested data in

\returns A XsUShortVector containing the x, y and z axis values in that order

Definition at line 679 of file xsdatapacket.cpp.

XsDataPacket_rawGyroscopeTemperatureDataConverted()

XsVector* XsDataPacket_rawGyroscopeTemperatureDataConverted	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

The raw gyroscope temperature component of a data item, converted to floating point values.

Parameters

returnVal

: An XsVector to put the requested data in

Returns

A XsVector containing the x, y and z axis values in that order

Definition at line 2532 of file xsdatapacket.cpp.

XsDataPacket_rawMagneticField()

XsUShortVector* XsDataPacket_rawMagneticField	(	const XsDataPacket *	thisPtr,
		XsUShortVector *	returnVal
	)

The raw magnetometer component of a data item.

\param returnVal : An XsUShortVector to put the requested data in

\returns A XsUShortVector containing the x, y and z axis values in that order

Definition at line 613 of file xsdatapacket.cpp.

XsDataPacket_rawMagneticFieldConverted()

XsVector* XsDataPacket_rawMagneticFieldConverted	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

The raw magnetometer component of a data item, converted to floating point values.

Parameters

returnVal

: An XsVector to put the requested data in

Returns

A XsVector containing the x, y and z axis values in that order

Definition at line 2521 of file xsdatapacket.cpp.

XsDataPacket_rawTemperature()

uint16_t XsDataPacket_rawTemperature

(

const XsDataPacket *

thisPtr

)

The raw temperature component of a data item.

\returns An uint16_t containing the raw temperature value

Definition at line 639 of file xsdatapacket.cpp.

XsDataPacket_rssi()

int XsDataPacket_rssi

(

const XsDataPacket *

thisPtr

)

Returns the rssi value contained in the datapacket.

\returns Returns the rssi value contained in the datapacket

Definition at line 2073 of file xsdatapacket.cpp.

XsDataPacket_sampleTime64()

uint64_t XsDataPacket_sampleTime64

(

const XsDataPacket *

thisPtr

)

Return the full 64-bit sample time of a packet, combined from the fine and coarse sample times or received directly from the device. The 64-bit sample time runs at 10kHz.

Returns

the full 64-bit sample time of a packet

Definition at line 1938 of file xsdatapacket.cpp.

XsDataPacket_sampleTimeCoarse()

uint32_t XsDataPacket_sampleTimeCoarse

(

const XsDataPacket *

thisPtr

)

Returns

Return the coarse sample time of a packet

Definition at line 1908 of file xsdatapacket.cpp.

XsDataPacket_sampleTimeFine()

uint32_t XsDataPacket_sampleTimeFine

(

const XsDataPacket *

thisPtr

)

Return the fine sample time of a packet.

\returns Returns the fine sample time of a packet

Definition at line 1879 of file xsdatapacket.cpp.

XsDataPacket_sdiData()

XsSdiData* XsDataPacket_sdiData	(	const XsDataPacket *	thisPtr,
		XsSdiData *	returnVal
	)

Return the strapdown integration data component of a data item.

Parameters

returnVal

Storage for the requested data

Returns

Returns the supplied returnVal filled with the requested data

Definition at line 1224 of file xsdatapacket.cpp.

XsDataPacket_setAccelerationHR()

void XsDataPacket_setAccelerationHR	(	XsDataPacket *	thisPtr,
		const XsVector *	vec
	)

Add/update the AccelerationHR for the item.

Parameters

vec	A 3-component vector containing AccelerationHR

Definition at line 2588 of file xsdatapacket.cpp.

XsDataPacket_setAltitude()

void XsDataPacket_setAltitude	(	XsDataPacket *	thisPtr,
		double	data
	)

Add/update altitude data for the item.

Parameters

data	: The altitude data to store in the packet

See also

XsDataPacket_setPositionLLA

XsDataPacket_setLatitudeLongitude

Definition at line 1553 of file xsdatapacket.cpp.

XsDataPacket_setAltitudeMsl()

void XsDataPacket_setAltitudeMsl	(	XsDataPacket *	thisPtr,
		double	data
	)

Add/update altitude above MSL data for the item.

\param data : The altitude data to store in the packet

Definition at line 1581 of file xsdatapacket.cpp.

XsDataPacket_setAnalogIn1Data()

void XsDataPacket_setAnalogIn1Data	(	XsDataPacket *	thisPtr,
		const XsAnalogInData *	data
	)

Add/update analog in 1 data for the item.

Parameters

data	The data is added to the datapacket. If the packet already contains analogin1 data, it is replaced with the new value

Definition at line 1414 of file xsdatapacket.cpp.

XsDataPacket_setAnalogIn2Data()

void XsDataPacket_setAnalogIn2Data	(	XsDataPacket *	thisPtr,
		const XsAnalogInData *	data
	)

Add/update analog in 2 data for the item.

Parameters

data	The data is added to the datapacket. If the packet already contains analogin1 data, it is replaced with the new value

Definition at line 1440 of file xsdatapacket.cpp.

XsDataPacket_setAwindaSnapshot()

void XsDataPacket_setAwindaSnapshot	(	XsDataPacket *	thisPtr,
		XsSnapshot const *	data,
		int	retransmission
	)

Sets the Awinda Snapshot part of the XsDataPacket.

Parameters

data	The new data to set
retransmission	When non-zero, the item is marked as a retransmitted packet

Definition at line 2376 of file xsdatapacket.cpp.

XsDataPacket_setCalibratedAcceleration()

void XsDataPacket_setCalibratedAcceleration	(	XsDataPacket *	thisPtr,
		const XsVector *	vec
	)

Add/update calibrated accelerometer data for the item.

Parameters

vec	: The data to update the XsDataPacket with

Definition at line 808 of file xsdatapacket.cpp.

XsDataPacket_setCalibratedData()

void XsDataPacket_setCalibratedData	(	XsDataPacket *	thisPtr,
		const XsCalibratedData *	data
	)

Add/update calibrated Data for the item.

Parameters

data	: The data to update the XsDataPacket with

Definition at line 923 of file xsdatapacket.cpp.

XsDataPacket_setCalibratedGyroscopeData()

void XsDataPacket_setCalibratedGyroscopeData	(	XsDataPacket *	thisPtr,
		const XsVector *	vec
	)

Add/update calibrated gyroscope data for the item.

Parameters

vec	: The data to update the XsDataPacket with

Definition at line 861 of file xsdatapacket.cpp.

XsDataPacket_setCalibratedMagneticField()

void XsDataPacket_setCalibratedMagneticField	(	XsDataPacket *	thisPtr,
		const XsVector *	vec
	)

Add/update calibrated magnetometer data for the item.

Parameters

vec	: The data to update the XsDataPacket with

Definition at line 888 of file xsdatapacket.cpp.

XsDataPacket_setCorrectedMagneticField()

void XsDataPacket_setCorrectedMagneticField	(	XsDataPacket *	thisPtr,
		const XsVector *	vec
	)

Add/update corrected magnetometer data for the item (ICC result).

Parameters

vec	: The data to update the XsDataPacket with

Definition at line 952 of file xsdatapacket.cpp.

XsDataPacket_setFrameRange()

void XsDataPacket_setFrameRange	(	XsDataPacket *	thisPtr,
		const XsRange *	r
	)

Sets or updates the frame range in the datapacket.

\param r : The XsRange object that should be added to the packet

Definition at line 2063 of file xsdatapacket.cpp.

XsDataPacket_setFreeAcceleration()

void XsDataPacket_setFreeAcceleration	(	XsDataPacket *	thisPtr,
		const XsVector *	g
	)

Add/update free acceleration data for the item.

Free acceleration is the acceleration with the local gravity vector subtracted.

Parameters

g	A 3-component vector containing the new free acceleration

Definition at line 2034 of file xsdatapacket.cpp.

XsDataPacket_setFullSnapshot()

void XsDataPacket_setFullSnapshot	(	XsDataPacket *	thisPtr,
		XsSnapshot const *	data,
		int	retransmission
	)

Sets the Awinda Snapshot part of the XsDataPacket.

Parameters

data	The new data to set
retransmission	When non-zero, the item is marked as a retransmitted packet

Definition at line 2347 of file xsdatapacket.cpp.

XsDataPacket_setGloveData()

void XsDataPacket_setGloveData	(	XsDataPacket *	thisPtr,
		const XsGloveData *	data,
		XsHandId	hand
	)

Add/update strapdown integration data for the item.

Parameters

data	The updated data
hand	Which hand to get data for, must be either XHI_LeftHand or XHI_RightHand

Definition at line 1299 of file xsdatapacket.cpp.

XsDataPacket_setGloveSnapshot()

void XsDataPacket_setGloveSnapshot	(	XsDataPacket *	thisPtr,
		XsGloveSnapshot const *	data,
		int	retransmission,
		XsHandId	hand
	)

Sets the Glove Snapshot part of the XsDataPacket.

Parameters

data	The new data to set
retransmission	When non-zero, the item is marked as a retransmitted packet
hand	Which hand to get data for, must be either XHI_LeftHand or XHI_RightHand

Definition at line 2441 of file xsdatapacket.cpp.

XsDataPacket_setGnssAge()

void XsDataPacket_setGnssAge	(	XsDataPacket *	thisPtr,
		uint8_t	age
	)

Sets or updates the GnssAge value in the datapacket.

Parameters

age	The new value that should be added to the packet

Definition at line 2165 of file xsdatapacket.cpp.

XsDataPacket_setGnssPvtPulse()

void XsDataPacket_setGnssPvtPulse	(	XsDataPacket *	thisPtr,
		uint32_t	counter
	)

Add/update pvt pulse timestamp data for the item.

Parameters

counter

The new data to set

Definition at line 2141 of file xsdatapacket.cpp.

XsDataPacket_setLatitudeLongitude()

void XsDataPacket_setLatitudeLongitude	(	XsDataPacket *	thisPtr,
		const XsVector *	data
	)

Add/update position latitude longitude data for the item.

\param data : The XsVector that contains the latitude longitude data to store in the packet
\sa XsDataPacket_setPositionLLA \sa XsDataPacket_setAltitude

Definition at line 1524 of file xsdatapacket.cpp.

XsDataPacket_setMessage()

void XsDataPacket_setMessage	(	XsDataPacket *	thisPtr,
		const XsMessage *	msg
	)

Overwrite the contents of the XsDataPacket with the contents of the supplied XsMessage.

Parameters

msg	The XsMessage to read from

Note

The packet is cleared before inserting new items

Definition at line 2248 of file xsdatapacket.cpp.

XsDataPacket_setOrientationEuler()

void XsDataPacket_setOrientationEuler	(	XsDataPacket *	thisPtr,
		const XsEuler *	data,
		XsDataIdentifier	coordinateSystem
	)

Add/update quaternion orientation Data for the item.

Parameters

data	The new data to set
coordinateSystem	The coordinate system of the orientation.

Definition at line 1071 of file xsdatapacket.cpp.

XsDataPacket_setOrientationIncrement()

void XsDataPacket_setOrientationIncrement	(	XsDataPacket *	thisPtr,
		const XsQuaternion *	quat
	)

Add/update delta quaternion data for the item.

Parameters

quat	: The data to update the XsDataPacket with

Definition at line 834 of file xsdatapacket.cpp.

XsDataPacket_setOrientationMatrix()

void XsDataPacket_setOrientationMatrix	(	XsDataPacket *	thisPtr,
		const XsMatrix *	data,
		XsDataIdentifier	coordinateSystem
	)

Add/update quaternion orientation Data for the item.

Parameters

data	The new data to set
coordinateSystem	The coordinate system of the orientation.

Definition at line 1127 of file xsdatapacket.cpp.

XsDataPacket_setOrientationQuaternion()

void XsDataPacket_setOrientationQuaternion	(	XsDataPacket *	thisPtr,
		const XsQuaternion *	data,
		XsDataIdentifier	coordinateSystem
	)

Add/update quaternion orientation Data for the item.

Parameters

data	The new data to set
coordinateSystem	The coordinate system of the requested orientation.

Definition at line 1011 of file xsdatapacket.cpp.

XsDataPacket_setPacketCounter()

void XsDataPacket_setPacketCounter	(	XsDataPacket *	thisPtr,
		uint16_t	counter
	)

Add/update packet counter data for the item.

Parameters

counter

The new data to set

Definition at line 1869 of file xsdatapacket.cpp.

XsDataPacket_setPacketCounter8()

void XsDataPacket_setPacketCounter8	(	XsDataPacket *	thisPtr,
		uint8_t	counter
	)

Add/update 8 bit packet counter data for the item.

Parameters

counter

The new data to set

Definition at line 1830 of file xsdatapacket.cpp.

XsDataPacket_setPositionLLA()

void XsDataPacket_setPositionLLA	(	XsDataPacket *	thisPtr,
		const XsVector *	data
	)

Add/update position lat lon alt data for the item.

\param data : The XsVector that conrtains the Lat/Long/Alt data to store in the packet

Definition at line 1487 of file xsdatapacket.cpp.

XsDataPacket_setPressure()

void XsDataPacket_setPressure	(	XsDataPacket *	thisPtr,
		const XsPressure *	data
	)

Add/update pressure data for the item.

Parameters

data	The new data to set

Definition at line 1214 of file xsdatapacket.cpp.

XsDataPacket_setRateOfTurnHR()

void XsDataPacket_setRateOfTurnHR	(	XsDataPacket *	thisPtr,
		const XsVector *	vec
	)

Add/update the RateOfTurnHR for the item.

Parameters

vec	A 3-component vector containing RateOfTurnHR

Definition at line 2613 of file xsdatapacket.cpp.

XsDataPacket_setRawAcceleration()

void XsDataPacket_setRawAcceleration	(	XsDataPacket *	thisPtr,
		const XsUShortVector *	vec
	)

Add/update raw accelerometer data for the item.

\param vec : The data to update the XsDataPacket with

\details This will add the raw acceleration from \a vec to the data packet. If
             the packet already contains raw acceleration, it will be replaced.

Definition at line 575 of file xsdatapacket.cpp.

XsDataPacket_setRawBlob()

void XsDataPacket_setRawBlob	(	XsDataPacket *	thisPtr,
		const XsByteArray *	data
	)

Sets the raw blob part of the XsDataPacket.

Parameters

data	The new data to set

Definition at line 2563 of file xsdatapacket.cpp.

XsDataPacket_setRawData()

void XsDataPacket_setRawData	(	XsDataPacket *	thisPtr,
		const XsScrData *	data
	)

Add/update raw data for the item.

Parameters

data	The new data to set

Definition at line 747 of file xsdatapacket.cpp.

XsDataPacket_setRawGnssPvtData()

void XsDataPacket_setRawGnssPvtData	(	XsDataPacket *	thisPtr,
		const XsRawGnssPvtData *	r
	)

Sets or updates the RawGnssPvtData value in the datapacket.

Parameters

r	The new value that should be added to the packet

Definition at line 2116 of file xsdatapacket.cpp.

XsDataPacket_setRawGnssSatInfo()

void XsDataPacket_setRawGnssSatInfo	(	XsDataPacket *	thisPtr,
		const XsRawGnssSatInfo *	data
	)

Sets or updates the RawGnssSatInfo value in the datapacket.

Parameters

data	The new value that should be added to the packet

Definition at line 2190 of file xsdatapacket.cpp.

XsDataPacket_setRawGyroscopeData()

void XsDataPacket_setRawGyroscopeData	(	XsDataPacket *	thisPtr,
		const XsUShortVector *	vec
	)

Add/update raw gyroscope data for the item.

Parameters

vec	The new data to set

Definition at line 602 of file xsdatapacket.cpp.

XsDataPacket_setRawGyroscopeTemperatureData()

void XsDataPacket_setRawGyroscopeTemperatureData	(	XsDataPacket *	thisPtr,
		const XsUShortVector *	vec
	)

Add/update raw gyroscope temperature data for the item.

Parameters

vec	The new data to set

Definition at line 699 of file xsdatapacket.cpp.

XsDataPacket_setRawMagneticField()

void XsDataPacket_setRawMagneticField	(	XsDataPacket *	thisPtr,
		const XsUShortVector *	vec
	)

Add/update raw magnetometer data for the item.

Parameters

vec	The new data to set

Definition at line 630 of file xsdatapacket.cpp.

XsDataPacket_setRawTemperature()

void XsDataPacket_setRawTemperature	(	XsDataPacket *	thisPtr,
		uint16_t	temp
	)

Add/update raw temperature data for the item.

Parameters

temp	The new data to set

Definition at line 659 of file xsdatapacket.cpp.

XsDataPacket_setRssi()

void XsDataPacket_setRssi	(	XsDataPacket *	thisPtr,
		int	r
	)

Sets or updates the rssi value in the datapacket.

\param r : The rssi value that should be added to the packet

Definition at line 2091 of file xsdatapacket.cpp.

XsDataPacket_setSampleTime64()

void XsDataPacket_setSampleTime64	(	XsDataPacket *	thisPtr,
		uint64_t	counter
	)

Add/update sample tine coarse data for the item.

Parameters

counter

The new data to set

Definition at line 1978 of file xsdatapacket.cpp.

XsDataPacket_setSampleTimeCoarse()

void XsDataPacket_setSampleTimeCoarse	(	XsDataPacket *	thisPtr,
		uint32_t	counter
	)

Add/update sample tine coarse data for the item.

Parameters

counter

The new data to set

Definition at line 1924 of file xsdatapacket.cpp.

XsDataPacket_setSampleTimeFine()

void XsDataPacket_setSampleTimeFine	(	XsDataPacket *	thisPtr,
		uint32_t	counter
	)

Add/update sample tine fine data for the item.

Parameters

counter

The new data to set

Definition at line 1895 of file xsdatapacket.cpp.

XsDataPacket_setSdiData()

void XsDataPacket_setSdiData	(	XsDataPacket *	thisPtr,
		const XsSdiData *	data
	)

Add/update strapdown integration data for the item.

Parameters

data	The updated data

Definition at line 1250 of file xsdatapacket.cpp.

XsDataPacket_setStatus()

void XsDataPacket_setStatus	(	XsDataPacket *	thisPtr,
		uint32_t	data
	)

Add/update status data for the item.

Parameters

data	The new data to set

Definition at line 1768 of file xsdatapacket.cpp.

XsDataPacket_setStatusByte()

void XsDataPacket_setStatusByte	(	XsDataPacket *	thisPtr,
		uint8_t	data
	)

Add/update status data for the item.

Parameters

data	The new data to set

Definition at line 1752 of file xsdatapacket.cpp.

XsDataPacket_setStoredDeviceId()

void XsDataPacket_setStoredDeviceId	(	XsDataPacket *	thisPtr,
		const XsDeviceId *	data
	)

Add or update device id for the item.

Parameters

data	the device ID to store in the packet

Definition at line 1337 of file xsdatapacket.cpp.

XsDataPacket_setStoredLocationId()

void XsDataPacket_setStoredLocationId	(	XsDataPacket *	thisPtr,
		uint16_t	data
	)

Add or update location ID for the item.

Parameters

data	the location ID to store in the packet

Definition at line 1362 of file xsdatapacket.cpp.

XsDataPacket_setTemperature()

void XsDataPacket_setTemperature	(	XsDataPacket *	thisPtr,
		double	temperature
	)

Adds or updates the temperature data in the datapacket.

The temp is added to the datapacket. If the packet already contains temperature it is replaced with the new value.

Parameters

temperature

: The temperature to set

Definition at line 1388 of file xsdatapacket.cpp.

XsDataPacket_setTriggerIndication()

void XsDataPacket_setTriggerIndication	(	XsDataPacket *	thisPtr,
		XsDataIdentifier	triggerId,
		const XsTriggerIndicationData *	triggerIndicationData
	)

Add/update trigger indication data for the item.

Parameters

[in]	triggerId	The trigger data identifier to add data for (e.g. XDI_TriggerIn1 or XDI_TriggerIn2)
[in]	triggerIndicationData	pointer the a XsTriggerIndicationData buffer containing the data to set

Definition at line 1803 of file xsdatapacket.cpp.

XsDataPacket_setUtcTime()

void XsDataPacket_setUtcTime	(	XsDataPacket *	thisPtr,
		const XsTimeInfo *	data
	)

Add/update utc time data for the item.

Parameters

data	The new data to set

Definition at line 2005 of file xsdatapacket.cpp.

XsDataPacket_setVelocity()

void XsDataPacket_setVelocity	(	XsDataPacket *	thisPtr,
		const XsVector *	data,
		XsDataIdentifier	coordinateSystem
	)

Add/update velocity NED data for the item.

Parameters

data	The new data to set
coordinateSystem	The coordinate system of the requested orientation.

Definition at line 1686 of file xsdatapacket.cpp.

XsDataPacket_setVelocityIncrement()

void XsDataPacket_setVelocityIncrement	(	XsDataPacket *	thisPtr,
		const XsVector *	vec
	)

Add/update delta velocity data for the item.

Parameters

vec	: The data to update the XsDataPacket with

Definition at line 781 of file xsdatapacket.cpp.

XsDataPacket_status()

uint32_t XsDataPacket_status

(

const XsDataPacket *

thisPtr

)

The status component of a data item.

\returns An uint32_t containing the status value

Definition at line 1719 of file xsdatapacket.cpp.

XsDataPacket_storedDeviceId()

XsDeviceId* XsDataPacket_storedDeviceId	(	const XsDataPacket *	thisPtr,
		XsDeviceId *	returnVal
	)

The device id of a data item.

\param returnVal an XsDeviceId object to put the requested data in

\returns An XsDeviceId object containing the requested device ID

Definition at line 1321 of file xsdatapacket.cpp.

XsDataPacket_storedLocationId()

uint16_t XsDataPacket_storedLocationId

(

const XsDataPacket *

thisPtr

)

The location ID of a data item.

Returns

The requested location ID

Definition at line 1346 of file xsdatapacket.cpp.

XsDataPacket_swap()

void XsDataPacket_swap	(	XsDataPacket *	thisPtr,
		XsDataPacket *	other
	)

Swaps the XsDataPackets in thisPtr and other.

Parameters

other

The object to swap with

Definition at line 493 of file xsdatapacket.cpp.

XsDataPacket_temperature()

double XsDataPacket_temperature

(

const XsDataPacket *

thisPtr

)

The temperature component of a data item.

Returns

A double containing the temperature value, -1000.0 if the packet does not contain temperature

Definition at line 1370 of file xsdatapacket.cpp.

XsDataPacket_toMessage()

void XsDataPacket_toMessage	(	const XsDataPacket *	thisPtr,
		XsMessage *	msg
	)

Write the contents of the XsDataPacket to an XsMessage in MtData2 format.

The function will clear the message and add all items in the XsDataPacket as a standard MtData2 message.

Parameters

msg	The message to write to

Definition at line 2283 of file xsdatapacket.cpp.

XsDataPacket_triggerIndication()

XsTriggerIndicationData* XsDataPacket_triggerIndication	(	const XsDataPacket *	thisPtr,
		XsDataIdentifier	triggerId,
		XsTriggerIndicationData *	returnVal
	)

Returns the trigger indication data of a packet If the packet does not contain the requested data, the return val struct will be set to all zeroes.

Parameters

[in]	triggerId	The trigger data identifier to add data for (e.g. XDI_TriggerIn1 or XDI_TriggerIn2)
[out]	returnVal	pointer to the trigger indication data of a packet.

Note

returnVal should point to a buffer large enough to hold sizeof(XsTriggerIndicationData) bytes of data

Returns

Returns a pointer to the trigger indication data of a packet

Definition at line 1785 of file xsdatapacket.cpp.

XsDataPacket_utcTime()

XsTimeInfo* XsDataPacket_utcTime	(	const XsDataPacket *	thisPtr,
		XsTimeInfo *	returnVal
	)

The utc time component of a data item.

Parameters

returnVal

: The XsTimeInfo to return the requested data in

Returns

An XsTimeInfo containing the utc time value

Definition at line 1989 of file xsdatapacket.cpp.

XsDataPacket_velocity()

XsVector* XsDataPacket_velocity	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal,
		XsDataIdentifier	coordinateSystem
	)

The velocity NWU component of a data item.

\param returnVal : The XsVector to put the data in
\param coordinateSystem The coordinate system of the requested velocity. If this does not match
the stored coordinate system, it will be transformed to the requested velocity.
\returns A XsVector containing the x, y and z axis values in that order

Definition at line 1593 of file xsdatapacket.cpp.

XsDataPacket_velocityIdentifier()

XsDataIdentifier XsDataPacket_velocityIdentifier

(

const XsDataPacket *

thisPtr

)

Returns the data identifier of the first velocity data of any kind in the packet.

Returns

The XsDataIdentifier of the first velocity data of any kind in the packet

Definition at line 1699 of file xsdatapacket.cpp.

XsDataPacket_velocityIncrement()

XsVector* XsDataPacket_velocityIncrement	(	const XsDataPacket *	thisPtr,
		XsVector *	returnVal
	)

The delta velocity (deltaV) component of a data item.

Parameters

returnVal

: The XsVector that the deltaV will be assigned to

Returns

An XsVector containing the x, y and z axis values in that order

Definition at line 765 of file xsdatapacket.cpp.

XsDeviceCapabilities_hasAccelerometer()

int XsDeviceCapabilities_hasAccelerometer

(

const struct XsDeviceCapabilities *

thisPtr

)

Test if the device has an operational accelerometer.

Returns

True if the Accelerometer flag is set

Definition at line 86 of file xsdevicecapabilities.c.

XsDeviceCapabilities_hasBarometer()

int XsDeviceCapabilities_hasBarometer

(

const struct XsDeviceCapabilities *

thisPtr

)

Test if the device has an operational barometer.

Returns

True if the Barometer flag is set

Definition at line 110 of file xsdevicecapabilities.c.

XsDeviceCapabilities_hasGnss()

int XsDeviceCapabilities_hasGnss

(

const struct XsDeviceCapabilities *

thisPtr

)

Test if the device has an operational GNSS receiver.

Returns

True if the GNSS flag is set

Definition at line 118 of file xsdevicecapabilities.c.

XsDeviceCapabilities_hasGyroscope()

int XsDeviceCapabilities_hasGyroscope

(

const struct XsDeviceCapabilities *

thisPtr

)

Test if the device has an operational gyroscope.

Returns

True if the Gyroscope flag is set

Definition at line 94 of file xsdevicecapabilities.c.

XsDeviceCapabilities_hasMagnetometer()

int XsDeviceCapabilities_hasMagnetometer

(

const struct XsDeviceCapabilities *

thisPtr

)

Test if the device has an operational magnetometer.

Returns

True if the Magnetometer flag is set

Definition at line 102 of file xsdevicecapabilities.c.

XsDeviceCapabilities_isAhrs()

int XsDeviceCapabilities_isAhrs

(

const struct XsDeviceCapabilities *

thisPtr

)

Test if the device has an AHRS.

Returns

True if the AHRS flag is set

Definition at line 142 of file xsdevicecapabilities.c.

XsDeviceCapabilities_isGnssIns()

int XsDeviceCapabilities_isGnssIns

(

const struct XsDeviceCapabilities *

thisPtr

)

Test if the device is a GNSS/INS.

Returns

True if the GNSS/INS flag is set

Definition at line 150 of file xsdevicecapabilities.c.

XsDeviceCapabilities_isImu()

int XsDeviceCapabilities_isImu

(

const struct XsDeviceCapabilities *

thisPtr

)

Test if the device is an IMU.

Returns

True if the IMU flag is set

Definition at line 126 of file xsdevicecapabilities.c.

XsDeviceCapabilities_isRtk()

int XsDeviceCapabilities_isRtk

(

const struct XsDeviceCapabilities *

thisPtr

)

Test if the device is an RTK device.

Returns

True if the RTK flag is set

Definition at line 158 of file xsdevicecapabilities.c.

XsDeviceCapabilities_isValid()

int XsDeviceCapabilities_isValid

(

const struct XsDeviceCapabilities *

thisPtr

)

Test if the given XsDeviceCapabilities is valid.

Returns

True if valid.

Definition at line 78 of file xsdevicecapabilities.c.

XsDeviceCapabilities_isVru()

int XsDeviceCapabilities_isVru

(

const struct XsDeviceCapabilities *

thisPtr

)

Test if the device has a VRU.

Returns

True if the VRU flag is set

Definition at line 134 of file xsdevicecapabilities.c.

XsDeviceConfiguration_assign()

void XsDeviceConfiguration_assign ( XsDeviceConfiguration *  thisPtr, XsSize  numberOfDevices, const XsDeviceConfiguration *  src  )

related

Reinitializes the XsDeviceConfiguration with space for numberOfDevices devices and copies them from src.

This function reinitializes the object reserving space for numberOfDevices devices in the buffer. size may be 0. If src is not null, numberOfDevices bytes from src will be copied. Previous data will be cleared and freed automatically.

Parameters

numberOfDevices	: The number of devices for which memory should be allocated in the XsDeviceConfiguration
src	: A source XsDeviceConfiguration object that will be used to initialize the new object. May be null

Definition at line 96 of file xsdeviceconfiguration.c.

XsDeviceConfiguration_construct()

void XsDeviceConfiguration_construct ( XsDeviceConfiguration *  thisPtr )

related

Initializes the XsDeviceConfiguration object.

Definition at line 82 of file xsdeviceconfiguration.c.

XsDeviceConfiguration_copy()

void XsDeviceConfiguration_copy ( XsDeviceConfiguration *  copy, XsDeviceConfiguration const *  src  )

related

Copy the XsDeviceConfiguration to copy.

Definition at line 137 of file xsdeviceconfiguration.c.

XsDeviceConfiguration_destruct()

void XsDeviceConfiguration_destruct ( XsDeviceConfiguration *  thisPtr )

related

Clears and frees data in the XsDeviceConfiguration.

Definition at line 122 of file xsdeviceconfiguration.c.

XsDeviceConfiguration_empty()

int XsDeviceConfiguration_empty ( const XsDeviceConfiguration *  thisPtr )

related

Returns true if the XsDeviceConfiguration is empty.

Returns

Returns true if the XsDeviceConfiguration is empty

Definition at line 148 of file xsdeviceconfiguration.c.

XsDeviceConfiguration_findDevice()

XsSize XsDeviceConfiguration_findDevice ( const XsDeviceConfiguration *  thisPtr, const XsDeviceId *  deviceId  )

related

Returns a (naive) bus ID if deviceId is available in this configuration, 0 otherwise.

Note

The bus ID may not be valid for device communications

Parameters

deviceId

the device ID to look for

Returns

the bus ID that matches deviceId

Definition at line 283 of file xsdeviceconfiguration.c.

XsDeviceConfiguration_readFromMessage()

void XsDeviceConfiguration_readFromMessage ( XsDeviceConfiguration *  thisPtr, const XsMessage *  msg  )

related

Sets up a XsDeviceConfiguration based upon msg.

Parameters

msg	: The XsMessage to use to set up the XsDeviceConfiguration object

Definition at line 158 of file xsdeviceconfiguration.c.

XsDeviceConfiguration_writeToMessage()

void XsDeviceConfiguration_writeToMessage ( const XsDeviceConfiguration *  thisPtr, XsMessage *  msg  )

related

Creates a message msg that represents the XsDeviceConfiguration.

Parameters

msg	: An XsMessage that will represent the XsDeviceConfiguration

Definition at line 218 of file xsdeviceconfiguration.c.

XsDeviceId_contains()

int XsDeviceId_contains	(	XsDeviceId const *	thisPtr,
		XsDeviceId const *	other
	)

Returns true if this is equal to other or this is a type-specifier that matches other.

Parameters

other

The deviceid to compare this deviceid to

Returns

True if the deviceids are equal or the type-specifier matches

Definition at line 824 of file xsdeviceid.c.

XsDeviceId_deviceType()

void XsDeviceId_deviceType	(	struct XsDeviceId const *	thisPtr,
		int	detailed,
		struct XsDeviceId *	type
	)

Returns the device type identified by this id (eg 10, 300 and Awinda2 Master)

Parameters

detailed	Return detailed type information
type	Type to write to

Definition at line 973 of file xsdeviceid.c.

XsDeviceId_deviceTypeMask()

void XsDeviceId_deviceTypeMask	(	struct XsDeviceId const *	thisPtr,
		int	detailed,
		struct XsDeviceId *	type
	)

Returns the mask which can be used to get the detailed device type (eg 10, 300 and Awinda2 Master)

Parameters

detailed	Return detailed type information
type	Type to write to

Definition at line 1024 of file xsdeviceid.c.

XsDeviceId_fromDeviceTypeString()

void XsDeviceId_fromDeviceTypeString	(	XsDeviceId *	thisPtr,
		const XsString *	str
	)

Read a device ID from the supplied string.

Parameters

str	The string to interpret

Definition at line 780 of file xsdeviceid.c.

XsDeviceId_fromString()

void XsDeviceId_fromString	(	XsDeviceId *	thisPtr,
		const XsString *	str
	)

Read a device ID from the supplied string.

Parameters

str	The string to interpret

Definition at line 738 of file xsdeviceid.c.

XsDeviceId_hasInternalGnss()

int XsDeviceId_hasInternalGnss

(

struct XsDeviceId const *

thisPtr

)

Test if this device ID represents a device with internal GNSS receiver.

Returns

true if this XsDeviceId represents a Sensor with internal GNSS

Definition at line 321 of file xsdeviceid.c.

XsDeviceId_isAhrs()

int XsDeviceId_isAhrs

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an AHRS.

Returns

true if this XsDeviceId represents an AHRS

Definition at line 579 of file xsdeviceid.c.

XsDeviceId_isAwinda2()

int XsDeviceId_isAwinda2

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an Awinda2 device.

Returns

true if this XsDeviceId represents an Awinda2 device

Definition at line 455 of file xsdeviceid.c.

XsDeviceId_isAwinda2Dongle()

int XsDeviceId_isAwinda2Dongle

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an Awinda2 Dongle.

Returns

true if this XsDeviceId represents an Awinda2 Dongle

Definition at line 477 of file xsdeviceid.c.

XsDeviceId_isAwinda2Oem()

int XsDeviceId_isAwinda2Oem

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an Awinda2 OEM board.

Returns

true if this XsDeviceId represents an Awinda2 OEM board

Definition at line 488 of file xsdeviceid.c.

XsDeviceId_isAwinda2Station()

int XsDeviceId_isAwinda2Station

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an Awinda2 Station.

Returns

true if this XsDeviceId represents an Awinda2 Station

Definition at line 466 of file xsdeviceid.c.

XsDeviceId_isAwindaX()

int XsDeviceId_isAwindaX

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an Awinda device.

Returns

true if this XsDeviceId represents an Awinda device

Definition at line 423 of file xsdeviceid.c.

XsDeviceId_isAwindaXDongle()

int XsDeviceId_isAwindaXDongle

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an Awinda Dongle.

Returns

true if this XsDeviceId represents an Awinda Dongle

Definition at line 439 of file xsdeviceid.c.

XsDeviceId_isAwindaXOem()

int XsDeviceId_isAwindaXOem

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an Awinda OEM board.

Returns

true if this XsDeviceId represents an Awinda OEM board

Definition at line 447 of file xsdeviceid.c.

XsDeviceId_isAwindaXStation()

int XsDeviceId_isAwindaXStation

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an Awinda Station.

Returns

true if this XsDeviceId represents an Awinds Station

Definition at line 431 of file xsdeviceid.c.

XsDeviceId_isBodyPack()

int XsDeviceId_isBodyPack

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents a bodypack (any version) device.

Returns

true if this XsDeviceId represents a bodypack (any version) device

Definition at line 375 of file xsdeviceid.c.

XsDeviceId_isBodyPackV1()

int XsDeviceId_isBodyPackV1

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents a bodypack V1 device.

Returns

true if this XsDeviceId represents a bodypack V1 device

Definition at line 386 of file xsdeviceid.c.

XsDeviceId_isBodyPackV2()

int XsDeviceId_isBodyPackV2

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents a bodypack V2 device.

Returns

true if this XsDeviceId represents a bodypack V2 device

Definition at line 397 of file xsdeviceid.c.

XsDeviceId_isContainerDevice()

int XsDeviceId_isContainerDevice

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents any of the container devices such as Bodypack and Awinda Station.

Returns

true if this XsDeviceId represents a container device

Definition at line 656 of file xsdeviceid.c.

XsDeviceId_isDot()

int XsDeviceId_isDot

(

struct XsDeviceId const *

thisPtr

)

Test if the device ID represents a Dot series device.

Returns

true if this XsDeviceId represents a Dot series device

Definition at line 291 of file xsdeviceid.c.

XsDeviceId_isGlove()

int XsDeviceId_isGlove

(

const struct XsDeviceId *

thisPtr

)

Test if the device ID represents a Glove series device.

Returns

true if this XsDeviceId represents a Glove series device

Definition at line 239 of file xsdeviceid.c.

XsDeviceId_isGnss()

int XsDeviceId_isGnss

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an GNSS (capable) device.

Returns

true if this XsDeviceId represents a GNSS capable device

Definition at line 607 of file xsdeviceid.c.

XsDeviceId_isHilDevice()

int XsDeviceId_isHilDevice

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents a Hardware In the Loop test device.

Returns

true if this XsDeviceId represents a Hardware In the Loop test device

Definition at line 512 of file xsdeviceid.c.

XsDeviceId_isImu()

int XsDeviceId_isImu

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an IMU.

Returns

true if this XsDeviceId represents an IMU

Definition at line 523 of file xsdeviceid.c.

XsDeviceId_isLegacyDeviceId()

int XsDeviceId_isLegacyDeviceId

(

const struct XsDeviceId *

thisPtr

)

Test if the device ID represents a legacy device identification.

Returns

true if this XsDeviceId represents a legacy device identification

Definition at line 90 of file xsdeviceid.c.

XsDeviceId_isMt()

int XsDeviceId_isMt

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MT device (any Mti, Mtig, Mtx or Mtw)

Returns

true if this XsDeviceId represents an MT device

Definition at line 664 of file xsdeviceid.c.

XsDeviceId_isMti()

int XsDeviceId_isMti

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTi device (1, 10 or 100 series, 1 includes MTi-7)

Returns

true if this XsDeviceId represents an MTi device

Definition at line 672 of file xsdeviceid.c.

XsDeviceId_isMti3X0()

int XsDeviceId_isMti3X0

(

const struct XsDeviceId *

thisPtr

)

Test if the device ID represents an MTi-3X0 device.

Returns

true if this XsDeviceId represents an MTi-3X0 series device

Definition at line 228 of file xsdeviceid.c.

XsDeviceId_isMti6X0()

int XsDeviceId_isMti6X0

(

const struct XsDeviceId *

thisPtr

)

Test if the device ID represents an MTi-600 series device.

Returns

true if this XsDeviceId represents an Mti-600 series device

Definition at line 194 of file xsdeviceid.c.

XsDeviceId_isMti8X0()

int XsDeviceId_isMti8X0

(

const struct XsDeviceId *

thisPtr

)

Test if the device ID represents an MTi-800 series device.

Returns

true if this XsDeviceId represents an Mti-800 series device

Definition at line 211 of file xsdeviceid.c.

XsDeviceId_isMtig()

int XsDeviceId_isMtig

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTig device (700 or 710 series)

Returns

true if this XsDeviceId represents an MTig device

Definition at line 680 of file xsdeviceid.c.

XsDeviceId_isMtigX00()

int XsDeviceId_isMtigX00

(

const struct XsDeviceId *

thisPtr

)

Test if the device ID represents an Mtig 700 device.

Returns

true if this XsDeviceId represents an Mtig 700 series device

Definition at line 154 of file xsdeviceid.c.

XsDeviceId_isMtigX10()

int XsDeviceId_isMtigX10

(

const struct XsDeviceId *

thisPtr

)

Test if the device ID represents an Mtig 710 device.

Returns

true if this XsDeviceId represents an Mtig 710 series device

Definition at line 174 of file xsdeviceid.c.

XsDeviceId_isMtiX()

int XsDeviceId_isMtiX

(

const struct XsDeviceId *

thisPtr

)

Test if the device ID represents an Mti 1-series device.

Returns

true if this XsDeviceId represents an Mti-1 series device

Definition at line 98 of file xsdeviceid.c.

XsDeviceId_isMtiX0()

int XsDeviceId_isMtiX0

(

const struct XsDeviceId *

thisPtr

)

Test if the device ID represents an Mti 10-series device.

Returns

true if this XsDeviceId represents an Mti-10 series device

Definition at line 114 of file xsdeviceid.c.

XsDeviceId_isMtiX00()

int XsDeviceId_isMtiX00

(

const struct XsDeviceId *

thisPtr

)

Test if the device ID represents an Mti 100-series device.

Returns

true if this XsDeviceId represents an Mti-100 series device

Definition at line 130 of file xsdeviceid.c.

XsDeviceId_isMtMark4()

int XsDeviceId_isMtMark4

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an Mk4 generation MT device.

Returns

true if this XsDeviceId represents an Mk4 generation device

Definition at line 688 of file xsdeviceid.c.

XsDeviceId_isMtMark5()

int XsDeviceId_isMtMark5

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an Mk5 generation MT device.

Returns

true if this XsDeviceId represents an Mk5 generation device

Definition at line 699 of file xsdeviceid.c.

XsDeviceId_isMtMk4()

int XsDeviceId_isMtMk4

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4.

Returns

True if it is an MTMk4.

Deprecated:

If the purpose is to check for a Mk4, Mk5 or 1-series device use: isMti() || isMtig(). If the purpose is to detect actual Mk4 (10,100,7x0) use isMtMark4()

Definition at line 1059 of file xsdeviceid.c.

XsDeviceId_isMtMk4_1()

int XsDeviceId_isMtMk4_1

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 1.

Returns

True if it is an MTMk4 1.

Deprecated:

Use isMtiX() and isImu()

Definition at line 1079 of file xsdeviceid.c.

XsDeviceId_isMtMk4_10()

int XsDeviceId_isMtMk4_10

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 10.

Returns

True if it is an MTMk4 10.

Deprecated:

Use isMtiX0() and isImu()

Definition at line 1124 of file xsdeviceid.c.

XsDeviceId_isMtMk4_100()

int XsDeviceId_isMtMk4_100

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 100.

Returns

True if it is an MTMk4 100.

Deprecated:

Use isMtiX00() and isImu()

Definition at line 1160 of file xsdeviceid.c.

XsDeviceId_isMtMk4_2()

int XsDeviceId_isMtMk4_2

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 2.

Returns

True if it is an MTMk4 2.

Deprecated:

Use isMtiX() and isVru()

Definition at line 1088 of file xsdeviceid.c.

XsDeviceId_isMtMk4_20()

int XsDeviceId_isMtMk4_20

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 20.

Returns

True if it is an MTMk4 20.

Deprecated:

Use isMtiX0() and isVru()

Definition at line 1133 of file xsdeviceid.c.

XsDeviceId_isMtMk4_200()

int XsDeviceId_isMtMk4_200

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 200.

Returns

True if it is an MTMk4 200.

Deprecated:

Use isMtiX00() and isVru()

Definition at line 1169 of file xsdeviceid.c.

XsDeviceId_isMtMk4_3()

int XsDeviceId_isMtMk4_3

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 3.

Returns

True if it is an MTMk4 3.

Deprecated:

Use isMtiX() and isAhrs()

Definition at line 1097 of file xsdeviceid.c.

XsDeviceId_isMtMk4_30()

int XsDeviceId_isMtMk4_30

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 30.

Returns

True if it is an MTMk4 30.

Deprecated:

Use isMtiX0() and isAhrs()

Definition at line 1142 of file xsdeviceid.c.

XsDeviceId_isMtMk4_300()

int XsDeviceId_isMtMk4_300

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 300.

Returns

True if it is an MTMk4 300.

Deprecated:

Use isMtiX00() and isAhrs()

Definition at line 1178 of file xsdeviceid.c.

XsDeviceId_isMtMk4_400()

int XsDeviceId_isMtMk4_400

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 400.

Returns

True if it is an MTMk4 400.

Deprecated:

Will be removed

Definition at line 1187 of file xsdeviceid.c.

XsDeviceId_isMtMk4_500()

int XsDeviceId_isMtMk4_500

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 500.

Returns

True if it is an MTMk4 500.

Deprecated:

Will be removed

Definition at line 1196 of file xsdeviceid.c.

XsDeviceId_isMtMk4_600()

int XsDeviceId_isMtMk4_600

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 600.

Returns

True if it is an MTMk4 600.

Deprecated:

Will be removed

Definition at line 1205 of file xsdeviceid.c.

XsDeviceId_isMtMk4_7()

int XsDeviceId_isMtMk4_7

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 7.

Returns

True if it is an MTMk4 7.

Deprecated:

Use isMtiX(), isGnss(), and !isRtk() together

Definition at line 1106 of file xsdeviceid.c.

XsDeviceId_isMtMk4_700()

int XsDeviceId_isMtMk4_700

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 700.

Returns

True for all 700 and 710's (Mk4 and Mk5).

Deprecated:

use isGnss() to check for Gnss capabilities, use isMtig() to check for either 700 or 710, use isMtigX00() or isMtigX10() to discern between 700 and 710, use isMtMark4() or isMtMark5() to discern between Mark 4 and Mark 5

Definition at line 1217 of file xsdeviceid.c.

XsDeviceId_isMtMk4_710()

int XsDeviceId_isMtMk4_710

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents either an MTMk4 710 or Mk5 710.

Returns

True if it is either an MTMk4 710 or Mk5 710.

Deprecated:

use isGnss() to check for Gnss capabilities, use isMtig() to check for either 700 or 710, use isMtigX00() or isMtigX10() to discern between 700 and 710

Definition at line 1226 of file xsdeviceid.c.

XsDeviceId_isMtMk4_800()

int XsDeviceId_isMtMk4_800

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 800.

Returns

True if it is an MTMk4 800.

Deprecated:

Will be removed

Definition at line 1235 of file xsdeviceid.c.

XsDeviceId_isMtMk4_900()

int XsDeviceId_isMtMk4_900

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 900.

Returns

True if it is an MTMk4 900.

Deprecated:

Will be removed

Definition at line 1244 of file xsdeviceid.c.

XsDeviceId_isMtMk4_X()

int XsDeviceId_isMtMk4_X

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 1 series.

Returns

True if it is an MTMk4 1 series.

Deprecated:

Use isMtiX()

Definition at line 1070 of file xsdeviceid.c.

XsDeviceId_isMtMk4_X0()

int XsDeviceId_isMtMk4_X0

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 10 series.

Returns

True if it is an MTMk4 10 series.

Deprecated:

Use isMtiX0()

Definition at line 1115 of file xsdeviceid.c.

XsDeviceId_isMtMk4_X00()

int XsDeviceId_isMtMk4_X00

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk4 100 series (including 700 and 710)

Returns

True if it is an MTMk4 100 series.

Deprecated:

Use isMtiX00() || isMtig() to detect all 100's and 7x0's

Definition at line 1151 of file xsdeviceid.c.

XsDeviceId_isMtMk5()

int XsDeviceId_isMtMk5

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk5.

Returns

True if it is an MTMk5.

Deprecated:

Use isMtMark5()

Definition at line 1253 of file xsdeviceid.c.

XsDeviceId_isMtMk5_10()

int XsDeviceId_isMtMk5_10

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk5 10.

Returns

True if it is an MTMk5 10.

Deprecated:

Use isMtMark5() && isMtiX0() && isImu()

Definition at line 1271 of file xsdeviceid.c.

XsDeviceId_isMtMk5_100()

int XsDeviceId_isMtMk5_100

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk5 100.

Returns

True if it is an MTMk5 100.

Deprecated:

Use isMtMark5() && isMtiX00() && isImu()

Definition at line 1307 of file xsdeviceid.c.

XsDeviceId_isMtMk5_20()

int XsDeviceId_isMtMk5_20

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk5 20.

Returns

True if it is an MTMk5 20.

Deprecated:

Use isMtMark5() && isMtiX0() && isVru()

Definition at line 1280 of file xsdeviceid.c.

XsDeviceId_isMtMk5_200()

int XsDeviceId_isMtMk5_200

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk5 200.

Returns

True if it is an MTMk5 200.

Deprecated:

Use isMtMark5() && isMtiX00() && isVru()

Definition at line 1316 of file xsdeviceid.c.

XsDeviceId_isMtMk5_30()

int XsDeviceId_isMtMk5_30

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk5 30.

Returns

True if it is an MTMk5 30.

Deprecated:

Use isMtMark5() && isMtiX0() && isAhrs()

Definition at line 1289 of file xsdeviceid.c.

XsDeviceId_isMtMk5_300()

int XsDeviceId_isMtMk5_300

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk5 300.

Returns

True if it is an MTMk5 300.

Deprecated:

Use isMtMark5() && isMtiX00() && isAhrs()

Definition at line 1325 of file xsdeviceid.c.

XsDeviceId_isMtMk5_710()

int XsDeviceId_isMtMk5_710

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk5 710.

Returns

True if it is an MTMk5 710.

Deprecated:

Use (isMtMark5() && isMtigX10())

Definition at line 1334 of file xsdeviceid.c.

XsDeviceId_isMtMk5_X0()

int XsDeviceId_isMtMk5_X0

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk5 10 series.

Returns

True if it is an MTMk5 10 series.

Deprecated:

Use isMtMark5() && isMtiX0()

Definition at line 1262 of file xsdeviceid.c.

XsDeviceId_isMtMk5_X00()

int XsDeviceId_isMtMk5_X00

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTMk5 100 series.

Returns

True if it is an MTMk5 100 series.

Deprecated:

Use isMtMark5() && (isMtiX00() || isMtig())

Definition at line 1298 of file xsdeviceid.c.

XsDeviceId_isMtw()

int XsDeviceId_isMtw

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTw.

Returns

true if this XsDeviceId represents an MTw

Definition at line 337 of file xsdeviceid.c.

XsDeviceId_isMtw2()

int XsDeviceId_isMtw2

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTw2.

Returns

true if this XsDeviceId represents an MTw2

Definition at line 345 of file xsdeviceid.c.

XsDeviceId_isMtx()

int XsDeviceId_isMtx

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTx.

Returns

true if this XsDeviceId represents an MTx

Definition at line 356 of file xsdeviceid.c.

XsDeviceId_isMtx2()

int XsDeviceId_isMtx2

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an MTx2.

Returns

true if this XsDeviceId represents an MTx2

Definition at line 364 of file xsdeviceid.c.

XsDeviceId_isRtk()

int XsDeviceId_isRtk

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents an RTK (capable) device.

Returns

true if this XsDeviceId represents a RTK capable device

Definition at line 639 of file xsdeviceid.c.

XsDeviceId_isRugged()

int XsDeviceId_isRugged

(

struct XsDeviceId const *

thisPtr

)

Test if this device ID represents an Rugged Version.

Returns

true if this XsDeviceId represents an Rugged Sensor

Definition at line 307 of file xsdeviceid.c.

XsDeviceId_isSyncStation2()

int XsDeviceId_isSyncStation2

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents a SyncStation v2.

Returns

true if this XsDeviceId represents a SyncStation v2

Definition at line 504 of file xsdeviceid.c.

XsDeviceId_isSyncStationX()

int XsDeviceId_isSyncStationX

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents a SyncStation.

Returns

true if this XsDeviceId represents a SyncStation

Definition at line 496 of file xsdeviceid.c.

XsDeviceId_isType()

int XsDeviceId_isType

(

XsDeviceId const *

thisPtr

)

Returns true if the ID is just a device type, not an actual device ID.

Returns

true if the ID is just a device type

Definition at line 849 of file xsdeviceid.c.

XsDeviceId_isValid()

int XsDeviceId_isValid

(

const struct XsDeviceId *

thisPtr

)

Test if the device ID is a valid id (not 0).

Returns

true if the device ID is vallid

Definition at line 801 of file xsdeviceid.c.

XsDeviceId_isVru()

int XsDeviceId_isVru

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents a VRU.

Returns

true if this XsDeviceId represents a VRU

Definition at line 551 of file xsdeviceid.c.

XsDeviceId_isWirelessMaster()

int XsDeviceId_isWirelessMaster

(

const struct XsDeviceId *

thisPtr

)

Test if this device ID represents a Wireless Master device (Awinda Station, Awinda Dongle, Awinda OEM)

Returns

true if this XsDeviceId represents a Wireless Master device

Definition at line 408 of file xsdeviceid.c.

XsDeviceId_legacyBit()

uint64_t XsDeviceId_legacyBit

(

const struct XsDeviceId *

thisPtr

)

Returns

The legacy bit used to identify legacy or new XsDeviceId format

Definition at line 81 of file xsdeviceid.c.

XsDeviceId_side()

XsHandId XsDeviceId_side

(

struct XsDeviceId const *

thisPtr

)

Return the side the device should be worn on.

Currently this only applies to the Xsens Glove product line. For other devices XHI_Unknown will be returned.

Returns

The hand id of the provided Glove XsDeviceId, XHI_Unknown if the device ID does not represent a Glove

Definition at line 261 of file xsdeviceid.c.

XsDeviceId_swap()

void XsDeviceId_swap	(	XsDeviceId *	a,
		XsDeviceId *	b
	)

Swap the contents of a with those of b.

Parameters

a	Pointer to first deviceId
b	Pointer to second deviceId

Definition at line 813 of file xsdeviceid.c.

XsDeviceId_toDeviceTypeString()

void XsDeviceId_toDeviceTypeString	(	const XsDeviceId *	thisPtr,
		XsString *	str,
		int	makeType
	)

Get a string with a readable representation of this device ID. Either full or as a type.

Parameters

makeType	Boolean whether the deviceid is changed to a type instead of the full deviceid
str	The string to write to

Definition at line 761 of file xsdeviceid.c.

XsDeviceId_toString()

void XsDeviceId_toString	(	const XsDeviceId *	thisPtr,
		XsString *	str
	)

Get a string with a readable representation of this device ID.

Parameters

str	The string to write to

Definition at line 715 of file xsdeviceid.c.

XsDeviceId_type()

void XsDeviceId_type	(	struct XsDeviceId const *	thisPtr,
		struct XsDeviceId *	type
	)

Returns the type of device identified by this id.

Parameters

type	Type to write to

Definition at line 954 of file xsdeviceid.c.

XsDeviceId_typeName()

void XsDeviceId_typeName	(	XsDeviceId const *	thisPtr,
		XsString *	str
	)

Returns the name of the type of device identified by this id.

Parameters

str	String to write to

Definition at line 861 of file xsdeviceid.c.

XsDeviceState_toString()

const char* XsDeviceState_toString

(

XsDeviceState

s

)

Convert the device state to a human readable string.

Definition at line 74 of file xsdevicestate.c.

XsEuler_destruct()

void XsEuler_destruct ( XsEuler *  thisPtr )

related

Clears all angles in the XsEuler object by setting them to 0.

Definition at line 85 of file xseuler.c.

XsEuler_empty()

int XsEuler_empty ( const XsEuler *  thisPtr )

related

Returns true if all angles in this object are zero.

Definition at line 95 of file xseuler.c.

XsEuler_fromQuaternion()

void XsEuler_fromQuaternion ( XsEuler *  thisPtr, const XsQuaternion *  quat  )

related

Get an euler angle representation of the quaternion.

Definition at line 103 of file xseuler.c.

XsFile_close()

XsResultValue XsFile_close ( struct XsFile *  thisPtr )

related

Closes the file.

Returns

XRV_OK if the file was closed properly, XRV_ENDOFFILE otherwise

Definition at line 323 of file xsfile.c.

XsFile_create()

XsResultValue XsFile_create ( struct XsFile *  thisPtr, const struct XsString *  filename, int  writeOnly  )

related

Creates a new binary file with name filename, contents of existing files will be discarded.

Parameters

filename	name of the file to create
writeOnly	passing 0 will create the file using "w+b", any other value will create it using "wb"

Returns

XRV_OK if the file was opened, an error otherwise

Definition at line 109 of file xsfile.c.

XsFile_createText()

XsResultValue XsFile_createText ( struct XsFile *  thisPtr, const struct XsString *  filename, int  writeOnly  )

related

Creates a new text file with name filename, contents of existing files will be discarded.

Parameters

filename	name of the file to create
writeOnly	passing 0 will create the file using "w+t", any other value will create it using "wt"

Returns

XRV_OK if the file was opened, an error otherwise

Definition at line 151 of file xsfile.c.

XsFile_destruct()

void XsFile_destruct ( struct XsFile *  thisPtr )

related

Frees the resources of this object by closing the file if it is open.

Definition at line 97 of file xsfile.c.

XsFile_eof()

int XsFile_eof ( struct XsFile const *  thisPtr )

related

Returns

Returns 0 if the current file position is not 'end of file', non 0 if the position is 'end of file'

Definition at line 532 of file xsfile.c.

XsFile_erase()

XsResultValue XsFile_erase ( const struct XsString *  filename )

related

Deletes a file with name filename.

Parameters

filename

Name of the file to delete

Returns

XRV_OK if the file was erased, an error otherwise

Definition at line 400 of file xsfile.c.

XsFile_error()

XsResultValue XsFile_error ( struct XsFile const *  thisPtr )

related

Returns

Returns XRV_ERROR if the error flag for the file has been set, XRV_OK otherwise

Definition at line 540 of file xsfile.c.

XsFile_exists()

int XsFile_exists ( const struct XsString *  filename )

related

Checks if the file exists (can be accessed)

Parameters

filename

Name of the file to check for existence

Returns

0 if the file exists, another value otherwise

Definition at line 306 of file xsfile.c.

XsFile_flush()

XsResultValue XsFile_flush ( struct XsFile *  thisPtr )

related

Writes unwritten data to the file.

Returns

XRV_OK if the flushing was successful, an XRV_ERROR otherwise

Definition at line 348 of file xsfile.c.

XsFile_fullPath()

XsResultValue XsFile_fullPath ( const struct XsString *  filename, struct XsString *  fullPath  )

related

Retrieves the full path for a filename.

Parameters

[in]	filename	The filename to expand
[out]	fullPath	The filename with a fully expanded path is returned in this parameter. This parameter must be allocated by the caller.

Returns

XRV_OK if the fullpath could be retrieved, XRV_NULLPTR if fullPath is NULL, XRV_ERROR otherwise

Definition at line 551 of file xsfile.c.

XsFile_getc()

int XsFile_getc ( struct XsFile *  thisPtr )

related

Gets and returns the next byte from a file.

Returns

The byte read from the stream or -1 in case of failure

Definition at line 452 of file xsfile.c.

XsFile_getline()

XsResultValue XsFile_getline ( struct XsFile *  thisPtr, struct XsString *  line  )

related

Reads a full line from the file.

Parameters

line	The result of the read

Returns

XRV_OK if a line could be read

Definition at line 586 of file xsfile.c.

XsFile_gets()

char * XsFile_gets ( struct XsFile *  thisPtr, char *  str, int  num  )

related

Reads characters from this file and stores them into str until (num-1) characters have been read or either a newline or the end-of-file is reached, whichever happens first.

Parameters

str	The destination for the read string
num	The size of the destination buffer

Returns

A pointer to the read string on success, NULL on failure

Definition at line 473 of file xsfile.c.

XsFile_handle()

FILE * XsFile_handle ( struct XsFile *  thisPtr )

related

Returns

The file handle

Definition at line 611 of file xsfile.c.

XsFile_isOpen()

int XsFile_isOpen ( const struct XsFile *  thisPtr )

related

Checks if a file is open.

Returns

0 if a file is open, another value otherwise

Definition at line 296 of file xsfile.c.

XsFile_open()

XsResultValue XsFile_open ( struct XsFile *  thisPtr, const struct XsString *  filename, int  readOnly  )

related

Opens an existing binary file with name filename.

Parameters

filename	name of the file to open
readOnly	passing 0 will open the file "r+b" (read/update), any other value will create it using "rb" (read)

Returns

XRV_OK if the file was opened, an error otherwise

Definition at line 184 of file xsfile.c.

XsFile_openText()

XsResultValue XsFile_openText ( struct XsFile *  thisPtr, const struct XsString *  filename, int  readOnly  )

related

Opens an existing binary file with name filename.

Parameters

filename	name of the file to open
readOnly	passing 0 will open the file "r+t" (read/update), any other value will create it using "rt" (read)

Returns

XRV_OK if the file was opened, an error otherwise

Definition at line 217 of file xsfile.c.

XsFile_putc()

XsResultValue XsFile_putc ( struct XsFile *  thisPtr, int  character  )

related

Writes a character to the file.

Parameters

character

The caharacter to write

Returns

XRV_OK on success, XRV_ERROR otehrwise

Definition at line 462 of file xsfile.c.

XsFile_puts()

XsResultValue XsFile_puts ( struct XsFile *  thisPtr, const char *  str  )

related

Writes a null terminated c-string to the file.

Parameters

str	The null terminated c-string to write

Returns

XRV_OK on success, XRV_ERROR otehrwise

Definition at line 483 of file xsfile.c.

XsFile_read()

XsFilePos XsFile_read ( struct XsFile *  thisPtr, void *  destination, XsFilePos  size, XsFilePos  count  )

related

Reads a number of elements from a file.

Parameters

destination	Buffer to store the read data in
size	Size of each individual element to read
count	Number of elements to read

Returns

Total number of elements successfully read

Definition at line 431 of file xsfile.c.

XsFile_reopen()

XsResultValue XsFile_reopen ( struct XsFile *  thisPtr, const struct XsString *  filename, const struct XsString *  mode  )

related

Reopens a file.

Parameters

filename	Name of the file to open after the current one has been closed
mode	Mode to reopen the file with

Returns

0 if a file is open, another value otherwise

Definition at line 272 of file xsfile.c.

XsFile_resize()

XsResultValue XsFile_resize ( struct XsFile *  thisPtr, XsFilePos  fileSize  )

related

Resizes the file to fileSize bytes.

Parameters

fileSize

The new size for the file

Returns

XRV_OK if the file was resized, an error otherwise

Definition at line 368 of file xsfile.c.

XsFile_seek()

XsResultValue XsFile_seek ( struct XsFile *  thisPtr, XsFilePos  offset  )

related

Moves the current file position relative to the start of the file.

Parameters

offset

Position in the file to move to, relative to the start of the file

Returns

XRV_OK if the seek was successful

Definition at line 493 of file xsfile.c.

XsFile_seek_r()

XsResultValue XsFile_seek_r ( struct XsFile *  thisPtr, XsFilePos  offset  )

related

Moves the current file position relative to the end of the file.

Parameters

offset

Position in the file to move to, relative to the end of the file

Returns

XRV_OK if the seek was successful

Definition at line 507 of file xsfile.c.

XsFile_tell()

XsFilePos XsFile_tell ( struct XsFile const *  thisPtr )

related

Returns the current position in the file.

Returns

Current position in the current file

Definition at line 520 of file xsfile.c.

XsFile_truncate()

XsResultValue XsFile_truncate ( struct XsFile *  thisPtr, XsFilePos  fileSize  )

related

Reduces the file to a maximum size of fileSize bytes.

Parameters

fileSize

The new size for the file

Returns

XRV_OK if the file was truncated, an error otherwise

Definition at line 358 of file xsfile.c.

XsFile_write()

XsFilePos XsFile_write ( struct XsFile *  thisPtr, const void *  source, XsFilePos  size, XsFilePos  count  )

related

Writes a number of elements to a file.

Parameters

source	Buffer that contains the elements to be written
size	Size of each individual element to write
count	Number of elements to write

Returns

Total number of elements successfully written

Definition at line 443 of file xsfile.c.

XsFilterProfile_empty()

int XsFilterProfile_empty

(

XsFilterProfile const *

thisPtr

)

Checks if the filter profile is empty.

Returns

true if the filter profile is empty

Definition at line 89 of file xsfilterprofile.c.

XsFilterProfile_swap()

void XsFilterProfile_swap	(	XsFilterProfile *	a,
		XsFilterProfile *	b
	)

Swap the contents of a with b.

Parameters

a	Pointer to the first XsFilterProfile
b	Pointer to the second XsFilterProfile

Definition at line 98 of file xsfilterprofile.c.

XsFilterProfile_toString()

void XsFilterProfile_toString	(	XsFilterProfile const *	thisPtr,
		XsString *	out
	)

Converts filter profile version and type information to string.

Parameters

out	The string to write to

Definition at line 79 of file xsfilterprofile.c.

XsFingerData_construct()

void XsFingerData_construct ( struct XsFingerData *  thisPtr )

related

Initialize an XsFingerData object.

Definition at line 133 of file xsglovedata.c.

XsFingerData_copy()

void XsFingerData_copy ( struct XsFingerData *  copy, struct XsFingerData const *  src  )

related

Copy the contents of an XsFingerData object.

Parameters

copy	The destination of the copy operation
src	The object to copy from

Definition at line 155 of file xsglovedata.c.

XsFingerData_destruct()

void XsFingerData_destruct ( struct XsFingerData *  thisPtr )

related

Destruct an XsFingerData object.

Definition at line 144 of file xsglovedata.c.

XsFingerData_swap()

void XsFingerData_swap ( struct XsFingerData *  lhs, struct XsFingerData *  rhs  )

related

Swap the contents of two XsGloveData objects.

Parameters

lhs	The left hand side object of the swap
rhs	The right hand side object of the swap

Definition at line 170 of file xsglovedata.c.

XsGloveData_construct()

void XsGloveData_construct ( struct XsGloveData *  thisPtr )

related

Initialize an XsGloveData object.

Definition at line 81 of file xsglovedata.c.

XsGloveData_copy()

void XsGloveData_copy ( struct XsGloveData *  copy, struct XsGloveData const *  src  )

related

Copy the contents of an XsGloveData object.

Parameters

copy	The destination of the copy operation
src	The object to copy from

Definition at line 103 of file xsglovedata.c.

XsGloveData_destruct()

void XsGloveData_destruct ( struct XsGloveData *  thisPtr )

related

Destruct an XsGloveData object.

Definition at line 92 of file xsglovedata.c.

XsGloveData_swap()

void XsGloveData_swap ( struct XsGloveData *  lhs, struct XsGloveData *  rhs  )

related

Swap the contents of two XsGloveData objects.

Parameters

lhs	The left hand side object of the swap
rhs	The right hand side object of the swap

Definition at line 119 of file xsglovedata.c.

xsl4ToXsl()

XsSyncLine xsl4ToXsl

(

SyncLineMk4

mk4Line

)

Translate an SyncLineMk4 into a generic XsSyncLine.

Definition at line 72 of file synclinemk4.c.

xslgmtToXsl()

XsSyncLine xslgmtToXsl

(

SyncLineGmt

mk4Line

)

Translate an SyncLineGmt into a generic XsSyncLine.

Definition at line 72 of file synclinegmt.c.

xslToXsl4()

SyncLineMk4 xslToXsl4

(

XsSyncLine

line

)

Translate an XsSyncLine into a Mk4-specififc SyncLineMk4.

Definition at line 100 of file synclinemk4.c.

xslToXslgmt()

SyncLineGmt xslToXslgmt

(

XsSyncLine

line

)

Translate an XsSyncLine into a SyncLineGmt.

Definition at line 104 of file synclinegmt.c.

XsMath_asinClamped()

XSMATHINLINE XsReal XsMath_asinClamped

(

const XsReal

x

)

Returns asin(x) for -1 < x < 1.

Definition at line 189 of file xsmath.h.

XsMath_deg2rad()

XSMATHINLINE XsReal XsMath_deg2rad

(

XsReal

degrees

)

Convert degrees to radians.

Definition at line 203 of file xsmath.h.

XsMath_doubleToInt64()

XSMATHINLINE2 int64_t XsMath_doubleToInt64

(

double

d

)

Returns d integer converted from a double precision floating point value.

Definition at line 293 of file xsmath.h.

XsMath_doubleToLong()

XSMATHINLINE2 int32_t XsMath_doubleToLong

(

double

d

)

Returns d integer converted from a double precision floating point value.

Definition at line 286 of file xsmath.h.

XsMath_floatToInt64()

XSMATHINLINE2 int64_t XsMath_floatToInt64

(

float

d

)

Returns d integer converted from a single precision floating point value.

Definition at line 279 of file xsmath.h.

XsMath_floatToLong()

XSMATHINLINE2 int32_t XsMath_floatToLong

(

float

d

)

Returns d integer converted from a single precision floating point value.

Definition at line 272 of file xsmath.h.

XsMath_isFinite()

XSMATHINLINE2 int XsMath_isFinite

(

XsReal

x

)

Returns non-zero if x is finite.

Definition at line 231 of file xsmath.h.

XsMath_pow2()

XSMATHINLINE XsReal XsMath_pow2

(

XsReal

a

)

Returns a to the power of 2.

Definition at line 210 of file xsmath.h.

XsMath_pow3()

XSMATHINLINE XsReal XsMath_pow3

(

XsReal

a

)

Returns a to the power of 3.

Definition at line 217 of file xsmath.h.

XsMath_pow5()

XSMATHINLINE XsReal XsMath_pow5

(

XsReal

a

)

Returns a to the power of 5.

Definition at line 224 of file xsmath.h.

XsMath_rad2deg()

XSMATHINLINE XsReal XsMath_rad2deg

(

XsReal

radians

)

Convert radians to degrees.

Definition at line 196 of file xsmath.h.

XsMatrix3x3_assign()

void XsMatrix3x3_assign ( XsMatrix3x3 *  thisPtr, const XsReal *  src, XsSize  srcStride  )

related

Init the XsMatrix3x3 and copy the data from src into the matrix if src is not null.

Definition at line 83 of file xsmatrix3x3.c.

XsMatrix3x3_construct()

void XsMatrix3x3_construct ( XsMatrix3x3 *  thisPtr )

related

Init the XsMatrix3x3.

Definition at line 77 of file xsmatrix3x3.c.

XsMatrix3x3_copy()

void XsMatrix3x3_copy ( XsMatrix *  copy, XsMatrix3x3 const *  src  )

related

Copy the contents of the XsMatrix3x3 to copy.

Definition at line 110 of file xsmatrix3x3.c.

XsMatrix3x3_destruct()

void XsMatrix3x3_destruct ( XsMatrix3x3 *  thisPtr )

related

Frees the Matrix3x3.

Definition at line 101 of file xsmatrix3x3.c.

XsMatrix_assign()

void XsMatrix_assign ( XsMatrix *  thisPtr, XsSize  rows, XsSize  cols, XsSize  stride, const XsReal *  src, XsSize  srcStride  )

related

Init the XsMatrix and copy the data from src into the matrix if src is not null.

Definition at line 146 of file xsmatrix.c.

XsMatrix_construct()

void XsMatrix_construct ( XsMatrix *  thisPtr, XsSize  rows, XsSize  cols, XsSize  stride, const XsReal *  src, XsSize  srcStride  )

related

Init the XsMatrix and copy the data from src into the matrix if src is not null.

Definition at line 100 of file xsmatrix.c.

XsMatrix_copy()

void XsMatrix_copy ( XsMatrix *  copy, XsMatrix const *  src  )

related

Copy the contents of copy to the XsMatrix.

Definition at line 240 of file xsmatrix.c.

XsMatrix_destruct()

void XsMatrix_destruct ( XsMatrix *  thisPtr )

related

Clear the XsMatrix and release allocated resources.

Definition at line 218 of file xsmatrix.c.

XsMatrix_dimensionsMatch()

int XsMatrix_dimensionsMatch ( const XsMatrix *  thisPtr, XsSize  rows, XsSize  columns  )

related

Returns not zero if the dimensions of the XsMatrix are equal to rows and columns.

Definition at line 312 of file xsmatrix.c.

XsMatrix_empty()

int XsMatrix_empty ( const XsMatrix *  thisPtr )

related

Returns not zero if the matrix contains no values.

Definition at line 268 of file xsmatrix.c.

XsMatrix_fromQuaternion()

void XsMatrix_fromQuaternion ( XsMatrix *  thisPtr, const XsQuaternion *  quat  )

related

Get an orientation matrix representation of the quaternion.

Definition at line 318 of file xsmatrix.c.

XsMatrix_multiplyScalar()

void XsMatrix_multiplyScalar ( const XsMatrix *  thisPtr, XsReal  scalar, XsMatrix *  dest  )

related

Multiplies all values in this XsMatrix by scalar.

Parameters

scalar	: Value to multiply by
dest	: The XsMatrix to store the result in

Definition at line 277 of file xsmatrix.c.

XsMatrix_offset()

XsSize XsMatrix_offset ( const XsMatrix *  thisPtr, XsSize  row, XsSize  column  )

related

Returns the offset in the data for accessing the value at row and column.

Parameters

row	The row of the value
column	The column of the value

Returns

The offset of the requested item in the internal buffer

Definition at line 293 of file xsmatrix.c.

XsMatrix_ref()

void XsMatrix_ref ( XsMatrix *  thisPtr, XsSize  rows, XsSize  cols, XsSize  stride, XsReal *  buffer, XsDataFlags  flags  )

related

Construct the XsMatrix as a reference to data in buffer.

Definition at line 87 of file xsmatrix.c.

XsMatrix_setValue()

void XsMatrix_setValue ( XsMatrix *  thisPtr, XsSize  row, XsSize  column, XsReal  value  )

related

Sets the data value at row and column.

Definition at line 306 of file xsmatrix.c.

XsMatrix_setZero()

void XsMatrix_setZero ( XsMatrix *  thisPtr )

related

Set all the values in the matrix to zero.

Definition at line 248 of file xsmatrix.c.

XsMatrix_swap()

void XsMatrix_swap ( XsMatrix *  a, XsMatrix *  b  )

related

Swap the contents of a and b.

This function swaps the internal buffers so no actual data is moved around. This won't work for unmanaged data such as fixed size matrices (XsMatrix3x3)

Parameters

a	Object whose contents will be placed in b
b	Object whose contents will be placed in a

Definition at line 362 of file xsmatrix.c.

XsMatrix_value()

XsReal XsMatrix_value ( const XsMatrix *  thisPtr, XsSize  row, XsSize  column  )

related

Returns the data value at row and column.

Definition at line 299 of file xsmatrix.c.

XsMessage_assign()

void XsMessage_assign	(	XsMessage *	thisPtr,
		XsSize	dataSize
	)

This function reinitializes the XsMessage object and reserves dataSize bytes for data.

Parameters

[in]

dataSize

the expected size of the message payload

Definition at line 377 of file xsmessage.c.

XsMessage_cdataAtOffset()

static const uint8_t* XsMessage_cdataAtOffset ( XsMessage const *  thisPtr, XsSize  offset  )

inlinestatic

return the const data at offset offset

Definition at line 223 of file xsmessage.c.

XsMessage_compare()

int XsMessage_compare	(	XsMessage const *	a,
		XsMessage const *	b
	)

Compare the contents of the messages a and b, returning non-0 if they are different.

Parameters

a	the first XsMessage pointer to compare
b	the first XsMessage pointer to compare

Returns

0 if the messages are equal

Definition at line 1269 of file xsmessage.c.

XsMessage_computeChecksum()

uint8_t XsMessage_computeChecksum

(

XsMessage const *

thisPtr

)

Computes the checksum for the message.

Returns

the computed checksum

Definition at line 974 of file xsmessage.c.

XsMessage_constData()

const uint8_t* XsMessage_constData	(	XsMessage const *	thisPtr,
		XsSize	offset
	)

This function returns a const pointer to the offset in the data of the message in thisptr.

\param offset the offset of the data to be returned

\returns a pointer to the data at offset \a offset

Definition at line 436 of file xsmessage.c.

XsMessage_construct()

void XsMessage_construct

(

XsMessage *

thisPtr

)

This function initializes the XsMessage object.

Definition at line 347 of file xsmessage.c.

XsMessage_constructSized()

void XsMessage_constructSized	(	XsMessage *	thisPtr,
		XsSize	dataSize
	)

This function initializes the XsMessage object and reserves dataSize bytes for data.

\param[in] dataSize the expected size of the message payload

Definition at line 311 of file xsmessage.c.

XsMessage_copy()

void XsMessage_copy	(	XsMessage *	copy,
		XsMessage const *	thisPtr
	)

This function copies from thisPtr to copy.

Parameters

copy	the object to copy to

Definition at line 406 of file xsmessage.c.

XsMessage_copyConstruct()

void XsMessage_copyConstruct	(	XsMessage *	thisPtr,
		XsMessage const *	src
	)

Construct an XsMessage as a copy of XsMessage src.

Parameters

src	The source message to be copied

Definition at line 355 of file xsmessage.c.

XsMessage_dataAtOffset()

static uint8_t* XsMessage_dataAtOffset ( XsMessage *  thisPtr, XsSize  offset  )

inlinestatic

Get the buffer at offset offset.

Definition at line 209 of file xsmessage.c.

XsMessage_dataSize()

XsSize XsMessage_dataSize

(

XsMessage const *

thisPtr

)

This function returns the datasize of the message in thisptr.

Returns

the size of the message payload

Definition at line 416 of file xsmessage.c.

XsMessage_deleteData()

void XsMessage_deleteData	(	XsMessage *	thisPtr,
		XsSize	count,
		XsSize	offset
	)

Remove count bytes of data from the message at offset.

\param count the number of bytes to remove
\param offset the offset at which to remove the bytes

Definition at line 1189 of file xsmessage.c.

XsMessage_destruct()

void XsMessage_destruct

(

XsMessage *

thisPtr

)

This function clears the data in the message.

Definition at line 397 of file xsmessage.c.

XsMessage_empty()

int XsMessage_empty

(

XsMessage const *

thisPtr

)

Test if this message is empty.

Returns

non-zero if this message is empty, zero otherwise

Definition at line 1020 of file xsmessage.c.

XsMessage_ensureDataSize()

static void XsMessage_ensureDataSize ( XsMessage *  thisPtr, XsSize  offset, XsSize  sizeofValue  )

inlinestatic

Make sure the data buffer is large enough to hold a new data item of sizeofValue.

Definition at line 229 of file xsmessage.c.

XsMessage_getConstHeader()

const XsMessageHeader* XsMessage_getConstHeader

(

XsMessage const *

thisPtr

)

Returns

a const pointer to the message header

Definition at line 1012 of file xsmessage.c.

XsMessage_getDataBuffer()

const uint8_t* XsMessage_getDataBuffer	(	XsMessage const *	thisPtr,
		XsSize	offset
	)

Returns a const pointer to the data buffer of the message.

\param offset the offset in the payload at which to read data


\returns a const pointer to the data buffer of the message

Definition at line 595 of file xsmessage.c.

XsMessage_getDataByte()

uint8_t XsMessage_getDataByte	(	XsMessage const *	thisPtr,
		XsSize	offset
	)

Returns the byte value at offset in the data of the message.

\param offset the offset in the payload at which to read data

\returns the byte at offset \a offset in the message payload

Definition at line 481 of file xsmessage.c.

XsMessage_getDataDouble()

double XsMessage_getDataDouble	(	XsMessage const *	thisPtr,
		XsSize	offset
	)

Returns the double at offset in the data of the message.

Parameters

offset

the offset in the payload at which to read data

Returns

the double precision floating point value at offset offset in the message payload

Definition at line 543 of file xsmessage.c.

XsMessage_getDataF1220()

double XsMessage_getDataF1220	(	XsMessage const *	thisPtr,
		XsSize	offset
	)

Returns the F12.20 value at offset in the data of the message.

Parameters

offset

the offset in the payload at which to read data

Returns

the 12.20 fixed point value at offset offset in the message payload

Definition at line 555 of file xsmessage.c.

XsMessage_getDataFloat()

float XsMessage_getDataFloat	(	XsMessage const *	thisPtr,
		XsSize	offset
	)

Returns the float value at offset in the data of the message.

\param offset the offset in the payload at which to read data

\returns the single precision float value at offset \a offset in the message payload

Definition at line 531 of file xsmessage.c.

XsMessage_getDataFP1632()

double XsMessage_getDataFP1632	(	XsMessage const *	thisPtr,
		XsSize	offset
	)

Returns the F16.32 value at offset in the data of the message.

Parameters

offset

the offset in the payload at which to read data

Returns

the 16.32 fixed point value at offset offset in the message payload

Definition at line 571 of file xsmessage.c.

XsMessage_getDataFPValuesById()

void XsMessage_getDataFPValuesById	(	XsMessage const *	thisPtr,
		XsDataIdentifier	dataIdentifier,
		double *	dest,
		XsSize	offset,
		XsSize	numValues
	)

Return current data values as double, conversion depends on outputSetting.

\param dest destination array
\param dataIdentifier Data identifier containing data precision
\param offset offset in the data buffer from where to start reading.
\param numValues number of values to be read

Definition at line 798 of file xsmessage.c.

XsMessage_getDataLong()

uint32_t XsMessage_getDataLong	(	XsMessage const *	thisPtr,
		XsSize	offset
	)

Returns the long value at offset in the data of the message.

\param offset the offset in the payload at which to read data

\returns the 32-bit integer value at offset \a offset in the message payload

Definition at line 505 of file xsmessage.c.

XsMessage_getDataLongLong()

uint64_t XsMessage_getDataLongLong	(	XsMessage const *	thisPtr,
		XsSize	offset
	)

Returns the long value at offset in the data of the message.

\param offset the offset in the payload at which to read data

\returns the 64-bit integer value at offset \a offset in the message payload

Definition at line 518 of file xsmessage.c.

XsMessage_getDataRealValuesById()

void XsMessage_getDataRealValuesById	(	XsMessage const *	thisPtr,
		XsDataIdentifier	dataIdentifier,
		XsReal *	dest,
		XsSize	offset,
		XsSize	numValues
	)

Return current data values as XsReal, conversion is done automatically based on data identifier.

This function behaves exactly like XsMessage_getDataFPValuesById, with the exception that it expects an XsReal array.

\param dest destination array
\param dataIdentifier Data identifier containing data precision
\param offset offset in the data buffer from where to start reading.
\param numValues number of values to be read

Definition at line 881 of file xsmessage.c.

XsMessage_getDataShort()

uint16_t XsMessage_getDataShort	(	XsMessage const *	thisPtr,
		XsSize	offset
	)

Returns the short value at offset in the data of the message.

\param offset the offset in the payload at which to read data

\returns the 16-bit integer value at offset \a offset in the message payload

Definition at line 492 of file xsmessage.c.

XsMessage_getEndianCorrectData()

void XsMessage_getEndianCorrectData	(	XsMessage const *	thisPtr,
		void *	value,
		XsSize	size,
		XsSize	offset
	)

Get data of size size at offset, and put it byteswapped into value.

Parameters

value	The value to write to
size	The size of the message
offset	The offset of the message

Definition at line 286 of file xsmessage.c.

XsMessage_getFPValueSize()

uint8_t XsMessage_getFPValueSize ( XsDataIdentifier  id )

related

Returns the byte size of id if the format is a floating point format.

Parameters

id	: The XsDataIdentifier to query

Returns

Returns the byte size of XsDataIdentifier id

Definition at line 744 of file xsmessage.c.

XsMessage_getHeader()

XsMessageHeader* XsMessage_getHeader

(

XsMessage *

thisPtr

)

Returns a pointer to the message header for this message.

Returns

a pointer to the header for this XsMessage

Definition at line 1006 of file xsmessage.c.

XsMessage_getMessageStart()

const uint8_t* XsMessage_getMessageStart

(

XsMessage const *

thisPtr

)

This function returns a const pointer to the header of the message in thisptr.

\returns a pointer to the start of the message

Definition at line 448 of file xsmessage.c.

XsMessage_getTotalMessageSize()

XsSize XsMessage_getTotalMessageSize

(

XsMessage const *

thisPtr

)

Return the length of the message buffer.

The function returns the total size of the message, including the checksum. This
is in effect the number of bytes that would be transferred if the message were to
be sent over a communications channel.

\returns the total message size

Definition at line 461 of file xsmessage.c.

XsMessage_insertData()

void XsMessage_insertData	(	XsMessage *	thisPtr,
		XsSize	count,
		XsSize	offset
	)

Create count bytes of empty space at offset in this message.

\param count the number of bytes to reserve
\param offset the offset at which to allocate the space

Definition at line 1125 of file xsmessage.c.

XsMessage_isChecksumOk()

int XsMessage_isChecksumOk

(

XsMessage const *

thisPtr

)

Returns non-zero if the checksum inside the message is correct for the message, zero otherwise.

Returns

true (non-zero) if the checksum inside the message is correct, false (zero) otherwise

Definition at line 997 of file xsmessage.c.

XsMessage_load()

void XsMessage_load	(	XsMessage *	thisPtr,
		XsSize	msgSize,
		unsigned char const *	src
	)

This function initializes the XsMessage object and reserves msgSize bytes for data, it then copies in the data from src.

Parameters

msgSize	the size of the data pointed to by src
src	the data to load the message from

Note

This is a constructor! Previous contents will be overwritten without first freeing them!

Definition at line 388 of file xsmessage.c.

XsMessage_recomputeChecksum()

void XsMessage_recomputeChecksum

(

XsMessage *

thisPtr

)

Update the checksum for the message.

Definition at line 988 of file xsmessage.c.

XsMessage_resizeData()

void XsMessage_resizeData	(	XsMessage *	thisPtr,
		XsSize	newSize
	)

Resize the buffer of message to newSize bytes.

\param newSize the new size of the message payload buffer

Definition at line 1032 of file xsmessage.c.

XsMessage_setBusId()

void XsMessage_setBusId	(	XsMessage *	thisPtr,
		uint8_t	busId
	)

Set the bus id for this message to busId.

\param busId the bus identifier

\sa XS_BID_BROADCAST XS_BID_MASTER XS_BID_MT

Definition at line 1088 of file xsmessage.c.

XsMessage_setDataBuffer()

void XsMessage_setDataBuffer	(	XsMessage *	thisPtr,
		const uint8_t *	buffer,
		XsSize	size,
		XsSize	offset
	)

Puts size number of bytes from buffer into the message at offset.

Remarks

The buffersize of will be increased if buffer is too large

Parameters

buffer	the buffer to copy
size	the size of the buffer
offset	the offset at which to copy the data

Definition at line 731 of file xsmessage.c.

XsMessage_setDataByte()

void XsMessage_setDataByte	(	XsMessage *	thisPtr,
		uint8_t	value,
		XsSize	offset
	)

Set the byte at offset in the message to value.

\param value the 8-bit value to set
\param offset the offset in the message payload at which to write the data

Definition at line 605 of file xsmessage.c.

XsMessage_setDataDouble()

void XsMessage_setDataDouble	(	XsMessage *	thisPtr,
		double	value,
		XsSize	offset
	)

Sets the double at offset in the message to value.

\param value the double precision floating point value to set
\param offset the offset in the message payload at which to write the data

Definition at line 656 of file xsmessage.c.

XsMessage_setDataF1220()

void XsMessage_setDataF1220	(	XsMessage *	thisPtr,
		double	value,
		XsSize	offset
	)

Sets the F12.20 at offset in the message to value.

\param value the 12.20 fixed point value to set
\param offset the offset in the message payload at which to write the data

Definition at line 666 of file xsmessage.c.

XsMessage_setDataFloat()

void XsMessage_setDataFloat	(	XsMessage *	thisPtr,
		float	value,
		XsSize	offset
	)

Sets the float at offset in the message to value.

\param value the single precision floating point value to set
\param offset the offset in the message payload at which to write the data

Definition at line 646 of file xsmessage.c.

XsMessage_setDataFP1632()

void XsMessage_setDataFP1632	(	XsMessage *	thisPtr,
		double	value,
		XsSize	offset
	)

Sets the F16.32 at offset in the message to value.

\param value the 16.32 fixed point value to set
\param offset the offset in the message payload at which to write the data

Definition at line 682 of file xsmessage.c.

XsMessage_setDataFPValuesById()

void XsMessage_setDataFPValuesById	(	XsMessage *	thisPtr,
		XsDataIdentifier	dataIdentifier,
		double const *	data,
		XsSize	offset,
		XsSize	numValues
	)

Write a number of floating/fixed point values into to the data buffer, conversion depends on outputSettings.

\param dataIdentifier Data Identifier
\param data         The data array to be written to the buffer.
\param offset Offset in the data buffer from where to start writing.
\param numValues number of values to be written

Definition at line 839 of file xsmessage.c.

XsMessage_setDataLong()

void XsMessage_setDataLong	(	XsMessage *	thisPtr,
		uint32_t	value,
		XsSize	offset
	)

Sets the long at offset in the message to value.

\param value the 32-bit value to set
\param offset the offset in the message payload at which to write the data

Definition at line 625 of file xsmessage.c.

XsMessage_setDataLongLong()

void XsMessage_setDataLongLong	(	XsMessage *	thisPtr,
		uint64_t	value,
		XsSize	offset
	)

Sets the long at offset in the message to value.

\param value the 64-bit value to set
\param offset the offset in the message payload at which to write the data

Definition at line 635 of file xsmessage.c.

XsMessage_setDataRealValuesById()

void XsMessage_setDataRealValuesById	(	XsMessage *	thisPtr,
		XsDataIdentifier	dataIdentifier,
		XsReal const *	data,
		XsSize	offset,
		XsSize	numValues
	)

Write a number of floating/fixed point values into to the data buffer, conversion depends on data identifier.

\param dataIdentifier Data Identifier
\param data         The data array to be written to the buffer.
\param offset Offset in the data buffer from where to start writing.
\param numValues number of values to be written

Definition at line 938 of file xsmessage.c.

XsMessage_setDataShort()

void XsMessage_setDataShort	(	XsMessage *	thisPtr,
		uint16_t	value,
		XsSize	offset
	)

Sets the short at offset in the message to value.

\param value the 16-bit value to set
\param offset the offset in the message payload at which to write the data

Definition at line 615 of file xsmessage.c.

XsMessage_setEndianCorrectData()

void XsMessage_setEndianCorrectData	(	XsMessage *	thisPtr,
		void const *	value,
		XsSize	size,
		XsSize	offset
	)

Set value value of size size byteswapped at offset.

Parameters

value	The value to write to
size	The size of the message
offset	The offset of the message

Definition at line 297 of file xsmessage.c.

XsMessage_setMessageId()

void XsMessage_setMessageId	(	XsMessage *	thisPtr,
		enum XsXbusMessageId	msgId
	)

Set the message id for this message to msgId.

\param msgId the message identifier

Definition at line 1106 of file xsmessage.c.

XsMessage_swap()

void XsMessage_swap	(	XsMessage *	a,
		XsMessage *	b
	)

Swap the contents of a and b.

\details This function swaps the internal buffers so no actual data is moved around.
A result is that it won't work for unmanaged data such as fixed size vectors

\param a the object to receive \a b's contents
\param b the object to receive \a a's contents

Definition at line 1248 of file xsmessage.c.

XsMessage_toHexString()

void XsMessage_toHexString	(	XsMessage const *	thisPtr,
		XsSize	maxBytes,
		XsString *	resultValue
	)

Return a string containing the first maxBytes bytes of the message in hex format.

Parameters

maxBytes	the maximum number of bytes to include in the string, when set to 0, the full message will be used
resultValue	the resulting string

Definition at line 1278 of file xsmessage.c.

XsMessage_updateChecksumWithValue()

static void XsMessage_updateChecksumWithValue ( XsMessage *  thisPtr, const void *  value, XsSize  sizeofValue, XsSize  offset  )

inlinestatic

Update the message checksum with the passed value.

Definition at line 236 of file xsmessage.c.

xsNameThisThread()

void XSTYPES_DLL_API xsNameThisThread

(

const char *

threadName

)

Set the name of the current thread to threadName.

Set the name of the current thread

Parameters

threadName

The new name of the thread, ignored if empty or null

Note

If threadName is longer than 15 characters, it will be compressed

Definition at line 140 of file xsthread.c.

XsPortInfo_bluetoothAddress()

const char * XsPortInfo_bluetoothAddress ( const struct XsPortInfo *  thisPtr )

related

Returns the bluetooth address.

Definition at line 160 of file xsportinfo.c.

XsPortInfo_clear()

void XsPortInfo_clear ( XsPortInfo *  thisPtr )

related

Initializes the object to the empty state.

Definition at line 80 of file xsportinfo.c.

XsPortInfo_empty()

int XsPortInfo_empty ( const struct XsPortInfo *  thisPtr )

related

Returns true if the XsPortInfo object is empty.

Definition at line 92 of file xsportinfo.c.

XsPortInfo_isBluetooth()

int XsPortInfo_isBluetooth ( const struct XsPortInfo *  thisPtr )

related

Returns true if this port info object contains a bluetooth device.

Definition at line 133 of file xsportinfo.c.

XsPortInfo_isNetwork()

int XsPortInfo_isNetwork ( const struct XsPortInfo *  thisPtr )

related

Returns true if this port info object contains a network device.

Definition at line 142 of file xsportinfo.c.

XsPortInfo_isUsb()

int XsPortInfo_isUsb ( const struct XsPortInfo *  thisPtr )

related

Returns true if this port info object contains a USB device.

Definition at line 120 of file xsportinfo.c.

XsPortInfo_networkServiceName()

const char * XsPortInfo_networkServiceName ( const struct XsPortInfo *  thisPtr )

related

Returns the network service name of this port.

Definition at line 151 of file xsportinfo.c.

XsPortInfo_portNumber()

int XsPortInfo_portNumber ( const struct XsPortInfo *  thisPtr )

related

The port number.

Returns

Returns the port number

Note

Available on Windows only

Definition at line 102 of file xsportinfo.c.

XsPortInfo_swap()

void XsPortInfo_swap	(	struct XsPortInfo *	a,
		struct XsPortInfo *	b
	)

Swap the contents of a with those of b.

Parameters

a	swap this with b
b	swap this with a

Definition at line 201 of file xsportinfo.c.

XsPortInfo_usbAddress()

int XsPortInfo_usbAddress ( const struct XsPortInfo *  thisPtr )

related

The usb address.

Returns

Returns the usb address

Note

Available on Linux only

Definition at line 186 of file xsportinfo.c.

XsPortInfo_usbBus()

int XsPortInfo_usbBus ( const struct XsPortInfo *  thisPtr )

related

The usb bus.

Returns

Returns the Usb bus number

Note

Available on Linux only

Definition at line 170 of file xsportinfo.c.

XsQuaternion_compare()

int XsQuaternion_compare ( XsQuaternion const *  thisPtr, XsQuaternion const *  other, XsReal  tolerance  )

related

Returns non-zero if the values at thisPtr and other are within tolerance of each other.

Definition at line 323 of file xsquaternion.c.

XsQuaternion_copy()

void XsQuaternion_copy ( XsQuaternion *  copy, XsQuaternion const *  src  )

related

Copies the contents of thisPtr into copy.

Definition at line 291 of file xsquaternion.c.

XsQuaternion_destruct()

void XsQuaternion_destruct ( XsQuaternion *  thisPtr )

related

Sets the contents to 0, which is an invalid XsQuaternion.

The normal destructor does not call this function, it is intended for explicit signalling of errors

Definition at line 85 of file xsquaternion.c.

XsQuaternion_dotProduct()

XsReal XsQuaternion_dotProduct ( XsQuaternion const *  thisPtr, XsQuaternion const *  other  )

related

Returns the dot product of the thisPtr with other.

Definition at line 343 of file xsquaternion.c.

XsQuaternion_empty()

int XsQuaternion_empty ( const XsQuaternion *  thisPtr )

related

Test if this is a null object.

Definition at line 94 of file xsquaternion.c.

XsQuaternion_equal()

int XsQuaternion_equal ( XsQuaternion const *  a, XsQuaternion const *  b  )

related

returns non-zero if a and b are numerically equal

Definition at line 301 of file xsquaternion.c.

XsQuaternion_fromEulerAngles()

void XsQuaternion_fromEulerAngles ( XsQuaternion *  thisPtr, const XsEuler *  src  )

related

Create a quaternion representation from euler angles.

Definition at line 146 of file xsquaternion.c.

XsQuaternion_fromRotationMatrix()

void XsQuaternion_fromRotationMatrix ( XsQuaternion *  thisPtr, const XsMatrix *  ori  )

related

Create a quaternion representation of orientation matrix ori.

The matrix ori is interpreted as an orthonormal orientation matrix, which is translated into a quaternion representation. If ori is not a 3x3 matrix, a null-quaternion is returned.

Parameters

ori	The source orientation matrix

Definition at line 176 of file xsquaternion.c.

XsQuaternion_identity()

const XsQuaternion * XsQuaternion_identity ( void  )

related

Returns an XsQuaternion that represents the identity quaternion.

Definition at line 250 of file xsquaternion.c.

XsQuaternion_inverse()

void XsQuaternion_inverse ( const XsQuaternion *  thisPtr, XsQuaternion *  dest  )

related

Compute the inverse/conjugate of this quaternion.

Where q = a + bi + cj + dk, this function will return a - bi - cj - dk in dest.

Parameters

dest	The object to write to

Definition at line 113 of file xsquaternion.c.

XsQuaternion_invert()

void XsQuaternion_invert ( XsQuaternion *  thisPtr )

related

Invert this quaternion.

Where q = a + bi + cj + dk, this function will replace it with a - bi - cj - dk.

Definition at line 103 of file xsquaternion.c.

XsQuaternion_multiply()

void XsQuaternion_multiply ( const XsQuaternion *  left, const XsQuaternion *  right, XsQuaternion *  dest  )

related

Multiply left quaternion with right quaternion and put the result in dest. The parameters may point to the same XsQuaternion(s).

Definition at line 257 of file xsquaternion.c.

XsQuaternion_normalize()

XsReal XsQuaternion_normalize ( XsQuaternion *  thisPtr )

related

Normalize this quaternion.

Definition at line 140 of file xsquaternion.c.

XsQuaternion_normalized()

XsReal XsQuaternion_normalized ( const XsQuaternion *  thisPtr, XsQuaternion *  dest  )

related

Create a normalized version of this quaternion.

Definition at line 123 of file xsquaternion.c.

XsQuaternion_swap()

void XsQuaternion_swap ( XsQuaternion *  a, XsQuaternion *  b  )

related

Swap the contents of a and b.

Definition at line 277 of file xsquaternion.c.

XsRange_contains()

int XsRange_contains ( const XsRange *  thisPtr, int  i  )

related

Test if the range contains the given value i.

Definition at line 99 of file xsrange.c.

XsRange_count()

int XsRange_count ( const XsRange *  thisPtr )

related

Get the number of values in the range.

Note

The range is inclusive [first, last] instead of [first, last>. So count [1, 2] = 2

Returns

The number of values in the range (inclusive)

Definition at line 80 of file xsrange.c.

XsRange_empty()

int XsRange_empty ( const XsRange *  thisPtr )

related

Test if the range is empty.

An empty range has a last element that is lower than its first element.

Returns

true if the range is empty, false otherwise

Definition at line 115 of file xsrange.c.

XsRange_interval()

int XsRange_interval ( const XsRange *  thisPtr )

related

Get the number of values in the range.

Note

The range is exclusive [first, last> instead of [first, last]. So interval [1, 2] = 1

Returns

The number of values in the range (exclusive)

Definition at line 91 of file xsrange.c.

XsRange_setRange()

void XsRange_setRange ( XsRange *  thisPtr, int  f, int  l  )

related

Set a new range.

Definition at line 105 of file xsrange.c.

XsRejectReason_toString()

const char* XsRejectReason_toString

(

XsRejectReason

r

)

Convert the XsRejectReason to a human readable string.

Definition at line 73 of file xsrejectreason.c.

XsResultValue_toString()

const char* XsResultValue_toString

(

XsResultValue

result

)

Retrieve a character string corresponding to the given result code.

Retrieve a string corresponding to the given result code.

Parameters

result

The result code to convert

Returns

A static string describing the result code

Note

In the Python interface this function is called XsResultValueToString

In C/C++ do NOT delete the returned char* as it points to static memory.

Definition at line 78 of file xsresultvalue.c.

XsRssi_max()

XSTYPES_DLL_API int XsRssi_max

(

void

)

The maximum RSSI value.

Returns

the maximum RSSI value

Definition at line 77 of file xsrssi.c.

XsRssi_unbiased()

XSTYPES_DLL_API int XsRssi_unbiased

(

int

raw

)

Returns the raw RSSI value transformed into a usable (unbiased) number.

Actual rssi is calculated by raw + XS_RSSI_MAX, where raw is a negative number.

Parameters

raw	The RSSI value as reported by the device.

Returns

The unbiased RSSI value.

Definition at line 95 of file xsrssi.c.

XsRssi_unknown()

XSTYPES_DLL_API int XsRssi_unknown

(

void

)

The RSSI value that was reserved for when the RSSI is unknown.

Returns

he RSSI 'unknown' value

Definition at line 85 of file xsrssi.c.

XsSdiData_construct()

void XsSdiData_construct ( XsSdiData *  thisPtr, const XsReal *  orientationIncrement, const XsReal *  velocityIncrement  )

related

Initialize an XsSdiData object with the optional arguments.

Parameters

orientationIncrement	The orientation increment to initialize the object with, may be 0
velocityIncrement	The velocity increment to initialize the object with, may be 0

Definition at line 82 of file xssdidata.c.

XsSdiData_destruct()

void XsSdiData_destruct ( XsSdiData *  thisPtr )

related

Destruct the object, makes the fields invalid.

Definition at line 103 of file xssdidata.c.

XsSimpleVersion_compare()

int XsSimpleVersion_compare	(	XsSimpleVersion const *	a,
		XsSimpleVersion const *	b
	)

Compare two XsSimpleVersion objects.

Parameters

a	The left hand side of the comparison
b	The right hand side of the comparison

Returns

0 when they're equal

Definition at line 110 of file xssimpleversion.c.

XsSimpleVersion_empty()

int XsSimpleVersion_empty ( const XsSimpleVersion *  thisPtr )

related

Test if this is a null-version.

Definition at line 87 of file xssimpleversion.c.

XsSimpleVersion_osVersion()

void XsSimpleVersion_osVersion

(

XsSimpleVersion *

thisPtr

)

Platdorm independent request of the OS version. Results are cached and of course platform dependent.

Definition at line 120 of file xssimpleversion.c.

XsSimpleVersion_swap()

void XsSimpleVersion_swap	(	struct XsSimpleVersion *	a,
		struct XsSimpleVersion *	b
	)

Swap the contents of a with those of b.

Definition at line 98 of file xssimpleversion.c.

XsSnapshot_construct()

void XsSnapshot_construct ( XsSnapshot *  thisPtr )

related

Construct an XsSnapshot object.

Definition at line 78 of file xssnapshot.c.

XsSnapshot_destruct()

void XsSnapshot_destruct ( XsSnapshot *  thisPtr )

related

Destruct an XsSnapshot object.

Definition at line 86 of file xssnapshot.c.

XsSyncSetting_compare()

int XsSyncSetting_compare	(	const struct XsSyncSetting *	a,
		const struct XsSyncSetting *	b
	)

Compares a with b.

Returns

0 if a equals b, negative value if a < b, positive value if a > b

Parameters

[in]	a	Sync setting a
[in]	b	Sync setting b

Definition at line 122 of file xssyncsetting.c.

XsSyncSetting_isInput()

int XsSyncSetting_isInput

(

const XsSyncSetting *

thisPtr

)

Returns whether the selected line is configured as an input line.

Definition at line 74 of file xssyncsetting.c.

XsSyncSetting_isOutput()

int XsSyncSetting_isOutput

(

const XsSyncSetting *

thisPtr

)

Returns whether the selected line is configured as an output line.

Definition at line 92 of file xssyncsetting.c.

XsSyncSetting_swap()

void XsSyncSetting_swap	(	XsSyncSetting *	a,
		XsSyncSetting *	b
	)

Swap the contents of a with b.

Definition at line 109 of file xssyncsetting.c.

XsTime_getDateAsString()

void XsTime_getDateAsString	(	char *	dest,
		const struct tm *	date
	)

Retrieves the date as string representation The format is YYYYMMDD so 25 dec 2010 is stored as an array dest[9] = { '2', '0', '1', '0', '1', '2', '2', '5' }.

Parameters

dest	: A pointer to an array of at least (!) 8 bytes
date	: If date is non-zero this date is converted, otherwise the current date is retrieved and used)

Definition at line 260 of file xstime.c.

XsTime_getDateAsWString()

void XsTime_getDateAsWString	(	wchar_t *	dest,
		const struct tm *	date
	)

Retrieves the date as wstring representation The format is YYYYMMDD so 25 dec 2010 is stored as an array dest[8] = {'2', '0', '1', '0', '1', '2', '2', '5' }.

Parameters

dest	: A pointer to an array of at least (!) 8 wchars
date	: If date is non-zero this date is converted, otherwise the current date is retrieved and used)

Definition at line 312 of file xstime.c.

XsTime_getDateTime()

int64_t XsTime_getDateTime

(

struct tm *

date

)

Retrieves the date and time (platform-independent)

Parameters

date	: if non-zero the local (!) date and time is stored in the tm struct this parameter points to

Returns

The UTC date and time as seconds since 1970

Definition at line 234 of file xstime.c.

XsTime_getTimeAsString()

void XsTime_getTimeAsString	(	char *	dest,
		const struct tm *	date
	)

Retrieves the time as binary The format is HHMMSShh (where H is hour and 'h' is hundredths) so 14:25:01.23 is stored as an array dest[8] = { '1', '4', '2', '5', '0', '1', '2', '3'}.

Parameters

dest	: A pointer to an array of at least (!) 8 bytes
date	: If date is non-zero this date is converted, otherwise the current date is retrieved and used)

Note

(for now hundreths are set to 0)

Definition at line 292 of file xstime.c.

XsTime_getTimeAsWString()

void XsTime_getTimeAsWString	(	wchar_t *	dest,
		const struct tm *	date
	)

Retrieves the time as binary The format is HHMMSShh (where H is hour and 'h' is hundredths) so 14:25:01.23 is stored as an array dest[8] = { '1', '4', '2', '5', '0', '1', '2', '3'}.

Parameters

dest	: A pointer to an array of at least (!) 8 wchars
date	: If date is non-zero this date is converted, otherwise the current date is retrieved and used)

Note

(for now hundreths are set to 0)

Definition at line 334 of file xstime.c.

XsTime_getTimeOfDay()

uint32_t XsTime_getTimeOfDay	(	struct tm *	date_,
		time_t *	secs_
	)

The function returns the current time of day in ms since midnight.

Parameters

date_	When not 0, the corresponding current date is put in here.
secs_	When not 0, the full timestamp in seconds since the epoch is put in here.

Returns

The number of milliseconds that have passed since midnight.

Definition at line 134 of file xstime.c.

XsTime_initializeTime()

void XsTime_initializeTime

(

)

Stabilize the clock.

XS_INTERNAL

Repeatedly calls XsTime_timeStampNow for 16-32 ms to stabilize the clock. Initializes the local to UTC conversion parameters.

Definition at line 424 of file xstime.c.

XsTime_localToUtc()

int64_t XsTime_localToUtc

(

)

Returns the conversion value from local time to UTC time in ms.

Returns

The conversion value from local time to UTC time in ms

Note

Make sure to call XsTime_initializeTime() before calling this function as well as when changing time zones.

Definition at line 468 of file xstime.c.

XsTime_msleep()

void XsTime_msleep

(

uint32_t

ms

)

Make the current thread sleep for at least ms milliseconds.

A platform independent sleep routine to sleep for at least ms milliseconds.

Parameters

ms	The number of milliseconds to sleep

See also

XsTime_udelay

Definition at line 353 of file xstime.c.

XsTime_timeStampNow()

int64_t XsTime_timeStampNow

(

XsTimeStamp *

now

)

Returns the current time in ms since the epoch (Jan 1st 1970)

Parameters

now	Pointer to XsTimeStamp container for the returned value, may be 0

Returns

The current time in ms since the epoch (Jan 1st 1970) as a 64-bit integer

Definition at line 401 of file xstime.c.

XsTime_udelay()

void XsTime_udelay

(

uint64_t

us

)

Delays the current thread for at least us microseconds.

A platform independent delay routine to sleep for at least us microseconds.

Parameters

us	The number of microseconds to delay

See also

XsTime_msleep

Definition at line 369 of file xstime.c.

XsTime_utcToLocal()

int64_t XsTime_utcToLocal

(

)

Returns the conversion value from UTC time to local time in ms.

Returns

The conversion value from UTC time to local time in ms

Note

Make sure to call XsTime_initializeTime() before calling this function as well as when changing time zones.

Definition at line 459 of file xstime.c.

XsTimeInfo_currentLocalTime()

void XsTimeInfo_currentLocalTime ( struct XsTimeInfo *  thisPtr )

related

Returns the current local time.

Definition at line 93 of file xstimeinfo.c.

XsTimeInfo_currentTime()

void XsTimeInfo_currentTime ( struct XsTimeInfo *  thisPtr )

related

Returns the current UTC time.

Definition at line 79 of file xstimeinfo.c.

XsTimeInfo_makeUtc()

void XsTimeInfo_makeUtc ( struct XsTimeInfo *  thisPtr )

related

Removes the local time information, making the object pure UTC.

Definition at line 108 of file xstimeinfo.c.

XsTimeStamp_fromTimeInfo()

int64_t XsTimeStamp_fromTimeInfo ( struct XsTimeStamp *  thisPtr, const struct XsTimeInfo *  info  )

related

Creates a (UTC) XsTimeStamp from an XsTimeInfo object.

Parameters

info	The time info object to convert

Returns

The converted UTC time in ms since the epoch (Jan 1st 1970)

Definition at line 154 of file xstimestamp.c.

XsTimeStamp_hourPart()

int32_t XsTimeStamp_hourPart ( const XsTimeStamp *  thisPtr )

related

Returns the hours part of the time (in the range 0-23)

Definition at line 125 of file xstimestamp.c.

XsTimeStamp_localToUtcTime()

void XsTimeStamp_localToUtcTime	(	struct XsTimeStamp const *	thisPtr,
		struct XsTimeStamp *	utc
	)

Convert the supplied time from (assumed) local time to UTC, using the system's local time zone knowledge.

Parameters

utc	The returned, converted time

Note

Make sure to call XsTime_initializeTime() before calling this function as well as when changing time zones.

Definition at line 282 of file xstimestamp.c.

XsTimeStamp_localToUtcTime2()

void XsTimeStamp_localToUtcTime2	(	struct XsTimeStamp const *	thisPtr,
		struct XsTimeStamp *	utc,
		const struct XsTimeInfo *	info
	)

Convert the supplied time from (assumed) local time to UTC, using the offset in info.

Parameters

utc	The returned, converted time
info	The XsTimeInfo object containing the time offset to apply

Definition at line 300 of file xstimestamp.c.

XsTimeStamp_localToUtcTime_ms()

void XsTimeStamp_localToUtcTime_ms	(	struct XsTimeStamp const *	thisPtr,
		struct XsTimeStamp *	utc,
		int64_t	utcOffset
	)

Convert the supplied time from (assumed) local time to UTC, using the offset in utcOffset.

Parameters

utc	The returned, converted time
utcOffset	The time offset to apply as defined in XsTimeInfo::m_utcOffset but in ms instead of minutes

Definition at line 318 of file xstimestamp.c.

XsTimeStamp_maxValue()

int64_t XsTimeStamp_maxValue ( void  )

related

Returns the maximum value of an XsTimeStamp.

Definition at line 144 of file xstimestamp.c.

XsTimeStamp_milliSecondPart()

int32_t XsTimeStamp_milliSecondPart ( const XsTimeStamp *  thisPtr )

related

Returns the millisecond part of the time (in the range 0-999)

Definition at line 104 of file xstimestamp.c.

XsTimeStamp_minutePart()

int32_t XsTimeStamp_minutePart ( const XsTimeStamp *  thisPtr )

related

Returns the minutes part of the time (in the range 0-59)

Definition at line 118 of file xstimestamp.c.

XsTimeStamp_now()

int64_t XsTimeStamp_now ( XsTimeStamp *  dest )

related

Returns the current time in ms since the epoch (Jan 1st 1970)

See also

XsTime_timeStampNow

Parameters

dest	The object to write the time to, may be 0 in which case only the return value is generated.

Returns

The current time in ms since the epoch (Jan 1st 1970)

Definition at line 136 of file xstimestamp.c.

XsTimeStamp_secondPart()

int32_t XsTimeStamp_secondPart ( const XsTimeStamp *  thisPtr )

related

Returns the seconds part of the time (in the range 0-59)

Definition at line 111 of file xstimestamp.c.

XsTimeStamp_secondTime()

int64_t XsTimeStamp_secondTime ( const XsTimeStamp *  thisPtr )

related

Returns the number of seconds elapsed since the epoch as stored in the XsTimeStamp.

Definition at line 97 of file xstimestamp.c.

XsTimeStamp_setMilliSecondTime()

void XsTimeStamp_setMilliSecondTime ( XsTimeStamp *  thisPtr, int64_t  t  )

related

Set the stored time to miliseconds.

Definition at line 84 of file xstimestamp.c.

XsTimeStamp_timeOfDay()

double XsTimeStamp_timeOfDay ( const XsTimeStamp *  thisPtr )

related

Get the time of day component of the stored timestamp in seconds as a double precision value.

Definition at line 90 of file xstimestamp.c.

XsTimeStamp_toString()

void XsTimeStamp_toString ( struct XsTimeStamp const *  thisPtr, struct XsString *  result  )

related

Converts the timestamp into an XsString object in format YYYY/MM/DD hh:mm:ss.nnn.

Parameters

result

The XsString object to write the conversion result to

Definition at line 241 of file xstimestamp.c.

XsTimeStamp_toTimeInfo()

void XsTimeStamp_toTimeInfo ( struct XsTimeStamp const *  thisPtr, struct XsTimeInfo *  info  )

related

Converts the timestamp into an XsTimeInfo object.

Parameters

info	The XsTimeInfo time object to write the conversion result to

Definition at line 191 of file xstimestamp.c.

XsTimeStamp_utcToLocalTime()

void XsTimeStamp_utcToLocalTime	(	struct XsTimeStamp const *	thisPtr,
		struct XsTimeStamp *	local
	)

Convert the supplied time from (assumed) UTC to local time, using the system's local time zone knowledge.

Parameters

local

The returned, converted time

Note

Make sure to call XsTime_initializeTime() before calling this function as well as when changing time zones.

Definition at line 273 of file xstimestamp.c.

XsTimeStamp_utcToLocalTime2()

void XsTimeStamp_utcToLocalTime2	(	struct XsTimeStamp const *	thisPtr,
		struct XsTimeStamp *	local,
		const struct XsTimeInfo *	info
	)

Convert the supplied time from (assumed) UTC to local time, using the offset in info.

Parameters

local	The returned, converted time
info	The XsTimeInfo object containing the time offset to apply

Definition at line 291 of file xstimestamp.c.

XsTimeStamp_utcToLocalTime_ms()

void XsTimeStamp_utcToLocalTime_ms	(	struct XsTimeStamp const *	thisPtr,
		struct XsTimeStamp *	local,
		int64_t	utcOffset
	)

Convert the supplied time from (assumed) UTC to local time, using the offset in utcOffset.

Parameters

local	The returned, converted time
utcOffset	The time offset to apply as defined in XsTimeInfo::m_utcOffset but in ms instead of minutes

Definition at line 309 of file xstimestamp.c.

XsTriggerIndicationData_destruct()

void XsTriggerIndicationData_destruct

(

XsTriggerIndicationData *

thisPtr

)

Destroy the XsTriggerIndicationData object.

Definition at line 73 of file xstriggerindicationdata.c.

XsTriggerIndicationData_valid()

int XsTriggerIndicationData_valid

(

const XsTriggerIndicationData *

thisPtr

)

Returns true if the object is valid (line and polarity may not be 0)

Definition at line 79 of file xstriggerindicationdata.c.

XsUsbHubInfo_assign()

void XsUsbHubInfo_assign	(	XsUsbHubInfo *	thisPtr,
		XsHubIdentifier	hub
	)

Assign a new hub identifier to the XsUsbHubInfo.

Parameters

[in]

hub

the hub identifier

Definition at line 114 of file xsusbhubinfo.c.

XsUsbHubInfo_construct()

void XsUsbHubInfo_construct	(	XsUsbHubInfo *	thisPtr,
		XsHubIdentifier	hub
	)

Initialize the XsUsbHubInfo with hub.

\param[in] hub the hub identifier to initialize with

Definition at line 88 of file xsusbhubinfo.c.

XsUsbHubInfo_copy()

void XsUsbHubInfo_copy	(	XsUsbHubInfo *	copy,
		XsUsbHubInfo const *	src
	)

Copy the contents of the XsUsbHubInfo to copy.

Definition at line 122 of file xsusbhubinfo.c.

XsUsbHubInfo_destruct()

void XsUsbHubInfo_destruct

(

XsUsbHubInfo *

thisPtr

)

Destroy the XsUsbHubInfo.

Definition at line 102 of file xsusbhubinfo.c.

XsUsbHubInfo_parentPathMatches()

int XsUsbHubInfo_parentPathMatches	(	const XsUsbHubInfo *	left,
		const XsUsbHubInfo *	right
	)

Returns true if the two hub info objects share the same device path.

\param[in] left the left hand side to compare
\param[in] right the right hand side to compare

\returns non-zero if the two hubs share the same parent

Definition at line 148 of file xsusbhubinfo.c.

XsUsbHubInfo_swap()

void XsUsbHubInfo_swap	(	XsUsbHubInfo *	thisPtr,
		XsUsbHubInfo *	thatPtr
	)

Swap the two XsUsbHubInfo items.

Definition at line 130 of file xsusbhubinfo.c.

XsUtcTime_currentTime()

void XsUtcTime_currentTime ( struct XsTimeInfo *  thisPtr )

related

Returns the current time in UTC date time format.

Definition at line 74 of file xsutctime.c.

XsVector3_assign()

void XsVector3_assign ( XsVector3 *  thisPtr, const XsReal *  src  )

related

Init the XsVector3 and copy the data from src into the vector if src is not null.

Definition at line 85 of file xsvector3.c.

XsVector3_construct()

void XsVector3_construct ( XsVector3 *  thisPtr, const XsReal *  src  )

related

Init the XsVector3 and copy the data from src into the vector if src is not null.

Definition at line 77 of file xsvector3.c.

XsVector3_copy()

void XsVector3_copy ( XsVector *  copy, XsVector3 const *  src  )

related

Copy the contents of the XsVector3 to copy.

Definition at line 99 of file xsvector3.c.

XsVector3_destruct()

void XsVector3_destruct ( XsVector3 *  thisPtr )

related

Frees the XsVector3.

Definition at line 91 of file xsvector3.c.

XsVector_angularVelocityFromQuaternion()

void XsVector_angularVelocityFromQuaternion ( XsVector *  thisPtr, XsReal  deltaT, const XsQuaternion *  quat  )

related

Get an effective angular velocity from the quaternion, which must represent a delta angle.

Parameters

deltaT	The length of the time interval over which quat was integrated in seconds
quat	The orientation increment to convert to an angular velocity

Returns

A vector containing the effective angular velocity in radians around each axis.

Definition at line 266 of file xsvector.c.

XsVector_assign()

void XsVector_assign ( XsVector *  thisPtr, XsSize  sz, const XsReal *  src  )

related

Initialize the XsVector using sz number of items from src.

Parameters

sz	The desired size of the vector
src	0 or a pointer to a buffer containing sz items to copy into the XsVector

Definition at line 123 of file xsvector.c.

XsVector_cartesianLength()

XsReal XsVector_cartesianLength ( const XsVector *  thisPtr )

related

Compute and return the cartesian length.

Returns

The cartesian length (square root of the dot product) of the vector

Definition at line 204 of file xsvector.c.

XsVector_compare()

int XsVector_compare ( const struct XsVector *  thisPtr, const struct XsVector *  thatPtr, XsReal  epsilon  )

related

Returns non-zero if the two vectors are equal within epsilon.

Parameters

thatPtr	the vector to compare with
epsilon	the maximum difference between values

Returns

non-zero when the vectors are equal within epsilon

Definition at line 322 of file xsvector.c.

XsVector_construct()

void XsVector_construct ( XsVector *  thisPtr, XsSize  sz, const XsReal *  src  )

related

Initialize the XsVector using sz number of items from src.

Definition at line 100 of file xsvector.c.

XsVector_copy()

void XsVector_copy ( XsVector *  copy, XsVector const *  src  )

related

Copy the contents of the XsVector to copy.

Definition at line 175 of file xsvector.c.

XsVector_destruct()

void XsVector_destruct ( XsVector *  thisPtr )

related

Release and clear the contents of the vector.

Definition at line 155 of file xsvector.c.

XsVector_dotProduct()

XsReal XsVector_dotProduct ( const XsVector *  a, const XsVector *  b  )

related

Compute and return the dot product of XsVectors a and b.

Definition at line 189 of file xsvector.c.

XsVector_empty()

int XsVector_empty ( const XsVector *  thisPtr )

related

Returns a non-zero value if the XsVector does not contain any values.

Definition at line 246 of file xsvector.c.

XsVector_equal()

int XsVector_equal ( const struct XsVector *  a, const struct XsVector *  b  )

related

Returns non-zero when the two vectors are identical.

Parameters

a	Vector to compare against b
b	Vector to compare against a

Returns

non-zero when the vectors are identical

Definition at line 300 of file xsvector.c.

XsVector_fill()

void XsVector_fill ( struct XsVector *  thisPtr, XsReal  value  )

related

Sets all elements of the XsVector to value.

Definition at line 238 of file xsvector.c.

XsVector_multiplyScalar()

void XsVector_multiplyScalar ( const XsVector *  thisPtr, XsReal  scalar, XsVector *  dest  )

related

Multiplies all values in this XsVector by scalar and puts the result in XsVector dest.

Definition at line 252 of file xsvector.c.

XsVector_normalize()

void XsVector_normalize ( XsVector *  thisPtr )

related

Normalize the vector.

Definition at line 212 of file xsvector.c.

XsVector_ref()

void XsVector_ref ( XsVector *  thisPtr, XsSize  sz, XsReal *  buffer, XsDataFlags  flags  )

related

Initialize the XsVector to refer to the supplied buffer.

Definition at line 91 of file xsvector.c.

XsVector_setZero()

void XsVector_setZero ( XsVector *  thisPtr )

related

Sets all elements of the XsVector to 0.

Definition at line 226 of file xsvector.c.

XsVector_swap()

void XsVector_swap ( XsVector *  a, XsVector *  b  )

related

Swap the contents of a and b.

This function swaps the internal buffers so no actual data is moved around. For unmanaged data an elementwise swap is done, but only if the vectors are the same size.

Parameters

a	Object whose contents will be placed in b
b	Object whose contents will be placed in a

Definition at line 286 of file xsvector.c.

XsVersion_empty()

int XsVersion_empty ( const XsVersion *  thisPtr )

related

Test if this is a null-version.

Definition at line 78 of file xsversion.c.

XsVersion_fromSimpleVersion()

void XsVersion_fromSimpleVersion ( XsVersion *  thisPtr, const XsSimpleVersion *  simpleVersion  )

related

Create a XsVersion a XsSimpleVersion, simpleVersion.

Definition at line 160 of file xsversion.c.

XsVersion_fromString()

void XsVersion_fromString ( XsVersion *  thisPtr, const XsString *  version  )

related

Set the version to the values in the string.

Definition at line 118 of file xsversion.c.

XsVersion_toSimpleString()

void XsVersion_toSimpleString ( const XsVersion *  thisPtr, XsString *  version  )

related

Get a string with the version expressed in a readable format.

Definition at line 107 of file xsversion.c.

XsVersion_toSimpleVersion()

void XsVersion_toSimpleVersion ( const XsVersion *  thisPtr, XsSimpleVersion *  simpleVersion  )

related

Create a XsSimpleVersion (version) from a XsVersion.

Definition at line 173 of file xsversion.c.

XsVersion_toString()

void XsVersion_toString ( const XsVersion *  thisPtr, XsString *  version  )

related

Get a string with the version expressed in a readable format.

Definition at line 84 of file xsversion.c.

Variable Documentation

XsHubIdentifier

XsHubIdentifier

On Windows:

typedef int XsHubIdentifier;

On non-windows: \code
typedef const char* XsHubIdentifier;
\endcode

Definition at line 73 of file xsusbhubinfo.h.

XsMath_deg2radValue

XSMATHCONST XsReal XsMath_deg2radValue = 0.017453292519943295769236907684886

Value to convert degrees to radians by multiplication.

Definition at line 147 of file xsmath.h.

XsMath_denormalized

XSMATHCONST XsReal XsMath_denormalized = 1e-307

Value that represents the subnormal number in floating point wizardry.

Definition at line 139 of file xsmath.h.

XsMath_e

XSMATHCONST XsReal XsMath_e = 2.7182818284590452353602874713527

The value e.

Definition at line 116 of file xsmath.h.

XsMath_epsilon

XSMATHCONST XsReal XsMath_epsilon = 2.2204460492503131e-016

A value related to the precision of floating point arithmetic (2.2204460492503131e-016)

Definition at line 135 of file xsmath.h.

XsMath_four

XSMATHCONST XsReal XsMath_four = 4.0

4

Definition at line 164 of file xsmath.h.

XsMath_halfPi

XSMATHCONST XsReal XsMath_halfPi = 1.5707963267948966192313216916397514420985846996875529104874

pi/2

Definition at line 171 of file xsmath.h.

XsMath_hugeValue

XSMATHCONST XsReal XsMath_hugeValue = 1.0e+16

A convincingly large number.

Definition at line 122 of file xsmath.h.

XsMath_infinity

XSMATHCONST XsReal XsMath_infinity = DBL_MAX

infinity value

Definition at line 184 of file xsmath.h.

XsMath_minusHalfPi

XSMATHCONST XsReal XsMath_minusHalfPi = -1.5707963267948966192313216916397514420985846996875529104874

-pi/2

Definition at line 169 of file xsmath.h.

XsMath_minusOne

XSMATHCONST XsReal XsMath_minusOne = -1.0

-1.0

Definition at line 160 of file xsmath.h.

XsMath_minusPt5

XSMATHCONST XsReal XsMath_minusPt5 = -0.5

-0.5

Definition at line 156 of file xsmath.h.

XsMath_minusTwo

XSMATHCONST XsReal XsMath_minusTwo = -2.0

-2

Definition at line 166 of file xsmath.h.

XsMath_one

XSMATHCONST XsReal XsMath_one = 1.0

1.0

Definition at line 158 of file xsmath.h.

XsMath_pi

XSMATHCONST XsReal XsMath_pi = 3.1415926535897932384626433832795028841971693993751058209749

The value pi.

Definition at line 118 of file xsmath.h.

XsMath_pt25

XSMATHCONST XsReal XsMath_pt25 = 0.25

0.25

Definition at line 152 of file xsmath.h.

XsMath_pt5

XSMATHCONST XsReal XsMath_pt5 = 0.5

0.5

Definition at line 154 of file xsmath.h.

XsMath_rad2degValue

XSMATHCONST XsReal XsMath_rad2degValue = 57.295779513082320876798154814105

Value to convert radians to degrees by multiplication.

Definition at line 145 of file xsmath.h.

XsMath_sqrt2

XSMATHCONST XsReal XsMath_sqrt2 = 1.4142135623730950488016887242097

sqrt(2)

Definition at line 175 of file xsmath.h.

XsMath_sqrtDenormalized

XSMATHCONST XsReal XsMath_sqrtDenormalized = 3.1622776601683793319988935444327e-154

Square root of XsMath_denormalized.

Definition at line 141 of file xsmath.h.

XsMath_sqrtEpsilon

XSMATHCONST XsReal XsMath_sqrtEpsilon = 1.4901161193847656e-008

Square root of XsMath_epsilon.

Definition at line 137 of file xsmath.h.

XsMath_sqrtHalf

XSMATHCONST XsReal XsMath_sqrtHalf = 0.5 * 1.4142135623730950488016887242097

sqrt(0.5)

Definition at line 177 of file xsmath.h.

XsMath_tinyValue

XSMATHCONST XsReal XsMath_tinyValue = 1.0e-16

A really small value.

Definition at line 120 of file xsmath.h.

XsMath_two

XSMATHCONST XsReal XsMath_two = 2.0

2

Definition at line 162 of file xsmath.h.

XsMath_twoPi

XSMATHCONST XsReal XsMath_twoPi = 6.2831853071795864769252867665590057683943387987502116419498

2*pi

Definition at line 173 of file xsmath.h.

XsMath_zero

XSMATHCONST XsReal XsMath_zero = 0.0

0

Definition at line 150 of file xsmath.h.