Visioscan Set SDK Libraries 1.0.14
Visioscan Set SDK Help documentation file for C++ and C++/CLI
 
Loading...
Searching...
No Matches
NavigationSensor.h
1#pragma once
2#include "../RawDataSensor/RawDataSensor.h"
3#include"../StarfleetToolbox/ParameterNotSupportedException.h"
4#include "FilterType.h"
5
6using namespace std;
7
8#ifdef NAVIGATIONSENSOR_EXPORTS
9#define NAVIGATIONSENSOR __declspec(dllexport)
10#else
11#define NAVIGATIONSENSOR __declspec(dllimport)
12#endif
13
14#define SECTORS_COUNT 264
15#define IMAGE_SEGMENT_SIZE 20
16#define PIXELS_PER_SEGMENT 640
17
18
19#define ZERO_TO_ZERO_POINT_ZERO_FIVE_AT_TWENTY_HZ 2
20#define ZERO_TO_ZERO_POINT_ZERO_TWENTYFIVE_AT_TEN_HZ 3
21#define ZERO_TO_ZERO_POINT_ZERO_SOMETHING_AT_FIFTY_HZ 4
22
23typedef int PAGE_INDEX;
24#define CUSTOMIZE_LOGO_PAGE 0
25#define OPERATING_STATUS_PAGE 1
26#define WMS_STATUS_PAGE 2
27#define ETH_USB_CONNECT_STATUS_PAGE 3
28#define NETWORK_INFORMATION_PAGE 4
29#define BLUETHOOT_CONNECTION_PAGE 5
30
31typedef int OLED_WAKEUP_RANGE;
32#define THREE_HUNDRED_MM 0
33#define FIVE_HUNDRED_MM 1
34#define TEN_HUNDRED_MM 2
35#define FIFTEEN_HUNDRED_MM 3
36#define TWENTY_HUNDRED_MM 4
37
38typedef int OLED_WAKEUP_TIME;
39#define TWO_SEC 0
40#define THREE_SEC 1
41#define FIVE_SEC 2
42#define TEN_SEC 3
43
44typedef unsigned int PAGE_DIRECTION;
45#define NORMAL 0
46#define UPSIDE_DOWN 1
47
48typedef unsigned int DISPLAY_MODE;
49#define NORMAL_MODE 0
50#define ON_MODE 1
51#define OFF_MODE 2
52
53typedef unsigned int MDI_TRANSMISSION_STATUS;
54#define MDI_OFF_MODE 0
55#define MDI_ON_MODE 1
56
57typedef uint16_t IMAGE_PIXEL;
58typedef vector<IMAGE_PIXEL> LOGO_IMAGE_SEGMENT;
59
60class NAVIGATIONSENSOR NavigationSensor : public RawDataSensor
61{
62public:
67
72
77 NavigationSensor(BaseCommunication* comm);
78
84 ConfigurationResult SetAngularResolution(ANGULAR_RESOLUTION pResolution);
85
91 FilterType GetFilterType();
96 ConfigurationResult SetFilterType(FilterType pFilterType);
97
102 PAGE_INDEX GetDisplayPageIndex();
103
109 ConfigurationResult SetDisplayPageIndex(PAGE_INDEX pPageIndex);
110
111#ifndef LEUZE
116 PAGE_DIRECTION GetDisplayPageDirection();
117
123 ConfigurationResult SetDisplayPageDirection(PAGE_DIRECTION pPageDirection);
124#endif
125
126#ifndef LEUZE
131 DISPLAY_MODE GetDisplayMode();
132
133
139 ConfigurationResult SetDisplayMode(DISPLAY_MODE pdisplayMode);
140#endif
141
142#ifndef LEUZE
147 vector<LOGO_IMAGE_SEGMENT> GetLogoImage();
148
149
155 ConfigurationResult SetLogoImage(vector<LOGO_IMAGE_SEGMENT> pLogoImage);
156
161 ConfigurationResult ResetLogoImage();
162#endif
163
168 vector<unsigned int> GetWms() ;
169
175
182
188
189 // Command settings management
190 // Data retrieve
196
202
203 // DEPRECATED METHOD
204
210 [[deprecated("Use of this method is deprecated in Navigation sensor")]]
211 ConfigurationResult SetImmunityLevel(int pImmunityLevel) { return NULL; }
212
217 [[deprecated("Use of this method is deprecated in Navigation sensor")]]
218 unsigned int GetImmunityLevel() { return -1; }
219#ifndef LEUZE
224 OLED_WAKEUP_RANGE GetDisplayWakeUpRange();
225
231 ConfigurationResult SetDisplayWakeUpRange(OLED_WAKEUP_RANGE range);
232#endif
233
234#ifndef LEUZE
239 OLED_WAKEUP_RANGE GetDisplayWakeUpTime();
240
246 ConfigurationResult SetDisplayWakeUpTime(OLED_WAKEUP_RANGE range);
247#endif
252 MDI_TRANSMISSION_STATUS GetMdiTransmissionStatus();
253
257 void ShowDeviceIdentification();
258
259private:
260 string GetFilter = { 0x47, 0x65, 0x74, 0x46, 0x69, 0x6c, 0x74, 0x65, 0x72 };
261 string GetPageIndex = { 0x47, 0x65, 0x74, 0x50, 0x49, 0x6E, 0x64, 0x65, 0x78 };
262 string GetPageDirection = { 0x47, 0x65, 0x74, 0x50, 0x44, 0x69, 0x72 };
263 string GetCustomizedLogoImage = { 0x47, 0x65, 0x74, 0x43, 0x75, 0x73, 0x74, 0x49, 0x6D, 0x67 };
264 string GetDisplayPageMode = { 0x47, 0x65, 0x74, 0x50, 0x4D, 0x6F, 0x64, 0x65 };
265 string GetWmsValue = { 0x47, 0x65, 0x74, 0x57, 0x6D, 0x73 };
266 string GetARange = { 0x47, 0x65, 0x74, 0x41, 0x52, 0x61, 0x6E, 0x67, 0x65 };
267 string GetATime = { 0x47, 0x65, 0x74, 0x41, 0x54, 0x69, 0x6D, 0x65 };
268
269 string SetFilter = { 0x53, 0x65, 0x74, 0x46, 0x69, 0x6c, 0x74, 0x65, 0x72 };
270 string SetPageIndex = { 0x53, 0x65, 0x74, 0x50, 0x49, 0x6E, 0x64, 0x65, 0x78 };
271 string SetPageDirection = { 0x53, 0x65, 0x74, 0x50, 0x44, 0x69, 0x72 };
272 string SetCustomizedLogoImage = { 0x53, 0x65, 0x74, 0x43, 0x75, 0x73, 0x74, 0x49, 0x6D, 0x67 };
273 string SetDisplayPageMode = { 0x53, 0x65, 0x74, 0x50, 0x4D, 0x6F, 0x64, 0x65 };
274 string SetARange = { 0x53, 0x65, 0x74, 0x41, 0x52, 0x61, 0x6E, 0x67, 0x65 };
275 string SetATime = { 0x53, 0x65, 0x74, 0x41, 0x54, 0x69, 0x6D, 0x65 };
276
277 string GetShowId = { 0x47, 0x65, 0x74, 0x53, 0x68, 0x6F, 0x77, 0x49, 0x44 };
278 string GetTxMdi = { 0x47, 0x65, 0x74, 0x54, 0x78, 0x4D, 0x44, 0x49 };
279
280};
281
Helper to encapsulate the the raw data error.
Definition FilterType.h:20
Definition NavigationSensor.h:61
ConfigurationResult SetImmunityLevel(int pImmunityLevel)
Sets the sensor's immunity level.
Definition NavigationSensor.h:211
unsigned int GetImmunityLevel()
Gets the immunity level.
Definition NavigationSensor.h:218
Helper to encapsulate the contamination threshold.
Definition RawDataSensor/ContaminationStatus.h:12
Helper to encapsulate the network information.
Definition RawDataSensor/NetworkInformation.h:15
Definition of the Raw data sensor services. This header will let the programmer to handle all the req...
Definition RawDataSensor/RawDataSensor.h:65
SensorLeds GetSensorLeds()
Gets the sensor's leds status.
Definition RawDataSensor.cpp:718
ConfigurationResult SetAngularResolution(SensorResolutionFrequencyEnum pResolution)
Sets the angle resolution. Can be either 80Hz or 40Hz.
Definition RawDataSensor.cpp:1023
NetworkInformation GetNetworkInformation()
Gets whole data information.
Definition RawDataSensor.cpp:348
SensorLamps GetSensorLamps()
Gets the sensor lamps status.
Definition RawDataSensor.cpp:741
ContaminationStatus GetContaminationStatus()
Gets the contamination status.
Definition RawDataSensor.cpp:583
ConfigurationResult SetSensorLeds(SensorLeds pLeds)
Sets the sensors external leds status (ON or OFF)
Definition RawDataSensor.cpp:1256
Helper to encapsulate the sensor lamps state.
Definition RawDataSensor/SensorLamps.h:20
Helper to encapsulate the sensor leds state.
Definition RawDataSensor/SensorLeds.h:11
Helper to encapsulate the configuration result.
Definition RodConfigSoftware_Samples/RODConfigSoftwareSamples/includes/Toolbox/ConfigurationResult.h:15