mti6x0device.h
Go to the documentation of this file.
1 
2 // Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without modification,
6 // are permitted provided that the following conditions are met:
7 //
8 // 1. Redistributions of source code must retain the above copyright notice,
9 // this list of conditions, and the following disclaimer.
10 //
11 // 2. Redistributions in binary form must reproduce the above copyright notice,
12 // this list of conditions, and the following disclaimer in the documentation
13 // and/or other materials provided with the distribution.
14 //
15 // 3. Neither the names of the copyright holders nor the names of their contributors
16 // may be used to endorse or promote products derived from this software without
17 // specific prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
20 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
22 // THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
24 // OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
26 // TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS
28 // SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES
29 // OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE
30 // ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
31 //
32 
33 
34 // Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
35 // All rights reserved.
36 //
37 // Redistribution and use in source and binary forms, with or without modification,
38 // are permitted provided that the following conditions are met:
39 //
40 // 1. Redistributions of source code must retain the above copyright notice,
41 // this list of conditions, and the following disclaimer.
42 //
43 // 2. Redistributions in binary form must reproduce the above copyright notice,
44 // this list of conditions, and the following disclaimer in the documentation
45 // and/or other materials provided with the distribution.
46 //
47 // 3. Neither the names of the copyright holders nor the names of their contributors
48 // may be used to endorse or promote products derived from this software without
49 // specific prior written permission.
50 //
51 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
52 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
53 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
54 // THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 // SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
56 // OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
58 // TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
59 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS
60 // SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES
61 // OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE
62 // ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
63 //
64 
65 #ifndef XSMTI6X0DEVICE_H
66 #define XSMTI6X0DEVICE_H
67 
68 #include "mtibasedevice.h"
69 
74 {
75 public:
78  {
79  return new Mti6X0Device(comm);
80  }
81 
82  explicit Mti6X0Device(Communicator* comm);
83 
86  virtual ~Mti6X0Device();
87 
89  bool setStringOutputMode6x0(uint32_t type, uint16_t frequency);
90  uint32_t supportedStatusFlags() const override;
91  XsString shortProductCode() const override;
94 
95  XsIntArray portConfiguration() const override;
96  bool setPortConfiguration(XsIntArray& config) override;
97 
98  uint32_t canConfiguration() const override;
99  bool setCanConfiguration(uint32_t config) override;
100 
101  bool setGnssLeverArm(const XsVector& arm) override;
102  XsVector gnssLeverArm() const override;
103 
104  XsUbloxGnssPlatform ubloxGnssPlatform() const override;
106 
107 protected:
108  uint8_t syncLine(const XsSyncSetting& setting) const override;
109  bool hasIccSupport() const override;
110 
112 };
113 
114 #ifndef XDA_PRIVATE_BUILD
115 
119 {
121  explicit Mti6X0DeviceEx(Communicator* comm) : Mti6X0Device(comm) {};
122 
125 };
126 #else
127 #include "mtix00deviceex.h"
128 #endif
129 
130 #endif
Mti6X0Device::getBaseFrequencyInternal
MtiBaseDevice::BaseFrequencyResult getBaseFrequencyInternal(XsDataIdentifier dataType=XDI_None) const override
Returns the base update rate (Hz) corresponding to the dataType.
Definition: mti6x0device.cpp:100
Mti6X0Device::supportedStatusFlags
uint32_t supportedStatusFlags() const override
Returns a bitmask with all the status flags supported by this device.
Definition: mti6x0device.cpp:226
Mti6X0Device::canConfiguration
uint32_t canConfiguration() const override
Returns the currently configured CAN configuration of the device.
Definition: mti6x0device.cpp:299
XsVector
A class that represents a vector of real numbers.
Definition: xsvector.h:113
XsDevice::master
virtual XsDevice * master() const
Return the master device of this device.
Definition: xsdevice_def.cpp:332
XDI_None
@ XDI_None
Empty datatype.
Definition: xsdataidentifier.h:86
Mti6X0Device::shortProductCode
XsString shortProductCode() const override
Return the shortened product code of the device suitable for display.
Definition: mti6x0device.cpp:257
Mti6X0Device::gnssLeverArm
XsVector gnssLeverArm() const override
Definition: mti6x0device.cpp:391
XsIntArray
A list of XsInt values.
Mti6X0Device::~Mti6X0Device
virtual ~Mti6X0Device()
Destroys a device.
Definition: mti6x0device.cpp:94
Mti6X0Device::setCanOutputConfiguration
bool setCanOutputConfiguration(XsCanOutputConfigurationArray &config) override
Set the CAN output configuration for this device.
Definition: mti6x0device.cpp:280
Mti6X0Device::ubloxGnssPlatform
XsUbloxGnssPlatform ubloxGnssPlatform() const override
Returns the device GNSS platform for u-blox GNSS receivers.
Definition: mti6x0device.cpp:409
Mti6X0Device::setPortConfiguration
bool setPortConfiguration(XsIntArray &config) override
Change the port configuration of a device.
Definition: mti6x0device.cpp:325
mtibasedevice.h
Mti6X0Device::syncLine
uint8_t syncLine(const XsSyncSetting &setting) const override
Definition: mti6x0device.cpp:170
XsSyncSetting
A structure for storing all xsens sync settings.
Definition: xssyncsetting.h:95
XsDataIdentifier
XsDataIdentifier
Defines the data identifiers.
Definition: xsdataidentifier.h:84
Communicator
A base struct for a communication interface.
Definition: communicator.h:95
Mti6X0Device::setUbloxGnssPlatform
bool setUbloxGnssPlatform(XsUbloxGnssPlatform ubloxGnssPlatform) override
Set the device GNSS platform for u-blox GNSS receivers.
Definition: mti6x0device.cpp:428
uint32_t
unsigned int uint32_t
Definition: pstdint.h:485
Mti6X0Device::setCanConfiguration
bool setCanConfiguration(uint32_t config) override
Set the CAN output configuration for this device.
Definition: mti6x0device.cpp:351
Mti6X0Device::canOutputConfiguration
XsCanOutputConfigurationArray canOutputConfiguration() const override
Returns the currently configured CAN output of the device.
Definition: mti6x0device.cpp:265
Mti6X0Device::portConfiguration
XsIntArray portConfiguration() const override
Get the current port configuration of a device.
Definition: mti6x0device.cpp:310
Mti6X0DeviceEx::Mti6X0DeviceEx
Mti6X0DeviceEx(XsDevice *master)
Constructs a device.
Definition: mti6x0device.h:124
XsUbloxGnssPlatform
XsUbloxGnssPlatform
Used to select u-blox GNSS chip platform.
Definition: xsubloxgnssplatform.h:72
Mti6X0Device
The MTi device used for the 6X0-series.
Definition: mti6x0device.h:73
Mti6X0Device::setStringOutputMode6x0
bool setStringOutputMode6x0(uint32_t type, uint16_t frequency)
Sets the string output mode for this device.
Definition: mti6x0device.cpp:213
Mti6X0Device::supportedStringOutputTypes
XsStringOutputTypeArray supportedStringOutputTypes() const override
Ask the device for its supported string output types.
Definition: mti6x0device.cpp:185
Mti6X0Device::Mti6X0Device
Mti6X0Device(Communicator *comm)
Constructs a device.
Definition: mti6x0device.cpp:87
Mti6X0DeviceEx::Mti6X0DeviceEx
Mti6X0DeviceEx(Communicator *comm)
Constructs a device.
Definition: mti6x0device.h:121
XsStringOutputTypeArray
A list of XsStringOutputType values.
XsCanOutputConfigurationArray
A list of XsCanOutputConfiguration values.
Mti6X0DeviceEx
The internal base class for MTi-6X0 series devices.
Definition: mti6x0device.h:118
MtiBaseDevice::BaseFrequencyResult
A struct for base frequency result.
Definition: mtibasedevice.h:124
Mti6X0Device::constructStandalone
static XsDevice * constructStandalone(Communicator *comm)
Constructs a standalone device using a provided communicator.
Definition: mti6x0device.h:77
Mti6X0Device::hasIccSupport
bool hasIccSupport() const override
Definition: mti6x0device.cpp:179
XsString
A 0-terminated managed string of characters.
XsDevice
Definition: xsdevice_def.h:164
Mti6X0Device::Mti6X0Device
Mti6X0Device(XsDevice *master)
An empty constructor for a master device.
Definition: mti6x0device.h:85
Mti6X0Device::setGnssLeverArm
bool setGnssLeverArm(const XsVector &arm) override
Sets the GNSS Lever Arm vector.
Definition: mti6x0device.cpp:371
MtiBaseDeviceEx
The internal base class for MTi devices.
Definition: mtibasedevice.h:161


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