| Visioscan Set SDK Libraries 1.0.28 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
6 using 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
23 typedef 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
31 typedef 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
38 typedef 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
44 typedef unsigned int PAGE_DIRECTION;
45#define NORMAL 0
46#define UPSIDE_DOWN 1
47
48 typedef unsigned int DISPLAY_MODE;
49#define NORMAL_MODE 0
50#define ON_MODE 1
51#define OFF_MODE 2
52
53 typedef unsigned int MDI_TRANSMISSION_STATUS;
54#define MDI_OFF_MODE 0
55#define MDI_ON_MODE 1
56
57 typedef uint16_t IMAGE_PIXEL;
58 typedef vector<IMAGE_PIXEL> LOGO_IMAGE_SEGMENT;
59
60 class NAVIGATIONSENSOR NavigationSensor : public RawDataSensor
61{
62 public:
66 NavigationSensor();
67
71 ~NavigationSensor();
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
174 SensorLeds GetSensorLeds();
175
181 ConfigurationResult SetSensorLeds(SensorLeds pLeds);
182
187 SensorLamps GetSensorLamps();
188
189 // Command settings management
190 // Data retrieve
195 NetworkInformation GetNetworkInformation();
196
197 // DEPRECATED METHOD
203 [[deprecated("Use of this method is deprecated in Navigation sensor")]]
204 ConfigurationResult SetImmunityLevel(int pImmunityLevel) { return NULL; }
205
210 [[deprecated("Use of this method is deprecated in Navigation sensor")]]
211 unsigned int GetImmunityLevel() { return -1; }
212#ifndef LEUZE
217 OLED_WAKEUP_RANGE GetDisplayWakeUpRange();
218
224 ConfigurationResult SetDisplayWakeUpRange(OLED_WAKEUP_RANGE range);
225#endif
226
227#ifndef LEUZE
232 OLED_WAKEUP_RANGE GetDisplayWakeUpTime();
233
239 ConfigurationResult SetDisplayWakeUpTime(OLED_WAKEUP_RANGE range);
240#endif
245 MDI_TRANSMISSION_STATUS GetMdiTransmissionStatus();
246
250 void ShowDeviceIdentification();
251
252 private:
253 string GetFilter = { 0x47, 0x65, 0x74, 0x46, 0x69, 0x6c, 0x74, 0x65, 0x72 };
254 string GetPageIndex = { 0x47, 0x65, 0x74, 0x50, 0x49, 0x6E, 0x64, 0x65, 0x78 };
255 string GetPageDirection = { 0x47, 0x65, 0x74, 0x50, 0x44, 0x69, 0x72 };
256 string GetCustomizedLogoImage = { 0x47, 0x65, 0x74, 0x43, 0x75, 0x73, 0x74, 0x49, 0x6D, 0x67 };
257 string GetDisplayPageMode = { 0x47, 0x65, 0x74, 0x50, 0x4D, 0x6F, 0x64, 0x65 };
258 string GetWmsValue = { 0x47, 0x65, 0x74, 0x57, 0x6D, 0x73 };
259 string GetARange = { 0x47, 0x65, 0x74, 0x41, 0x52, 0x61, 0x6E, 0x67, 0x65 };
260 string GetATime = { 0x47, 0x65, 0x74, 0x41, 0x54, 0x69, 0x6D, 0x65 };
261
262 string SetFilter = { 0x53, 0x65, 0x74, 0x46, 0x69, 0x6c, 0x74, 0x65, 0x72 };
263 string SetPageIndex = { 0x53, 0x65, 0x74, 0x50, 0x49, 0x6E, 0x64, 0x65, 0x78 };
264 string SetPageDirection = { 0x53, 0x65, 0x74, 0x50, 0x44, 0x69, 0x72 };
265 string SetCustomizedLogoImage = { 0x53, 0x65, 0x74, 0x43, 0x75, 0x73, 0x74, 0x49, 0x6D, 0x67 };
266 string SetDisplayPageMode = { 0x53, 0x65, 0x74, 0x50, 0x4D, 0x6F, 0x64, 0x65 };
267 string SetARange = { 0x53, 0x65, 0x74, 0x41, 0x52, 0x61, 0x6E, 0x67, 0x65 };
268 string SetATime = { 0x53, 0x65, 0x74, 0x41, 0x54, 0x69, 0x6D, 0x65 };
269
270 string GetShowId = { 0x47, 0x65, 0x74, 0x53, 0x68, 0x6F, 0x77, 0x49, 0x44 };
271 string GetTxMdi = { 0x47, 0x65, 0x74, 0x54, 0x78, 0x4D, 0x44, 0x49 };
272
273};
274
FilterType
Helper to encapsulate the the raw data error.
Definition FilterType.h:20
NavigationSensor
Definition NavigationSensor.h:61
NavigationSensor::SetImmunityLevel
ConfigurationResult SetImmunityLevel(int pImmunityLevel)
Sets the sensor's immunity level.
Definition NavigationSensor.h:204
NavigationSensor::GetImmunityLevel
unsigned int GetImmunityLevel()
Gets the immunity level.
Definition NavigationSensor.h:211
NetworkInformation
Helper to encapsulate the network information.
Definition NetworkInformation.h:15
RawDataSensor
Definition of the Raw data sensor services. This header will let the programmer to handle all the req...
Definition RawDataSensor.h:65
RawDataSensor::GetSensorLeds
SensorLeds GetSensorLeds()
Gets the sensor's leds status.
Definition RawDataSensor.cpp:799
RawDataSensor::SetAngularResolution
ConfigurationResult SetAngularResolution(SensorResolutionFrequencyEnum pResolution)
Sets the angle resolution. Can be either 80Hz or 40Hz.
Definition RawDataSensor.cpp:1100
RawDataSensor::GetNetworkInformation
NetworkInformation GetNetworkInformation()
Gets whole data information.
Definition RawDataSensor.cpp:346
RawDataSensor::GetSensorLamps
SensorLamps GetSensorLamps()
Gets the sensor lamps status.
Definition RawDataSensor.cpp:822
RawDataSensor::SetSensorLeds
ConfigurationResult SetSensorLeds(SensorLeds pLeds)
Sets the sensors external leds status (ON or OFF)
Definition RawDataSensor.cpp:1333
SensorLamps
Helper to encapsulate the sensor lamps state.
Definition SensorLamps.h:20
SensorLeds
Helper to encapsulate the sensor leds state.
Definition SensorLeds.h:11
ConfigurationResult
Helper to encapsulate the configuration result.
Definition ConfigurationResult.h:15