An abstract internal struct of a control object. More...
#include <xscontrol_public.h>
Inheritance diagram for XsControlEx:
Additional Inherited Members | |
 Public Member Functions inherited from XsControl | |
| XsDevice * | broadcast () const |
| Returns the broadcast device. More... | |
| void | clearHardwareError () |
| Clear the last hardware error. More... | |
| void | close () |
| Close all ports and files. More... | |
| void | closeCustomPort (int channelId) |
| Closes a custom communication channel. More... | |
| void | closePort (const XsDeviceId &deviceId) |
| Close the port that is used for communication with the given deviceId. More... | |
| void | closePort (const XsPortInfo &portinfo) |
| Close the serial port that matches portinfo. More... | |
| void | closePort (const XsString &portname) |
| Close the serial port with the given portname. More... | |
| void | closePort (XsDevice *device) |
| Close the device port with the given XsDevice. More... | |
| XsPortInfo | customPortInfo (int channelId) const |
| Returns the port information for a custom communication channel. More... | |
| XSNOEXPORT void | destruct () |
| XsDevice * | device (const XsDeviceId &deviceId) const |
| Returns the XsDevice interface object associated with the supplied deviceId. More... | |
| int | deviceCount () const |
| Get the number of connected devices. More... | |
| virtual std::vector< XsDeviceId > | deviceIds () const |
| Get the device IDs of all the connected devices. More... | |
| XsOption | disabledOptions () const |
| Return the currently explicitly disabled options. More... | |
| XsDeviceId | dockDeviceId (const XsDeviceId &deviceId) const |
| Get the device ID of the dock device for the given deviceId. More... | |
| XsOption | enabledOptions () const |
| Return the currently enabled options. More... | |
| virtual bool XSNOEXPORT | finalizeOpenPort (Communicator *communicator, XsPortInfo &portinfo, uint32_t timeout, bool detectRs485) |
| void | flushInputBuffers () |
| Clear the inbound data buffers of all devices. More... | |
| XsDevice * | getDeviceFromLocationId (uint16_t locationId) const |
| Get the device of the device on the given locationId. More... | |
| void | gotoConfig () |
| Place all sensors connected through a serial port into Configuration Mode. More... | |
| void | gotoMeasurement () |
| Place all sensors connected through a serial port into Measurement Mode. More... | |
| virtual bool | isDeviceDocked (const XsDeviceId &deviceId) const |
| Test if the given deviceId is docked. More... | |
| virtual bool | isDeviceWireless (const XsDeviceId &deviceId) const |
| Test if the given deviceId is an MTw and if it is wirelessly connected. More... | |
| XsResultValue | lastHardwareError () const |
| Get the last hardware error code. More... | |
| XsDeviceId | lastHardwareErrorDeviceId () const |
| 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() More... | |
| virtual bool | loadFilterProfiles (const XsString &filename) |
| Load filter profile definitions from a settings file with the given filename. More... | |
| int | mainDeviceCount () const |
| Get the number of main devices. More... | |
| std::vector< XsDeviceId > | mainDeviceIds () const |
| Get the device IDs of the available main devices. More... | |
| XsDevicePtrArray | mainDevices () const |
| Returns all main XsDevice interface objects. More... | |
| virtual int | mtCount () const |
| Get the number of connected MTs. More... | |
| virtual std::vector< XsDeviceId > | mtDeviceIds () const |
| Get the device IDs of the available MTs. More... | |
| bool | openCustomPort (int channelId, uint32_t channelLatency, bool detectRs485=false) |
| Open a custom communication channel. More... | |
| virtual bool | openImarPort_internal (const XsString &portname, XsBaudRate baudrate, int imarType, uint32_t timeout=0) |
| Open a communication channel on serial port with the given portname. More... | |
| bool | openLogFile (const XsString &filename) |
| Open the log file with the given filename. More... | |
| bool | openPort (const XsString &portname, XsBaudRate baudrate, uint32_t timeout=0, bool detectRs485=false) |
| Open a communication channel on serial port with the given portname. More... | |
| bool | openPort (XsPortInfo &portinfo, uint32_t timeout=0, bool detectRs485=false) |
| Open a communication channel using the details in the supplied XsPortInfo structure. More... | |
| bool | openPortWithCredentials (XsPortInfo &portinfo, XsString const &id, XsString const &key, uint32_t timeout=0) |
| Open a communication channel using the details in the supplied XsPortInfo structure using the supplied credentials. More... | |
| bool | setInitialPositionLLA (const XsVector &lla) |
| Sets the current GNSS position of the system. More... | |
| void | setOptions (XsOption enable, XsOption disable) |
| Peristently enable or disable options. More... | |
| void | setOptionsForce (XsOption enabled) |
| Peristently enable or disable options. More... | |
| XsResultValue | startRestoreCommunication (const XsString &portName) |
| Starts restore communication procedure. More... | |
| void | stopRestoreCommunication () |
| Stops restore communication procedure. More... | |
| void | transmissionReceived (int channelId, const XsByteArray &data) |
| Feed data coming back from an Xsens device over a custom channel into XDA. More... | |
| XsControl () | |
| Construct a new Xsens Device API control object. More... | |
| ~XsControl () | |
| Destroy this XsControl object. More... | |
| 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... | |
| Static Public Member Functions inherited from XsControl | |
| static XSNOEXPORT XsControl * | construct () |
| static XsString | resultText (XsResultValue resultCode) |
| Get a descriptive text for the given resultCode. More... | |
| Protected Member Functions inherited from XsControl | |
| virtual XsDevice *XSNOCOMEXPORT | addMasterDevice (Communicator *communicator) |
| void | closePortByIndex (uint32_t index) |
| XsDevice * | findDevice (const XsDeviceId &deviceId) const |
| Communicator * | findXbusInterface (const XsDeviceId &deviceId) const |
| Find the xs3 info of the given id. More... | |
| Communicator * | findXbusInterface (const XsPortInfo &portInfo) const |
| Communicator * | findXbusInterface (const XsString &portName) const |
| virtual void | removeExistingDevice (XsDeviceId const &deviceId) |
| void | setPersistentSettings (XsDevice *dev) |
| void | updateRecordingState () |
| XSNOEXPORT | XsControl (const XsControl &)=delete |
| Protected Attributes inherited from XsControl | |
| BroadcastDevice * | m_broadcaster |
| The broadcast device object. More... | |
| XdaCommunicatorFactory * | m_communicatorFactory |
| The communicator factory object. More... | |
| DeviceFactory * | m_deviceFactory |
| The device factory object. More... | |
| std::vector< XsDevice * > | m_deviceList |
| This list contains device-information and cached data per device. More... | |
| XsResultValue | m_lastHwError |
| Contains the last serious error reported by CMT3. More... | |
| XsDeviceId | m_lastHwErrorDeviceId |
| Contains the XsDevice ID of the device that caused the last hardware error. More... | |
| LastResultManager | m_lastResult |
| The last result of an operation. More... | |
| XsVector3 | m_latLonAlt |
| This vector contains the latitude, longitude and altitude. More... | |
| XsOption | m_optionsDisable |
| Contsins all disabled options. More... | |
| XsOption | m_optionsEnable |
| Contains all enable options. More... | |
| xsens::MutexReadWrite | m_portMutex |
| Controls access to the serial ports, also used to suspend the thread. More... | |
| std::map< int, ProxyCommunicator * > | m_proxyChannels |
| This map contains the proxy channels. More... | |
| volatile std::atomic_bool | m_recording |
| AwindaStationIndication of threads started or not. More... | |
| RestoreCommunication * | m_restoreCommunication |
| The restore communication object. More... | |
| xsens::Mutex | m_runMutex |
| Always held by the thread when it is running. More... | |
| bool | m_useFakeMessages |
| Boolean variable for enabling/disabling the use of fake messages. More... | |
Detailed Description
An abstract internal struct of a control object.
Definition at line 73 of file xscontrol_public.h.
The documentation for this class was generated from the following file: