Intimately entangled class with XsControl that allows broadcasting to all main devices. More...

#include <broadcastdevice.h>

Inheritance diagram for BroadcastDevice:

[legend]

Public Member Functions
bool	abortFlushing () override
	Abort the wireless flushing operation and finalize the recording. More...

XsTimeStamp	batteryLevelTime () override
	Requests the time the battery level was last updated. More...

	BroadcastDevice (XsControl *control)
	Constructor, sets up the XsControl reference. More...

std::vector< XsDevice * >	children () const
	Return the children of this device, actually returns the main devices in the XsControl object. More...

bool	closeLogFile () override
	Close the log file. More...

void	flushInputBuffers () override
	Clear the inbound data buffers of the device. More...

bool	gotoConfig () override
	Put the device in config mode. More...

bool	gotoMeasurement () override
	Put this device in measurement mode. More...

XsVersion	hardwareVersion () const override
	required function to prevent pure-virtualness More...

bool	initialize () override
	required function to prevent pure-virtualness More...

bool	isMeasuring () const override
	Returns true if the device is currently in a measuring state. More...

bool	isReadingFromFile () const override final
	Returns true if the device is reading from a file. More...

bool	isRecording () const override
	Returns true if the device is currently in a recording state. More...

bool	loadLogFile () override
	Load a complete logfile. More...

XsString	productCode () const override
	required function to prevent pure-virtualness More...

bool	requestBatteryLevel () override
	Request the battery level from the device. More...

bool	reset (bool skipDeviceIdCheck=false) override

bool	resetLogFileReadPosition () override
	Set the read position of the open log file to the start of the file. More...

bool	resetOrientation (XsResetMethod resetMethod) override
	Perform an orientation reset on the device using the given resetMethod. More...

bool	restoreFactoryDefaults () override
	Restore the device to its factory default settings. More...

bool	setGravityMagnitude (double mag) override
	Sets the 'Gravity Magnitude' of the device to the given value mag. More...

bool	setHeadingOffset (double offset) override
	Set the 'heading offset' setting of the device. More...

bool	setInitialPositionLLA (const XsVector &lla) override
	Sets the 'Latitude Longitude Altitude' setting of the device to the given vector. More...

bool	setLocationId (int id) override
	Set the location ID of the device. More...

bool	setNoRotation (uint16_t duration) override
	Set the no rotation period to duration. More...

bool	setObjectAlignment (const XsMatrix &matrix) override
	Sets the object alignment of a device to the given matrix. More...

bool	setOnboardFilterProfile (int profileType) override
	Sets the filter profile to use for computing orientations on the device. More...

bool	setOnboardFilterProfile (XsString const &profileType) override
	Sets the filter profile to use for computing orientations on the device. More...

void	setOptions (XsOption enable, XsOption disable) override
	Enable and disable processing options. More...

bool	setSerialBaudRate (XsBaudRate baudrate) override
	Change the serial baudrate to baudrate. More...

bool	setSyncSettings (const XsSyncSettingArray &s) override
	Set the synchronization settings of the device. More...

bool	setTransportMode (bool transportModeEnabled) override
	Enable or disable the transport mode for the device. More...

bool	setXdaFilterProfile (int profileType) override
	Sets the filter profile to use for computing orientations on the host PC. More...

bool	setXdaFilterProfile (XsString const &profileType) override
	Sets the filter profile to use for computing orientations on the host PC. More...

bool	startRecording () override
	Start recording data. More...

bool	stopRecording () override
	Stop recording data. More...

bool	storeFilterState () override
	Store orientation filter state in the device. More...

std::vector< int >	supportedUpdateRates (XsDataIdentifier dataType) const override
	required function to prevent pure-virtualness More...

bool	updateCachedDeviceInformation () override
	Updates the cached device information for all devices connected to this port. More...

	~BroadcastDevice () override
	Destructor, no special actions taken. More...

Public Member Functions inherited from XsDevice
virtual bool	abortLoadLogFile ()
	Aborts loading a logfile. More...

virtual double	accelerometerRange () const
	Returns the maximum official value of the accelerometers in the device. More...

virtual bool	acceptConnection ()
	Accept connections from the device on the parent/master device. More...

virtual XsAccessControlMode	accessControlMode () const
	Request the access control mode of the master device. More...

virtual void	addRef ()
	Increase reference count of XsDevice pointer XsDevice pointers stay alive while reference counter is not zero Also increases the reference count of each child device with 1. More...

virtual std::shared_ptr< ReplyObject >	addReplyObject (XsXbusMessageId messageId, uint8_t data)

virtual XsMatrix	alignmentRotationMatrix (XsAlignmentFrame frame) const
	Retrieve the alignment rotation matrix to rotate S to the chosen frame S'. More...

virtual XsQuaternion	alignmentRotationQuaternion (XsAlignmentFrame frame) const
	Retrieve the alignment rotation quaternion. More...

virtual XsResultValue	applyConfigFile (const XsString &filename)
	Loads a config file(.xsa) and configures the device accordingly. More...

virtual bool	areOptionsEnabled (XsOption options) const
	Returns true when all the specified processing options are enabled. More...

virtual XsFilterProfileArray	availableOnboardFilterProfiles () const
	Return the list of filter profiles available on the device. More...

virtual XsFilterProfileArray	availableXdaFilterProfiles () const
	Return the list of filter profiles available on the host PC. More...

virtual int	batteryLevel () const
	Get the batterylevel of this device The battery level is a value between 0 and 100 that indicates the remaining capacity as a percentage. Due to battery characteristics, this is not directly the remaining time, but just a rough indication. More...

virtual XsBaudRate	baudRate () const
	Get the baud rate (communication speed) of the serial port on which the given deviceId is connected. More...

virtual int	busId () const
	The bus ID for this device. More...

int	cacheSize () const
	Get the number of items currently in the slow data cache for the device. More...

virtual uint32_t	canConfiguration () const
	Returns the currently configured CAN configuration of the device. More...

virtual XsCanOutputConfigurationArray	canOutputConfiguration () const
	Returns the currently configured CAN output of the device. More...

virtual void XSNOEXPORT	checkDataCache ()

virtual int	childCount () const
	Return the number of child-devices this device has. For standalone devices this is always 0. More...

Communicator XSNOEXPORT *	communicator () const

virtual XsConnectivityState	connectivityState () const
	Returns the connectivity state of the device. More...

virtual XsResultValue	createConfigFile (const XsString &filename)
	Stores the current device configuration in a config file(.xsa) More...

XsResultValue	createLogFile (const XsString &filename)
	Create a log file for logging. More...

virtual XsDeviceIdArray	currentAccessControlList () const
	Request the access control list of the master device. More...

virtual int	dataLength () const
	Returns the length of the data in the legacy MTData packets that the device will send in measurement mode. More...

virtual void XSNOEXPORT	deinitializeSoftwareCalibration ()

virtual XsDevice *	deviceAtBusId (int busid)
	Return the device with bus ID busid. More...

const XsDevice *	deviceAtBusIdConst (int busid) const
	Return the device with bus ID busid. More...

virtual uint32_t	deviceBufferSize ()
	Request the size of the interal buffer. More...

XsDeviceConfiguration	deviceConfiguration () const
	Returns the device configuration. More...

virtual XsDeviceConfiguration const &XSNOEXPORT	deviceConfigurationConst () const

XsDeviceConfiguration &XSNOEXPORT	deviceConfigurationRef ()

XsDeviceId const &	deviceId () const
	Return the device ID of the device. More...

virtual bool	deviceIsDocked (XsDevice *dev) const
	Check if the device is docked. More...

virtual XsDeviceOptionFlag	deviceOptionFlags () const
	Returns the device option flags. More...

virtual XsResultValue	deviceParameter (XsDeviceParameter &parameter) const
	Retrieves the requested parameter's current value. More...

virtual XsDeviceState	deviceState () const
	Return the state of this device. More...

virtual bool	disableProtocol (XsProtocolType protocol)
	Disable a communication protocol previously added by XsDevice::enableProtocol. More...

virtual bool	disableRadio ()
	Disables the radio for this station, resetting all children to disconnected state. More...

virtual void	discardRetransmissions (int64_t firstNewPacketId)
	Tell XDA and the device that any data from before firstNewPacketId may be lossy. More...

virtual bool	enableProtocol (XsProtocolType protocol)
	Enable an additional communication protocol when reading messages. More...

virtual bool	enableRadio (int channel)
	Set the radio channel to use for wireless communication. More...

virtual XsErrorMode	errorMode () const
	Returns the error mode of the device. More...

virtual XsDevice *	findDevice (XsDeviceId const &deviceid) const
	Find the child device with deviceid. More...

XsDevice const *	findDeviceConst (XsDeviceId const &deviceid) const
	Find the child device with deviceid. More...

virtual XsVersion	firmwareVersion () const
	Return the firmware version. More...

virtual XsDataPacket	getDataPacketByIndex (XsSize index) const
	Return the cached data packet with index. More...

XsSize	getDataPacketCount () const
	Return the current size of the retained data packet cache. More...

virtual XsDevice *	getDeviceFromLocationId (uint16_t locId)
	Get the device given locId. More...

XsOption	getOptions () const
	Return the currently enabled options. More...

int64_t	getStartRecordingPacketId () const
	Return the ID of the first packet that should be recorded. More...

int64_t	getStopRecordingPacketId () const
	Return the ID of the last packet that should be recorded. More...

virtual XsVector	gnssLeverArm () const

XSNOEXPORT XSDEPRECATED XsGnssPlatform	gnssPlatform () const

virtual XsIntArray	gnssReceiverSettings () const
	Gets some GNSS receiver settings. More...

virtual double	gravityMagnitude () const
	Returns the 'Gravity Magnitude' of the device. More...

virtual double	gyroscopeRange () const
	Returns the maximum official value of the gyroscopes in the device. More...

virtual XSNOEXPORT void	handleDataPacket (const XsDataPacket &packet)

virtual XSNOEXPORT void	handleErrorMessage (const XsMessage &msg)

virtual XSNOEXPORT void	handleMasterIndication (const XsMessage &message)

virtual XSNOEXPORT void	handleMessage (const XsMessage &msg)

virtual XSNOEXPORT void	handleNonDataMessage (const XsMessage &msg)

virtual XSNOEXPORT void	handleUnavailableData (int64_t frameNumber)

virtual XSNOEXPORT void	handleWakeupMessage (const XsMessage &msg)

virtual XSNOEXPORT void	handleWarningMessage (const XsMessage &msg)

virtual bool	hasDataEnabled (XsDataIdentifier dataType) const
	Returns if the currently configured output contains dataType. More...

virtual bool	hasProcessedDataEnabled (XsDataIdentifier dataType) const
	Returns if the currently configured output contains dataType after processing on the host. More...

virtual double	headingOffset () const
	Return the 'heading offset' setting of the device. More...

virtual bool XSNOEXPORT	initializeSoftwareCalibration ()

virtual XsVector	initialPositionLLA () const
	Gets the 'Latitude Longitude Altitude' setting of the device. More...

virtual bool	isBlueToothEnabled () const
	Returns true if the device has its BlueTooth radio enabled. More...

virtual bool	isBusPowerEnabled () const
	Returns if the Xbus is powering its child devices or not. More...

virtual bool	isContainerDevice () const
	Returns true if this device can have child devices. More...

virtual bool	isFixedGravityEnabled () const
	Returns if the fixed gravity value should be used or if it should be computed from the initialPositionLLA value. More...

virtual bool	isInitialBiasUpdateEnabled () const
	Returns if the device does gyroscope bias estimation when switching to measurement mode. More...

bool	isInitialized () const
	Returns true when the device is initialized. More...

virtual bool	isInStringOutputMode () const
	Returns if the device is outputting data in string mode. More...

virtual bool	isInSyncStationMode ()

bool	isLoadLogFileInProgress () const
	Returns true if the file operation started by loadLogFile is still in progress. More...

bool	isMasterDevice () const
	Returns true if this is the master device (not a child of another device) More...

virtual bool	isMotionTracker () const
	Returns true if this is a motion tracker. More...

virtual bool	isOperational () const

virtual bool	isProtocolEnabled (XsProtocolType protocol) const

virtual bool	isRadioEnabled () const
	Returns if the radio is enabled. More...

bool	isStandaloneDevice () const
	Returns true if this is a standalone device (not a child of another device and not a container device) More...

virtual bool	isSyncMaster () const
	returns whether this device is in a master role regarding the device synchronization More...

virtual bool	isSyncSlave () const
	returns whether this device is in a slave role regarding the device synchronization More...

XsDataPacket	lastAvailableLiveData () const
	Return the last available live data. More...

virtual int16_t	lastKnownRssi () const
	Returns the last known RSSI value of the device. More...

XsResultValue	lastResult () const
	Get the result value of the last operation. More...

XsString	lastResultText () const
	Get the accompanying error text for the value returned by lastResult() It may provide situation-specific information instead. More...

virtual int	locationId () const
	Get the location ID of the device. More...

virtual DataLogger XSNOEXPORT *	logFileInterface (std::unique_ptr< xsens::Lock > &myLock) const

virtual XsString	logFileName () const
	Get the name of the log file the device is reading from. More...

XsFilePos	logFileReadPosition () const
	Get the current read position of the open log file. More...

XsFilePos	logFileSize () const
	Get the size of the log file the device is reading from. More...

virtual bool	makeOperational ()
	Sets the Awinda station to operational state. More...

virtual XsDevice *	master () const
	Return the master device of this device. More...

virtual int	maximumUpdateRate () const
	Get the maximum update rate for the device. More...

virtual XSNOEXPORT bool	messageLooksSane (const XsMessage &msg) const

xsens::GuardedMutex *	mutex () const

virtual XsMatrix	objectAlignment () const
	Returns the object alignment matrix of the device. More...

virtual XsFilterProfile	onboardFilterProfile () const
	Gets the filter profile in use by the device for computing orientations. More...

virtual XsOperationalMode	operationalMode () const
	Returns the operational mode. More...

bool	operator< (const XsDevice &dev) const
	Compare device ID with that of dev. More...

bool	operator< (XsDeviceId const &devId) const
	Compare device ID with devId. More...

bool	operator== (const XsDevice &dev) const
	Compare device ID with that of dev. More...

bool	operator== (XsDeviceId const &devId) const
	Compare device ID with devId. More...

virtual XsOutputConfigurationArray	outputConfiguration () const
	Returns the currently configured output of the device. More...

virtual int	packetErrorRate () const
	Returns the packet error rate for the for the device. More...

virtual XsIntArray	portConfiguration () const
	Get the current port configuration of a device. More...

virtual XsPortInfo	portInfo () const
	The port information of the connection. More...

virtual XsString	portName () const
	The port name of the connection. More...

virtual bool	powerDown ()
	Tell the device to power down completely. More...

virtual XSNOEXPORT void	prepareForTermination ()

virtual XsOutputConfigurationArray	processedOutputConfiguration () const
	Return the full output configuration including post processing outputs. More...

virtual int	radioChannel () const
	Returns the radio channel used for wireless communication. More...

virtual XSNOEXPORT bool	readEmtsAndDeviceConfiguration ()

virtual XsByteArray	readMetaDataFromLogFile ()
	Returns internal meta-data about the recording that some devices store in the mtb logfile. More...

int	recordingQueueLength () const
	Get the number of packets currently waiting in the slow data cache for the device based. More...

XsSize	refCounter () const
	The current reference counter. More...

virtual bool	reinitialize ()
	Reinitialize the XsDevice. More...

virtual bool	rejectConnection ()
	Reject connections from the device on the parent/master device. More...

virtual XsRejectReason	rejectReason () const
	Returns the reason why a device's connection was rejected. More...

virtual void	removeRef ()
	Decrease this XsDevices reference counter with 1. More...

virtual bool	reopenPort (bool gotoConfig, bool skipDeviceIdCheck=false)
	Reopens a port Uses rescan method to redetect a device. Also if USB descriptor has changed. More...

virtual bool	replaceFilterProfile (XsFilterProfile const &profileCurrent, XsFilterProfile const &profileNew)
	Replaces profileCurrent by profileNew in the device. More...

virtual bool	representativeMotionState ()
	Retrieves the active representative motion state for the In-Run Compass Calibration. More...

virtual bool	requestData ()
	Request data when configured in legacy mode with infinite skip factor. More...

virtual XSNOEXPORT bool	requestUtcTime ()

virtual bool	reset ()
	Reset the device. More...

virtual void	restartFilter ()
	Restart the software filter used by this device. More...

virtual uint16_t	rs485TransmissionDelay () const
	Returns the transmission delay used for RS485 transmissions. More...

virtual XsSelfTestResult	runSelfTest ()
	Run the self test for the device. More...

virtual bool	sendCustomMessage (const XsMessage &messageSend, bool waitForResult, XsMessage &messageReceive, int timeout=0)
	Send a custom message messageSend to the device and possibly wait for a result. More...

virtual XSNOEXPORT bool	sendCustomMessage (const XsMessage &messageSend, bool waitForResult, XsXbusMessageId messageId, XsMessage &messageReceive, int timeout=0)

virtual bool	sendRawMessage (const XsMessage &message)
	Send a message directly to the communicator. More...

virtual XsBaudRate	serialBaudRate () const
	The baud rate configured for cabled connection. More...

virtual bool	setAccessControlMode (XsAccessControlMode mode, const XsDeviceIdArray &initialList)
	Set the access control mode of the master device. More...

virtual bool	setAlignmentRotationMatrix (XsAlignmentFrame frame, const XsMatrix &matrix)
	Set an arbitrary alignment rotation matrix Use to rotate either L to the chosen frame L' or S to the chosen frame S'. More...

virtual bool	setAlignmentRotationQuaternion (XsAlignmentFrame frame, const XsQuaternion &quat)
	Set an arbitrary alignment rotation quaternion. Use to rotate either L to the chosen frame L' or S to the chosen frame S'. More...

virtual bool	setBlueToothEnabled (bool enabled)
	Enable or disable the BlueTooth radio of the device. More...

virtual bool	setBusPowerEnabled (bool enabled)
	Tell the Xbus to provide power to its child devices or not. More...

virtual bool	setCanConfiguration (uint32_t config)
	Set the CAN configuration for this device. More...

virtual bool	setCanOutputConfiguration (XsCanOutputConfigurationArray &config)
	Set the CAN output configuration for this device. More...

virtual bool	setDeviceAccepted (const XsDeviceId &deviceId)
	Accepts a device. More...

virtual bool	setDeviceBufferSize (uint32_t frames)
	Request the device to set it's internal buffer to the specified size. More...

virtual bool	setDeviceOptionFlags (XsDeviceOptionFlag setFlags, XsDeviceOptionFlag clearFlags)
	Set the device option flags. More...

virtual XsResultValue	setDeviceParameter (XsDeviceParameter const &parameter)
	Sets the given parameter for the device. More...

virtual bool	setDeviceRejected (const XsDeviceId &deviceId)
	Rejects a device. More...

virtual bool	setErrorMode (XsErrorMode errormode)
	Sets the error mode of the device. More...

virtual bool	setFixedGravityEnabled (bool enable)
	Sets whether the fixed gravity value should be used or if it should be computed from the initialPositionLLA value. More...

virtual bool	setGnssLeverArm (const XsVector &arm)
	Sets the GNSS Lever Arm vector. More...

XSNOEXPORT virtual XSDEPRECATED bool	setGnssPlatform (XsGnssPlatform gnssPlatform)

virtual bool	setGnssReceiverSettings (const XsIntArray &gnssReceiverSettings)
	Sets some GNSS receiver settings. More...

void	setGotoConfigOnClose (bool gotoConfigOnClose)
	On closePort the device will go to config by default, with this function it is possible to prevent that. More...

virtual bool	setInitialBiasUpdateEnabled (bool enable)
	Set if the device does gyroscope bias estimation when switching to measurement mode. More...

virtual bool	setOperationalMode (XsOperationalMode mode)
	Set the device in the given operational mode. More...

bool	setOutputConfiguration (XsOutputConfigurationArray &config)
	Set the output configuration for this device. More...

virtual XSNOEXPORT void	setPacketErrorRate (int per)

virtual bool	setPortConfiguration (XsIntArray &config)
	Change the port configuration of a device. More...

virtual bool	setRs485TransmissionDelay (uint16_t delay)
	Set the transmission delay used for RS485 transmissions. More...

XSNOEXPORT void	setSkipEmtsReadOnInit (bool skip)

virtual bool	setStealthMode (bool enabled)
	Enable or disable stealth mode. More...

virtual bool	setStringOutputMode (uint16_t type, uint16_t period, uint16_t skipFactor)
	Sets the string output mode for this device. More...

virtual bool	setSyncStationMode (bool enabled)
	Set the Sync Station mode of the Awinda Station device. More...

virtual bool	setUbloxGnssPlatform (XsUbloxGnssPlatform ubloxGnssPlatform)
	Set the device GNSS platform for u-blox GNSS receivers. More...

virtual bool	setUpdateRate (int rate)
	Set the legacy update rate of the device. More...

virtual bool	setUtcTime (const XsTimeInfo &time)
	Sets the 'UTC Time' setting of the device to the given time. More...

virtual bool	setWirelessPriority (int priority)
	Sets the wireless priority of the device. More...

virtual XsString	shortProductCode () const
	Return the shortened product code of the device suitable for display. More...

virtual bool	startRepresentativeMotion ()
	Let the user indicate that he is starting the representative motion for the In-Run Compass Calibration. More...

virtual bool	stealthMode () const
	Return the state of the stealth mode setting. More...

virtual XsIccRepMotionResult	stopRepresentativeMotion ()
	Let the user indicate that he stopped the representative motion. More...

virtual bool	storeIccResults ()
	Store the onboard ICC results for use by the device. More...

virtual uint16_t	stringOutputType () const
	Returns the string output type. More...

virtual uint16_t	stringSamplePeriod () const
	Returns the sample period for string output. More...

virtual uint16_t	stringSkipFactor () const
	Returns the skipfactor for string output. More...

virtual XsDevice *	subDevice (int subDeviceId) const
	Returns the sub-device at index index. More...

virtual int	subDeviceCount () const
	Returns the number of sub-devices of this device. More...

virtual uint32_t	supportedStatusFlags () const
	Returns a bitmask with all the status flags supported by this device. More...

virtual XsStringOutputTypeArray	supportedStringOutputTypes () const
	Ask the device for its supported string output types. More...

virtual XsSyncSettingArray	supportedSyncSettings () const
	Get all supported synchronization settings available on the device. More...

virtual XsSyncRole	syncRole () const
	Returns the synchronization role of the device. More...

virtual XsSyncSettingArray	syncSettings () const
	Get all the current synchronization settings of the device. More...

XsDataPacket	takeFirstDataPacketInQueue ()
	Return the first packet in the packet queue or an empty packet if the queue is empty. More...

template<typename T >
XSNOEXPORT T *	toType ()

virtual bool	transportMode ()
	Returns the current state of the transport mode feature. More...

virtual bool	triggerStartRecording ()
	Start recording incoming data through generating a virtual input trigger. More...

virtual XsUbloxGnssPlatform	ubloxGnssPlatform () const
	Returns the device GNSS platform for u-blox GNSS receivers. More...

virtual XsResultValue	updatePortInfo (XsPortInfo const &newInfo)
	Update the connection information, this is only useful for devices communicating over a dynamic link such as a TCP/IP connection. More...

virtual int	updateRate () const
	Get the legacy update rate of the device. More...

virtual int	updateRateForDataIdentifier (XsDataIdentifier dataType) const
	Returns the currently configured update rate for the supplied dataType. More...

virtual int	updateRateForProcessedDataIdentifier (XsDataIdentifier dataType) const
	Returns the currently configured update rate for the supplied dataType. More...

virtual bool	usesLegacyDeviceMode () const
	Returns whether the device uses legacy device mode. More...

virtual XsTimeInfo	utcTime () const
	Gets the 'UTC Time' setting of the device. More...

virtual void	waitForAllDevicesInitialized ()
	Wait until are known devices are initialized. More...

virtual XSNOEXPORT bool	waitForCustomMessage (std::shared_ptr< ReplyObject > reply, XsMessage &messageReceive, int timeout)

virtual XSNOEXPORT bool	waitForCustomMessage (XsXbusMessageId messageId, XsMessage &messageReceive, int timeout=0)

void	waitForLoadLogFileDone () const
	Wait for the file operation started by loadLogFile to complete. More...

virtual int	wirelessPriority () const
	Returns the wireless priority of the device. More...

virtual void	writeDeviceSettingsToFile ()
	Write the emts/wms/xms of the device and all its children to the open logfile. More...

virtual XSNOEXPORT bool	writeEmtsPage (uint8_t const *data, int pageNr, int bankNr)

virtual XsFilterProfile	xdaFilterProfile () const
	Gets the filter profile in use for computing orientations on the host PC. More...

virtual XSNOEXPORT	~XsDevice ()
	Destroy the device. More...

virtual XSNOEXPORT void	onMessageSent (const XsMessage &message)

virtual XSNOEXPORT void	onMessageReceived (const XsMessage &message)

virtual XSNOEXPORT void	onMessageDetected2 (XsProtocolType type, const XsByteArray &rawMessage)

virtual XSNOEXPORT void	onSessionRestarted ()

virtual XSNOEXPORT void	onConnectionLost ()

virtual XSNOEXPORT void	onEofReached ()

virtual XSNOEXPORT void	onWirelessConnectionLost ()

virtual XSNOEXPORT int64_t	deviceRecordingBufferItemCount (int64_t &lastCompletePacketId) const

Public Member Functions inherited from CallbackManagerXda
void	addCallbackHandler (XsCallbackPlainC *cb, bool chain=true)
	Add a handler to the list. More...

void	addChainedManager (CallbackManagerXda *cm)
	Add a chained manager to the list. More...

	CallbackManagerXda ()
	Constructor, initializes the callback list. More...

void	clearCallbackHandlers (bool chain=true)
	Clear the callback list. More...

void	clearChainedManagers ()
	Clear the chained manager list. More...

void	copyCallbackHandlersFrom (CallbackManagerXda *cm, bool chain=true)
	Copy all handlers from cm into this manager. More...

void	copyCallbackHandlersTo (CallbackManagerXda *cm, bool chain=true)
	Copy all handlers from this manager into cm. More...

void	onAllBufferedDataAvailable (XsDevicePtrArray devs, const XsDataPacketPtrArray packets) override
	The XsCallback::onAllBufferedDataAvailable() callback forwarding function. More...

void	onAllDataAvailable (XsDevicePtrArray devs, const XsDataPacketPtrArray packets) override
	The XsCallback::onAllDataAvailable() callback forwarding function. More...

void	onAllLiveDataAvailable (XsDevicePtrArray devs, const XsDataPacketPtrArray packets) override
	The XsCallback::onAllLiveDataAvailable() callback forwarding function. More...

void	onAllRecordedDataAvailable (XsDevicePtrArray devs, const XsDataPacketPtrArray packets) override
	The XsCallback::onAllRecordedDataAvailable() callback forwarding function. More...

void	onBufferedDataAvailable (XsDevice dev, const XsDataPacket data) override
	The XsCallback::onBufferedDataAvailable() callback forwarding function. More...

void	onConnectivityChanged (XsDevice *dev, XsConnectivityState newState) override
	The XsCallback::onConnectivityChanged() callback forwarding function. More...

void	onDataAvailable (XsDevice dev, const XsDataPacket data) override
	The XsCallback::onDataAvailable() callback forwarding function. More...

void	onDataUnavailable (XsDevice *dev, int64_t packetId) override
	The XsCallback::onDataUnavailable() callback forwarding function. More...

void	onDeviceStateChanged (XsDevice *dev, XsDeviceState newState, XsDeviceState oldState) override
	The XsCallback::onDeviceStateChanged() callback forwarding function. More...

void	onError (XsDevice *dev, XsResultValue error) override
	The Xscallback::onError() callback forwarding function. More...

void	onInfoResponse (XsDevice *dev, XsInfoRequest request) override
	The XsCallback::onInfoResponse() callback forwarding function. More...

void	onLiveDataAvailable (XsDevice dev, const XsDataPacket packet) override
	The XsCallback::onLiveDataAvailable() callback forwarding function. More...

void	onMessageDetected (XsDevice dev, XsProtocolType type, XsByteArray const rawMessage) override
	The Xscallback::onMessageReceivedFromDevice() callback forwarding function. More...

void	onMessageReceivedFromDevice (XsDevice dev, XsMessage const message) override
	The Xscallback::onMessageReceivedFromDevice() callback forwarding function. More...

void	onMessageSentToDevice (XsDevice dev, XsMessage const message) override
	The Xscallback::onMessageSentToDevice() callback forwarding function. More...

void	onMissedPackets (XsDevice *dev, int count, int first, int last) override
	The XsCallback::onMissedPackets() callback forwarding function. More...

void	onNonDataMessage (XsDevice dev, XsMessage const message) override
	The Xscallback::onNonDataMessage() callback forwarding function. More...

void	onProgressUpdated (XsDevice dev, int current, int total, const XsString identifier) override
	The XsCallback::onProgressUpdated() callback forwarding function. More...

void	onRecordedDataAvailable (XsDevice dev, const XsDataPacket data) override
	The XsCallback::onRecordedDataAvailable() callback forwarding function. More...

void	onRestoreCommunication (const XsString *portName, XsResultValue result) override
	The Xscallback::onRestoreCommunication callback forwarding function. More...

void	onTransmissionRequest (int channelId, const XsByteArray *data) override

void	onWakeupReceived (XsDevice *dev) override
	The XsCallback::onWakeupReceived() callback forwarding function. More...

int	onWriteMessageToLogFile (XsDevice dev, const XsMessage message) override
	The XsCallback::onWriteMessageToLogFile() callback forwarding function. More...

void	removeCallbackHandler (XsCallbackPlainC *cb, bool chain=true)
	Remove a handler from the list. More...

void	removeChainedManager (CallbackManagerXda *cm)
	Remove achained manager from the list. More...

	~CallbackManagerXda ()
	Destructor, clears the callback list. More...

Private Attributes
XsControl *	m_control

Friends
class	BroadcastForwardFunc

Additional Inherited Members
Static Public Member Functions inherited from XsDevice
static bool	isCompatibleSyncSetting (XsDeviceId const &deviceId, XsSyncSetting const &setting1, XsSyncSetting const &setting2)
	Determines whether setting1 is compatible with setting2 for deviceId deviceId. More...

static XsSyncSettingArray	supportedSyncSettings (XsDeviceId const &deviceId)
	Return the supported synchronization settings for a specified deviceId or deviceId mask. More...

static bool	supportsSyncSettings (XsDeviceId const &deviceId)
	Determines whether the device specified by deviceId supports sync settings. More...

static unsigned int	syncSettingsTimeResolutionInMicroSeconds (XsDeviceId const &deviceId)

Protected Member Functions inherited from XsDevice
virtual void	clearExternalPacketCaches ()

virtual XsDevice const *	firstChild () const

virtual bool	interpolateMissingData (XsDataPacket const &pack, XsDataPacket const &prev, std::function< void(XsDataPacket *)> packetHandler)

void	retainPacket (XsDataPacket const &pack)

void	setCommunicator (Communicator *comm)

virtual void	setRecordingStartFrame (uint16_t startFrame)

virtual void	setRecordingStopFrame (uint16_t stopFrame)

virtual bool	shouldDataMsgBeRecorded (const XsMessage &msg) const

virtual bool	shouldDoRecordedCallback (XsDataPacket const &packet) const

bool	skipEmtsReadOnInit () const

void	updateLastAvailableLiveDataCache (XsDataPacket const &pack)

void	useLogInterface (DataLogger *logger)
	Uses log interface for a given data logger. More...

	XSENS_DISABLE_COPY (XsDevice)

void	extractFirmwareVersion (XsMessage const &message)

virtual void	setDeviceState (XsDeviceState state)

virtual void	updateDeviceState (XsDeviceState state)

void	removeIfNoRefs ()

virtual bool	scheduleOrientationReset (XsResetMethod method)

	XsDevice (XsDeviceId const &id)
	Construct an empty device with device id id. More...

	XsDevice (Communicator *comm)
	Construct a device using inf for communication. More...

	XsDevice (XsDevice *master, const XsDeviceId &childDeviceId)
	Construct a device with device id childDeviceId for master masterDevice. More...

const XsDeviceConfiguration &	deviceConfig () const

void	setDeviceId (const XsDeviceId &deviceId)

XsOutputConfiguration	findConfiguration (XsDataIdentifier dataType) const

virtual void	writeMessageToLogFile (const XsMessage &message)

virtual void	writeFilterStateToFile ()

virtual void	processLivePacket (XsDataPacket &pack)

virtual void	processBufferedPacket (XsDataPacket &pack)

virtual bool	readDeviceConfiguration ()

XsDataPacket &	latestLivePacket ()

XsDataPacket &	latestBufferedPacket ()

XsDataPacket const &	latestLivePacketConst () const

XsDataPacket const &	latestBufferedPacketConst () const

virtual int64_t	latestLivePacketId () const

virtual int64_t	latestBufferedPacketId () const

virtual void	resetPacketStamping ()

void	updateConnectivityState (XsConnectivityState newState)

virtual XsConnectivityState	defaultChildConnectivityState () const

void	setInitialized (bool initialized)
	Set the initialized state to initialized. More...

void	setTerminationPrepared (bool prepared) NOEXCEPT
	Set the "termination prepared" state to prepared. More...

virtual bool	shouldWriteMessageToLogFile (const XsMessage &msg) const

virtual bool	shouldWriteMessageToLogFile (const XsDevice *dev, const XsMessage &message) const

virtual XsResultValue	setOutputConfigurationInternal (XsOutputConfigurationArray &config)

bool	doTransaction (const XsMessage &snd) const

bool	doTransaction (const XsMessage &snd, XsMessage &rcv) const

bool	doTransaction (const XsMessage &snd, XsMessage &rcv, uint32_t timeout) const

bool	doTransaction (const XsMessage &snd, uint32_t timeout) const

bool	justWriteSetting () const

virtual void	clearProcessors ()

virtual void	clearDataCache ()

virtual void	insertIntoDataCache (int64_t pid, XsDataPacket *pack)

virtual void	reinitializeProcessors ()

virtual bool	expectingRetransmissionForPacket (int64_t packetId) const

virtual bool	resetRemovesPort () const

virtual bool	isSoftwareFilteringEnabled () const

virtual bool	isSoftwareCalibrationEnabled () const

virtual void	setStartRecordingPacketId (int64_t startFrame)

virtual void	setStopRecordingPacketId (int64_t stopFrame)

virtual void	endRecordingStream ()

virtual void	clearCacheToRecordingStart ()

Static Protected Member Functions inherited from XsDevice
static bool	checkDataEnabled (XsDataIdentifier dataType, XsOutputConfigurationArray const &configurations)

static bool	packetContainsRetransmission (XsDataPacket const &pack)

Protected Attributes inherited from XsDevice
Communicator *	m_communicator
	A communicator. More...

XsDeviceConfiguration	m_config
	A device configuration. More...

XsConnectivityState	m_connectivity
	A current device connectivity state. More...

DataPacketCache	m_dataCache
	A data cache. More...

XsDeviceId	m_deviceId
	An ID of the device. More...

xsens::GuardedMutex	m_deviceMutex
	The mutex for guarding state changes of the device. More...

XsMessage	m_emtsBlob
	An EMTS blob from device. More...

XsVersion	m_firmwareVersion
	A firmware version. More...

bool	m_gotoConfigOnClose
	Go to confing on close boolean variable. More...

bool	m_isInitialized
	Is intialized boolean variable. More...

bool	m_justWriteSetting
	Just write setting boolean variable. More...

XsDataPacket *	m_lastAvailableLiveDataCache
	A last available live data cache. More...

XsTimeStamp	m_lastDataOkStamp
	A time stamp for an OK last data. More...

LastResultManager	m_lastResult
	The last result of an operation. More...

XsDataPacket *	m_latestBufferedPacket
	A copy of the latest ready recording packet. This is the last packet that was popped off the front of m_dataCache. Use latestBufferedPacket() to access. More...

XsDataPacket *	m_latestLivePacket
	A copy of the latest ready live packet. This is the packet with the highest 64-bit sample counter so far. Use latestLivePacket() to access. More...

std::deque< XsDataPacket * >	m_linearPacketCache
	A linear data packet cache. More...

DataLogger *	m_logFileInterface
	A data logger for a file interface. More...

xsens::Mutex	m_logFileMutex
	The mutex for guarding access to the log file. More...

XsDevice *	m_master
	A device object. More...

XsOption	m_options
	The options. More...

XsOutputConfigurationArray	m_outputConfiguration
	A devices output configuration. More...

PacketStamper	m_packetStamper
	A packet stamper. More...

volatile std::atomic_int	m_refCounter
	A reference counter. More...

bool	m_skipEmtsReadOnInit
	Skip EMTS read on init boolean variable. More...

int64_t	m_startRecordingPacketId
	The ID of the first packet that should be / was recorded. More...

XsDeviceState	m_state
	A current device state. More...

int64_t	m_stoppedRecordingPacketId
	The ID of the last packet that was recorded. Remains valid after Flushing has ended, until a new recording is started. More...

int64_t	m_stopRecordingPacketId
	The ID of the last packet that should be / was recorded. Only valid in Recording/Flushing states. More...

bool	m_terminationPrepared
	Termination prepared boolean variable. More...

DebugFileType *	m_toaDumpFile
	To a dump file. More...

int64_t	m_unavailableDataBoundary
	A packet ID of the last sample we know to be unavailable. More...

bool	m_writeToFile
	Write to file boolean variable. More...

Detailed Description

Intimately entangled class with XsControl that allows broadcasting to all main devices.

This class is intended to prevent interface duplication from XsDevice to XsControl. When broadcasting, the user can use XsControl::findDevice(XsDeviceId::broadcast()) to get the BroadcastDevice and use it as any other device.

The BroadcastDevice is not actually part of the device hierarchy, but it pretends to be the parent of all mian devices is XsControl.

The functions that are broadcast make use of the BroadcastForwardFunc class.

Definition at line 71 of file broadcastdevice.h.

Constructor & Destructor Documentation

◆ BroadcastDevice()

BroadcastDevice::BroadcastDevice ( XsControl * control )

explicit

Constructor, sets up the XsControl reference.

Definition at line 271 of file broadcastdevice.cpp.

◆ ~BroadcastDevice()

BroadcastDevice::~BroadcastDevice ( )

override

Destructor, no special actions taken.

Definition at line 279 of file broadcastdevice.cpp.

Member Function Documentation

◆ abortFlushing()

bool BroadcastDevice::abortFlushing ( )

overridevirtual

Abort the wireless flushing operation and finalize the recording.

Returns: true if no flushing is in progress when the function exits

Note: Awinda Station only

Reimplemented from XsDevice.

Definition at line 377 of file broadcastdevice.cpp.

◆ batteryLevelTime()

XsTimeStamp BroadcastDevice::batteryLevelTime ( )

overridevirtual

Requests the time the battery level was last updated.

Returns: the XsTimeStamp the battery level was last set

Reimplemented from XsDevice.

Definition at line 372 of file broadcastdevice.cpp.

◆ children()

std::vector< XsDevice * > BroadcastDevice::children ( ) const

virtual

Return the children of this device, actually returns the main devices in the XsControl object.

Reimplemented from XsDevice.

Definition at line 287 of file broadcastdevice.cpp.

◆ closeLogFile()

bool BroadcastDevice::closeLogFile ( )

overridevirtual

Close the log file.

Returns: true if the log file was successfully closed or never open

Reimplemented from XsDevice.

Definition at line 357 of file broadcastdevice.cpp.

◆ flushInputBuffers()

void BroadcastDevice::flushInputBuffers ( )

overridevirtual

Clear the inbound data buffers of the device.

Reimplemented from XsDevice.

Definition at line 509 of file broadcastdevice.cpp.

◆ gotoConfig()

bool BroadcastDevice::gotoConfig ( )

overridevirtual

Put the device in config mode.

Device settings can only be changed in config mode, since changing anything during measurement would mess up the sample timing.

Returns: true if the device was successfully put in config mode or was already in config mode

See also: gotoMeasurement

Reimplemented from XsDevice.

Definition at line 397 of file broadcastdevice.cpp.

◆ gotoMeasurement()

bool BroadcastDevice::gotoMeasurement ( )

overridevirtual

Put this device in measurement mode.

Measurement mode is where the device is sampling data and producing inertial and orientation output.

Returns: true if the device was successfully put in measurement mode or was already in measurement mode

See also: gotoConfig

Reimplemented from XsDevice.

Definition at line 414 of file broadcastdevice.cpp.

◆ hardwareVersion()

XsVersion BroadcastDevice::hardwareVersion ( ) const

overridevirtual

required function to prevent pure-virtualness

Reimplemented from XsDevice.

Definition at line 309 of file broadcastdevice.cpp.

◆ initialize()

bool BroadcastDevice::initialize ( )

overridevirtual

required function to prevent pure-virtualness

Reimplemented from XsDevice.

Definition at line 293 of file broadcastdevice.cpp.

◆ isMeasuring()

bool BroadcastDevice::isMeasuring ( ) const

overridevirtual

Returns true if the device is currently in a measuring state.

Returns: true if the device is currently in a measuring state

Reimplemented from XsDevice.

Definition at line 382 of file broadcastdevice.cpp.

◆ isReadingFromFile()

bool BroadcastDevice::isReadingFromFile ( ) const

finaloverridevirtual

Returns true if the device is reading from a file.

Returns: true if the device is reading from a file

Reimplemented from XsDevice.

Definition at line 392 of file broadcastdevice.cpp.

◆ isRecording()

bool BroadcastDevice::isRecording ( ) const

overridevirtual

Returns true if the device is currently in a recording state.

Returns: true if the device is currently in a recording state

Reimplemented from XsDevice.

Definition at line 387 of file broadcastdevice.cpp.

◆ loadLogFile()

bool BroadcastDevice::loadLogFile ( )

overridevirtual

Load a complete logfile.

Load the opened log file completely. This function loads all data from the open logfile in a separate thread, generating onProgressUpdated callbacks. This function will return true if the reading was scheduled.

Returns: true if the threaded loading was successfully started

See also: onProgressUpdated

Reimplemented from XsDevice.

Definition at line 352 of file broadcastdevice.cpp.

◆ productCode()

XsString BroadcastDevice::productCode ( ) const

overridevirtual

required function to prevent pure-virtualness

Reimplemented from XsDevice.

Definition at line 304 of file broadcastdevice.cpp.

◆ requestBatteryLevel()

bool BroadcastDevice::requestBatteryLevel ( )

overridevirtual

Request the battery level from the device.

This is an asynchronous operation. The Awinda station or MTw sends the battery level when possible. For devices in wired mode the

See also: batteryLevel() function can be called without calling this function first.

Returns: true If the battery level request was successfully sent

Reimplemented from XsDevice.

Definition at line 367 of file broadcastdevice.cpp.

◆ reset()

bool BroadcastDevice::reset ( bool skipDeviceIdCheck = false )

overridevirtual

Reimplemented from XsDevice.

Definition at line 454 of file broadcastdevice.cpp.

◆ resetLogFileReadPosition()

bool BroadcastDevice::resetLogFileReadPosition ( )

overridevirtual

Set the read position of the open log file to the start of the file.

If software filtering is enabled, the appropriate filters will be restarted as if the file was just opened.

Returns: true if the read position was successfully reset to the start of the file

Note: This is a low-level file operation.

Reimplemented from XsDevice.

Definition at line 449 of file broadcastdevice.cpp.

◆ resetOrientation()

bool BroadcastDevice::resetOrientation ( XsResetMethod resetmethod )

overridevirtual

Perform an orientation reset on the device using the given resetMethod.

This function schedules an orientation reset command to be applied in the first available orientation filter update.

Parameters

resetmethod The requested orientation reset method.

Returns: true if the orientation reset was successfully scheduled

Note: XRM_StoreAlignmentMatrix can only be used in config mode, the others only in measurement mode

Reimplemented from XsDevice.

Definition at line 439 of file broadcastdevice.cpp.

◆ restoreFactoryDefaults()

bool BroadcastDevice::restoreFactoryDefaults ( )

overridevirtual

Restore the device to its factory default settings.

Returns: true if the settings have been successfully restored

Reimplemented from XsDevice.

Definition at line 444 of file broadcastdevice.cpp.

◆ setGravityMagnitude()

bool BroadcastDevice::setGravityMagnitude ( double mag )

overridevirtual

Sets the 'Gravity Magnitude' of the device to the given value mag.

The Gravity Magnitude is the strength of the gravity where the measurements are done. Setting this value precisely allows for more accurate measurements.

Parameters

mag	The desired 'Gravity Magnitude' setting of the device.

Returns: true if the Gravity Magnitude was successfully written

Note: The default value is usually computed from the last known Lat Lon Alt value

See also: gravityMagnitude; setInitialPositionLLA; initialPositionLLA

Reimplemented from XsDevice.

Definition at line 489 of file broadcastdevice.cpp.

◆ setHeadingOffset()

bool BroadcastDevice::setHeadingOffset ( double offset )

overridevirtual

Set the 'heading offset' setting of the device.

Parameters

offset The desired heading offset of the device in degrees

Returns: true if the device was successfully updated

See also: headingOffset

Reimplemented from XsDevice.

Definition at line 429 of file broadcastdevice.cpp.

◆ setInitialPositionLLA()

bool BroadcastDevice::setInitialPositionLLA ( const XsVector & lla )

overridevirtual

Sets the 'Latitude Longitude Altitude' setting of the device to the given vector.

The Latitude Longitude Altitude contains the location on earth where the measurements are done. Setting this value allows for more accurate measurements. The default gravity magnitude and earth magnetic field are computed form this value.

Parameters

lla	The desired 'Latitude Longitude Altitude' setting for the device. This should be a 3-element vector.

Returns: true if the Latitude Longitude Altitude was successfully written

Note: When GNSS is available, this value is automatically updated with the last known position when the device is put in config mode after measurement.

See also: initialPositionLLA; labMagneticField; gravityMagnitude

Reimplemented from XsDevice.

Definition at line 499 of file broadcastdevice.cpp.

◆ setLocationId()

bool BroadcastDevice::setLocationId ( int id )

overridevirtual

Set the location ID of the device.

The location ID is a custom 16-bit ID that can be assigned to a device.

Parameters

id	The desired location ID for the device

Returns: true if the Location ID was successfully updated

See also: locationId

Reimplemented from XsDevice.

Definition at line 434 of file broadcastdevice.cpp.

◆ setNoRotation()

bool BroadcastDevice::setNoRotation ( uint16_t duration )

overridevirtual

Set the no rotation period to duration.

This function can be called in both config and measurement modes. In config mode it specifies the duration that the device is considered to be stationary as soon as it enters measurement mode. In measurement mode, it specifies the duration that the device is considered to be stationary, starting immediately.

During the stationary period, the gyroscope biases are measured, giving better performance.

Parameters

duration The desired stationary duration in seconds

Returns: true if the no rotation command was accepted by the device

See also: isInitialBiasUpdateEnabled; setInitialBiasUpdateEnabled

Reimplemented from XsDevice.

Definition at line 362 of file broadcastdevice.cpp.

◆ setObjectAlignment()

bool BroadcastDevice::setObjectAlignment ( const XsMatrix & matrix )

overridevirtual

Sets the object alignment of a device to the given matrix.

Parameters

matrix The matrix to set

If an error is encountered, the lastResult value is set and the function returns false.

Returns: True if successful

See also: objectAlignmentMatrix(), headingOffset(), setHeadingOffset(), lastResult()

Reimplemented from XsDevice.

Definition at line 320 of file broadcastdevice.cpp.

◆ setOnboardFilterProfile() [1/2]

bool BroadcastDevice::setOnboardFilterProfile ( int profileType )

overridevirtual

Sets the filter profile to use for computing orientations on the device.

When computing orientation data, there is a choice of filter profiles. This function can be used to select the appropriate one.

Parameters

profileType The filter profile type to use. This can be chosen from the list returned by availableOnboardFilterProfiles()

Returns: true if the filter profile was successfully changed

See also: availableOnboardFilterProfiles; onboardFilterProfile; setXdaFilterProfile

Reimplemented from XsDevice.

Definition at line 479 of file broadcastdevice.cpp.

◆ setOnboardFilterProfile() [2/2]

bool BroadcastDevice::setOnboardFilterProfile ( XsString const & profileType )

overridevirtual

Sets the filter profile to use for computing orientations on the device.

When computing orientation data, there is a choice of filter profiles. This function can be used to select the appropriate one.

Parameters

profileType The filter profile type to use. This can be chosen from the list returned by availableOnboardFilterProfiles()

Returns: true if the filter profile was successfully changed

See also: availableOnboardFilterProfiles; onboardFilterProfile; setXdaFilterProfile

Reimplemented from XsDevice.

Definition at line 484 of file broadcastdevice.cpp.

◆ setOptions()

void BroadcastDevice::setOptions	(	XsOption	enable,
		XsOption	disable
	)

overridevirtual

Enable and disable processing options.

These options are used to specify whether XDA should compute certain kinds of data from available other data and what data-retention policy to use. On a system with limited resources it may be useful to limit the processing and data retention done by XDA. By default XDA will do all processing it can do, but retain as little data as possible. In case of conflict, enable supersedes disable.

Parameters

enable	A logically OR'ed combination of XsOptions to enable
disable	A logically OR'ed combination of XsOptions to disable

See also: areOptionsEnabled

Reimplemented from XsDevice.

Definition at line 504 of file broadcastdevice.cpp.

◆ setSerialBaudRate()

bool BroadcastDevice::setSerialBaudRate ( XsBaudRate baudrate )

overridevirtual

Change the serial baudrate to baudrate.

Reimplemented from XsDevice.

Definition at line 347 of file broadcastdevice.cpp.

◆ setSyncSettings()

bool BroadcastDevice::setSyncSettings ( const XsSyncSettingArray & settingList )

overridevirtual

Set the synchronization settings of the device.

This function can be used to set all the synchronization options of the device at once. It is translated into device-specific commands by XDA, since not all devices support the same synchronization functionality.

Parameters

settingList The list of synchronization settings to set. An empty list will clear all synchronization settings.

Returns: true if the device was successfully updated

See also: syncSettings

Reimplemented from XsDevice.

Definition at line 424 of file broadcastdevice.cpp.

◆ setTransportMode()

bool BroadcastDevice::setTransportMode ( bool transportModeEnabled )

overridevirtual

Enable or disable the transport mode for the device.

The MTw has a "wake up by motion" feature that requires some power and can cause unnecessary wakeups when transporting the device. This function can be used to put the device in "transport mode", which effectively disables the motion wake up feature until the device is plugged into something or the transport mode is explicitly disabled by this function again.

Parameters

transportModeEnabled true to enable transport mode (which disables the motion wakeup)

Returns: true if the device was successfully put in transport mode (or taken out of it)

Note: MTw only

Reimplemented from XsDevice.

Definition at line 459 of file broadcastdevice.cpp.

◆ setXdaFilterProfile() [1/2]

bool BroadcastDevice::setXdaFilterProfile ( int profileType )

overridevirtual

Sets the filter profile to use for computing orientations on the host PC.

When computing orientation data, there is a choice of filter profiles. This function can be used to select the appropriate one. By default XDA will attempt to match the software filter profile to the configured hardware filter profile when detecting a new device.

Parameters

profileType The filter profile type to use. This can be chosen from the list returned by availableXdaFilterProfiles()

Returns: true if the filter profile was successfully changed

Note: When reading from a file, make sure to call resetLogFileReadPosition() and possibly loadLogFile() after changing the filter profile to make sure all cached data is recomputed.

See also: availableXdaFilterProfiles; xdaFilterProfile; setOnboardFilterProfile

Reimplemented from XsDevice.

Definition at line 469 of file broadcastdevice.cpp.

◆ setXdaFilterProfile() [2/2]

bool BroadcastDevice::setXdaFilterProfile ( XsString const & profileType )

overridevirtual

Sets the filter profile to use for computing orientations on the host PC.

When computing orientation data, there is a choice of filter profiles. This function can be used to select the appropriate one. By default XDA will attempt to match the software filter profile to the configured hardware filter profile when detecting a new device.

Parameters

profileType The filter profile type to use. This can be chosen from the list returned by availableXdaFilterProfiles()

Returns: true if the filter profile was successfully changed

Note: When reading from a file, make sure to call resetLogFileReadPosition() and possibly loadLogFile() after changing the filter profile to make sure all cached data is recomputed.

See also: availableXdaFilterProfiles; xdaFilterProfile; setOnboardFilterProfile

Reimplemented from XsDevice.

Definition at line 474 of file broadcastdevice.cpp.

◆ startRecording()

bool BroadcastDevice::startRecording ( )

overridevirtual

Start recording data.

Reimplemented from XsDevice.

Definition at line 327 of file broadcastdevice.cpp.

◆ stopRecording()

bool BroadcastDevice::stopRecording ( )

overridevirtual

Stop recording data.

Reimplemented from XsDevice.

Definition at line 337 of file broadcastdevice.cpp.

◆ storeFilterState()

bool BroadcastDevice::storeFilterState ( )

overridevirtual

Store orientation filter state in the device.

Use this function when the filters for the device have stabilized to store the current biases in the device. The benefit is that on the next startup the filter will stabilize quicker. However, the stored biases depend on temperature and other external parameters, so the stored values will remain correct for only a short time.

Returns: true if the filter state was saved, false otherwise

Reimplemented from XsDevice.

Definition at line 494 of file broadcastdevice.cpp.

◆ supportedUpdateRates()

std::vector< int > BroadcastDevice::supportedUpdateRates ( XsDataIdentifier dataType ) const

overridevirtual

required function to prevent pure-virtualness

Reimplemented from XsDevice.

Definition at line 298 of file broadcastdevice.cpp.

◆ updateCachedDeviceInformation()

bool BroadcastDevice::updateCachedDeviceInformation ( )

overridevirtual

Updates the cached device information for all devices connected to this port.

This function can only be called in config mode. XDA caches all device information to prevent unnecessary communication with the device. When some configuration has changed without XDA knowing about it (through sendCustomMessage() for example), it may be necessary to tell XDA to refresh its cached information by calling this function.

Returns: true if the cached information was updated successfully

Reimplemented from XsDevice.

Definition at line 464 of file broadcastdevice.cpp.

Friends And Related Function Documentation

◆ BroadcastForwardFunc

friend class BroadcastForwardFunc

friend

Definition at line 123 of file broadcastdevice.h.

Member Data Documentation

◆ m_control

XsControl* BroadcastDevice::m_control

private

Definition at line 124 of file broadcastdevice.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BroadcastDevice()

◆ ~BroadcastDevice()

Member Function Documentation

◆ abortFlushing()

◆ batteryLevelTime()

◆ children()

◆ closeLogFile()

◆ flushInputBuffers()

◆ gotoConfig()

◆ gotoMeasurement()

◆ hardwareVersion()

◆ initialize()

◆ isMeasuring()

◆ isReadingFromFile()

◆ isRecording()

◆ loadLogFile()

◆ productCode()

◆ requestBatteryLevel()

◆ reset()

◆ resetLogFileReadPosition()

◆ resetOrientation()

◆ restoreFactoryDefaults()

◆ setGravityMagnitude()

◆ setHeadingOffset()

◆ setInitialPositionLLA()

◆ setLocationId()

◆ setNoRotation()

◆ setObjectAlignment()

◆ setOnboardFilterProfile() [1/2]

◆ setOnboardFilterProfile() [2/2]

◆ setOptions()

◆ setSerialBaudRate()

◆ setSyncSettings()

◆ setTransportMode()

◆ setXdaFilterProfile() [1/2]

◆ setXdaFilterProfile() [2/2]

◆ startRecording()

◆ stopRecording()

◆ storeFilterState()

◆ supportedUpdateRates()

◆ updateCachedDeviceInformation()

Friends And Related Function Documentation

◆ BroadcastForwardFunc

Member Data Documentation

◆ m_control