NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
arcs_interface.h
Go to the documentation of this file.
1 
11 #ifndef SDK_ARCS_INTERFACE_H_
12 #define SDK_ARCS_INTERFACE_H_
13 #pragma once
14 
15 #include <base/inc/base_types.h>
16 #include <base/inc/sdk_results.h>
17 #include <base/inc/sdk_ref_ptr.h>
18 #include <base/inc/interfaces/enum/enum_interface.h>
19 #include <base/inc/sdk_component_interface.h>
20 #include <geometry/inc/geometry/geometry.h>
21 #include <datalayer/inc/arcs/component_ids.h>
22 #include <datalayer/inc/arcs/arcs_const.h>
23 #include <datalayer/inc/geodatabase/gdb_const.h>
24 #include <datalayer/inc/geodatabase/gdb_catalog.h>
25 #include <datalayer/inc/geodatabase/gdb_dataset.h>
26 #include <datalayer/inc/geodatabase/gdb_workspace.h>
27 #include <geometry/inc/coordinate_systems/crs_const.h>
28 #include <geometry/inc/coordinate_systems/crs_projection.h>
29 
30 SDK_ARCS_BEGIN_NAMESPACE
31 
34 
35 static const wchar_t kFolderNameChartCD[] = L"CHARTCD";
36 static const wchar_t kFolderNameUpdateCD[] = L"UPDATECD";
37 
38 static const SDKUInt32 kWholePlanIndex = -1;
39 
40 enum ARCSCDType {
41  kARCSCDType_Base = 0,
42  kARCSCDType_Update,
43  kARCSCDType_Unknown,
44 };
45 
46 enum VolumeDescription {
47  kVolumeDescription_CountryCode = 0,
48  kVolumeDescription_CdNumber,
49  kVolumeDescription_Copyright,
50  kVolumeDescription_CountryName,
51  kVolumeDescription_FormatCD,
52  kVolumeDescription_FormatVersion,
53  kVolumeDescription_Path,
54  kVolumeDescription_IssueDate
55 };
56 
57 enum ARCSDongleData {
58  kARCSDongleData_PIN = 0, // 4 bytes or 4 digital chars
59  kARCSDongleData_UID,
60  kARCSDongleData_MCDP,
61  kARCSDongleData_USER_PERMIT,
62  kARCSDongleData_DATE
63 };
64 
66 typedef enum ArcsCatalogEntryType {
67  kArcsCatEntryType_Charts = 0,
68  kArcsCatEntryType_Volumes,
69 } ArcsCatalogEntryType;
70 
72 typedef enum ARCSChartCatalogEntryProperty {
73  kARCSChartCatEntryProperty_ChartNumber = 0,
74  kARCSChartCatEntryProperty_RasterChartIssueDate,
75  kARCSChartCatEntryProperty_LatestCorrectionIssueDate,
76  kARCSChartCatEntryProperty_N00FileIssueDate,
77  kARCSChartCatEntryProperty_EditionDate,
78  kARCSChartCatEntryProperty_IntNumber,
79  kARCSChartCatEntryProperty_MainTitle,
80  kARCSChartCatEntryProperty_LatestNMNum,
81  kARCSChartCatEntryProperty_LatestNMYear,
82  kARCSChartCatEntryProperty_ChartCDNumber,
83  kARCSChartCatEntryProperty_Scale,
84  kARCSChartCatEntryProperty_DepthUnitCode,
85  kARCSChartCatEntryProperty_CountryOfOrigin,
86  kARCSChartCatEntryProperty_NumberOfPlans,
87  kARCSChartCatEntryProperty_IsSheetOfPlans,
88  kARCSChartCatEntryProperty_PlanNumber,
89  // Collection chart catalog entries of subplans
90  kARCSChartCatEntryProperty_Subplans,
91  // Coverage geometry
92  kARCSChartCatEntryProperty_Geometry,
93 } ARCSChartCatalogEntryProperty;
94 
95 
96 typedef enum ARCSPermitType {
97  kARCSPermitType_Navigator = 0,
98  kARCSPermitType_Skipper,
99 } ARCSPermitType;
100 
101 typedef enum ARCSPermitsProperties {
102  // Name of company or individual signing the licence.
103  kARCSPermitsProperty_License = 0,
104  // Navigator/Skipper
105  kARCSPermitsProperty_LicenseType,
106  kARCSPermitsProperty_VesselName,
107  kARCSPermitsProperty_Site1,
108  kARCSPermitsProperty_Site2,
109  kARCSPermitsProperty_Site3,
110  kARCSPermitsProperty_Site4,
111  kARCSPermitsProperty_Site5,
112  kARCSPermitsProperty_Site6,
113  kARCSPermitsProperty_HostSystemName,
114  // Hexadecimal user permit
115  kARCSPermitsProperty_UserPermit,
116  // Data for HO / Agent / Distributor use.
117  kARCSPermitsProperty_HO_Data,
118  // Message authentication code
119  kARCSPermitsProperty_MAC,
120  kARCSPermitsProperty_PermitsNum,
121  kARCSPermitsProperty_PermitsPath,
122  kARCSPermitsProperty_Status,
123  kARCSPermitsProperty_Date,
124 } ARCSPermitsProperties;
125 
126 
128 typedef enum ARCSPermitProperties {
129  kARCSPermitProperty_ChartNumber = 0,
130  kARCSPermitProperty_LicenseType,
131  // navigator chart service
132  // Permit expiration date
133  kARCSPermitProperty_ExpiredDate,
134  //Chart Encryption Version Number
135  kARCSPermitProperty_ENC,
136  //Permit Encryption Version Number
137  kARCSPermitProperty_PENC,
138  // skipper chart service
139  //Permit Sequential issue number
140  kARCSPermitProperty_PSeqNo,
141  //Permit NM Number
142  kARCSPermitProperty_PNM,
143  kARCSPermitProperty_IsValid,
144  kARCSPermitProperty_Status,
145 } ARCSPermitProperties;
146 
148 enum ARCSBitmapPalette {
149  kARCSBitmapPalette_Day = 0,
150  kARCSBitmapPalette_Dusk,
151  kARCSBitmapPalette_Night,
152 };
153 
155 typedef enum ARCSVolumesEntryProperty {
156  kARCSVolumesCatEntryProperty_CountryCode = kVolumeDescription_CountryCode,
157  kARCSVolumesCatEntryProperty_CdNumber = kVolumeDescription_CdNumber,
158  kARCSVolumesCatEntryProperty_Copyright = kVolumeDescription_Copyright,
159  kARCSVolumesCatEntryProperty_CountryName = kVolumeDescription_CountryName,
160  kARCSVolumesCatEntryProperty_FormatCD = kVolumeDescription_FormatCD,
161  kARCSVolumesCatEntryProperty_FormatVersion = kVolumeDescription_FormatVersion,
162  kARCSVolumesCatEntryProperty_Path = kVolumeDescription_Path,
163  kARCSVolumesCatEntryProperty_IssueDate = kVolumeDescription_IssueDate,
164  kARCSVolumesCatEntryProperty_Name = 100,
165 } ARCSVolumesEntryProperty;
166 
168 typedef enum ARCSDictionaryType {
169  kARCSDictionaryType_Countries = 0,
170  kARCSDictionaryType_Units,
171  kARCSDictionaryType_Projections,
172  kARCSDictionaryType_HorizontalDatums,
173  kARCSDictionaryType_VerticalDatums,
174  kARCSDictionaryType_Notes,
175 } ARCSDictionaryType;
176 
178 typedef enum ARCSChartProperty {
179  kARCSChartProperty_LatestNM = 0,
180  kARCSChartProperty_MirroringRaster,
181  kARCSChartProperty_Scale,
182  kARCSChartProperty_PlansManualShift,
183 } ARCSChartProperty;
184 
186 typedef enum ARCSPlanAttribute {
187  kARCSPlanAttribute_CountryCode = 1,
188  kARCSPlanAttribute_ChartNumber,
189  kARCSPlanAttribute_NXXFileIssueDate,
190  kARCSPlanAttribute_PanelNumber,
191  kARCSPlanAttribute_Scale,
192  kARCSPlanAttribute_DepthUnits,
193  kARCSPlanAttribute_HeightUnits,
194  kARCSPlanAttribute_PlanTitle,
195  kARCSPlanAttribute_SubpanelsNumber,
196  kARCSPlanAttribute_IsWGSProjectionSupported,
197  kARCSPlanAttribute_IsLocalProjectionSupported,
198  kARCSPlanAttribute_NotesNumber,
199  kARCSPlanAttribute_IsSheetOfPlans,
200  kARCSPlanAttribute_Status,
201  kARCSPlanAttribute_ProjectionName,
202  kARCSPlanAttribute_ProjectionSpheroidName,
203  kARCSPlanAttribute_HorizontalDatum,
204  kARCSPlanAttribute_HorizontalDatumSubArea,
205  kARCSPlanAttribute_DepthDatum,
206  kARCSPlanAttribute_HeightDatum,
207  kARCSPlanAttribute_WGS84ShiftDataNS,
208  kARCSPlanAttribute_WGS84ShiftDataEW,
209  kARCSPlanAttribute_WGS84AccuracyDataNS,
210  kARCSPlanAttribute_WGS84AccuracyDataEW,
211 } ARCSPlanAttribute;
212 
214 typedef enum ARCSPlanShiftProperty {
215  kARCSPlanShiftProperty_PlanNumber,
216  kARCSPlanShiftProperty_ShiftDataNS,
217  kARCSPlanShiftProperty_ShiftDataEW,
218 } ARCSPlanOffsetProperty;
219 
221 typedef enum PlanProjectionType {
222  kPlanProjectionType_WGS = 0,
223  kPlanProjectionType_Local,
224 } PlanProjectionType;
225 
226 typedef enum ARCSStatusCode {
227  kARCSStatusCode_01 = 0x00001,
228  kARCSStatusCode_02 = 0x00002,
229  kARCSStatusCode_03 = 0x00004,
230  kARCSStatusCode_04 = 0x00008,
231  kARCSStatusCode_05 = 0x00010,
232  kARCSStatusCode_06 = 0x00020,
233  kARCSStatusCode_07 = 0x00040,
234  kARCSStatusCode_08 = 0x00080,
235  kARCSStatusCode_09 = 0x00100,
236  kARCSStatusCode_10 = 0x00200,
237  kARCSStatusCode_11 = 0x00400,
238  kARCSStatusCode_12 = 0x00800,
239  kARCSStatusCode_13 = 0x01000,
240  kARCSStatusCode_14 = 0x02000,
241  kARCSStatusCode_15 = 0x04000,
242  kARCSStatusCode_16 = 0x08000,
243  kARCSStatusCode_17 = 0x10000,
244  kARCSStatusCode_18 = 0x20000,
245  kARCSStatusCode_19 = 0x40000,
246  kARCSStatusCode_20 = 0x80000,
247 } ARCSStatusCode;
248 
249 typedef SDKUInt32 ARCSStatus;
250 
251 FWD_DECL_INTERFACE(IARCSInstaller);
252 FWD_DECL_INTERFACE(IARCSCollection);
253 FWD_DECL_INTERFACE(IARCSCatalog);
254 FWD_DECL_INTERFACE(IARCSChart);
255 FWD_DECL_INTERFACE(IARCSObject);
256 FWD_DECL_INTERFACE(IARCSDongle);
257 FWD_DECL_INTERFACE(IARCSPermits);
258 FWD_DECL_INTERFACE(IARCSPlan);
259 FWD_DECL_INTERFACE(IARCSSubplan);
260 FWD_DECL_INTERFACE(IARCSNote);
261 FWD_DECL_INTERFACE(IARCSDictionary);
262 FWD_DECL_INTERFACE(IARCSRasterEx);
263 FWD_DECL_INTERFACE(IARCSInstallerUtils);
264 FWD_DECL_INTERFACE(IARCSUserPermitUtil);
265 FWD_DECL_INTERFACE(IARCSPlanShift);
266 
270 class IARCSInstaller : public ISDKComponent {
271 public:
272  virtual SDKResult SDK_CALLTYPE GetVolumeInfo(
273  const SDKString& volume_path,
274  ISDKPropertiesSP& info) throw() = 0;
275 
276  virtual SDKResult SDK_CALLTYPE InstallVolume(
277  const SDKString& volume_path,
278  const SDKString& collection_path) throw() = 0;
279 
280  virtual SDKResult SDK_CALLTYPE EnumVolumes(
281  SDK_NAMESPACE::IEnumSDKComponentSP& volumes) const throw() = 0;
282 
283  virtual SDKResult SDK_CALLTYPE UninstallVolumes(
284  const SDKString& volume_names) throw() = 0;
285 
286  virtual SDKResult SDK_CALLTYPE OpenChartCollection(
287  const SDKString& collection_path,
288  IARCSCollectionSP& collection) throw() = 0;
289 
290  SDK_IMPLEMENT_IID(IARCSInstaller);
291  SDK_END_INTERFACE(IARCSInstaller);
292 };
293 SDK_DECLARE_IID(IARCSInstaller)
294 
295 class IARCSInstallerUtils : public ISDKComponent {
296 public:
297  virtual SDKResult SDK_CALLTYPE CreatePermit(
298  IARCSPermitsSP& permit) throw() = 0;
299 
300  virtual SDKResult SDK_CALLTYPE CreateCoverageCatalog(
301  const SDKString& collection_path, const SDKString& catalog_path) throw() = 0;
302 
303  virtual SDKResult SDK_CALLTYPE CreateCoverageCatalog(
304  const IARCSCollectionSP& collection, const SDKString& catalog_path) throw() = 0;
305 
306  virtual SDKResult SDK_CALLTYPE CreatePlanShift(
307  IARCSPlanShiftSP& plan_shift) throw() = 0;
308 
309  SDK_IMPLEMENT_IID(IARCSInstallerUtils);
310  SDK_END_INTERFACE(IARCSInstallerUtils);
311 };
312 SDK_DECLARE_IID(IARCSInstallerUtils)
313 
314 
315 // With this interface you can add a new ARCS collection.
318 class IARCSCollection : public ISDKComponent {
319 public:
320  virtual SDKResult SDK_CALLTYPE SetPermit(
321  const IARCSPermitsSP& permit) throw() = 0;
322 
323  virtual SDKResult SDK_CALLTYPE GetPermit(
324  IARCSPermitsSP& permit) throw() = 0;
325 
326  virtual SDKResult SDK_CALLTYPE ReadVolumes(
327  const SDKAny& collection_path) throw() = 0;
328 
329  virtual SDKResult SDK_CALLTYPE GetChartByName(
330  const SDKString& chart_name,
331  SDK_ARCS_NAMESPACE::IARCSChartSP& chart) throw() = 0;
332 
333  virtual SDKResult SDK_CALLTYPE GetCharts(
334  const SDK_GEOMETRY_NAMESPACE::IGeometrySP& geometry_filter,
335  const SDK_GDB_NAMESPACE::IQueryParametersSP& query_parameters,
336  SDK_NAMESPACE::IEnumSDKComponentSP& charts) throw() = 0;
337 
338  virtual SDKResult SDK_CALLTYPE GetCatalog(
339  const ArcsCatalogEntryType type,
340  SDK_ARCS_NAMESPACE::IARCSCatalogSP& catalog) const throw() = 0;
341 
342  virtual SDKResult SDK_CALLTYPE GetDictionary(
343  SDK_ARCS_NAMESPACE::IARCSDictionarySP& dictionary) throw() = 0;
344 
345  SDK_IMPLEMENT_IID(IARCSCollection);
346  SDK_END_INTERFACE(IARCSCollection);
347 };
348 SDK_DECLARE_IID(IARCSCollection)
349 
350 class IARCSDongle : public ISDKComponent {
353 public:
354 
359  virtual SDKResult SDK_CALLTYPE Initialize(
360  const SDKString& dongle_data) throw() = 0;
361 
367  virtual SDKResult SDK_CALLTYPE GetHexString(
368  ARCSDongleData param,
369  SDKString& out_str) const throw() = 0;
370 
378  virtual SDKResult SDK_CALLTYPE Get(
379  ARCSDongleData param,
380  SDKUInt8* data,
381  SDKUInt32& data_size) const throw() = 0;
382 
383  virtual SDKResult SDK_CALLTYPE CreatePermit(const SDKString & pin,
384  const SDKString & uid,
385  const SDKString & mid1,
386  const SDKString & mid2,
387  SDKString & user_permit) throw() = 0;;
388 
389  SDK_IMPLEMENT_IID(IARCSDongle);
390  SDK_END_INTERFACE(IARCSDongle);
391 };
392 SDK_DECLARE_IID(IARCSDongle)
393 
394 class IARCSUserPermitUtil : public ISDKComponent {
397 public:
398 
399  virtual SDKResult SDK_CALLTYPE CreatePermit(const SDKString & pin,
400  const SDKString & uid,
401  const SDKString & mid1,
402  const SDKString & mid2,
403  SDKString & user_permit) throw() = 0;
404 
405  SDK_IMPLEMENT_IID(IARCSUserPermitUtil);
406  SDK_END_INTERFACE(IARCSUserPermitUtil);
407 };
408 SDK_DECLARE_IID(IARCSUserPermitUtil)
409 
410 class IARCSPermits : public sdk::ISDKProperties {
413 public:
418  virtual SDKResult SDK_CALLTYPE SetDongle(
419  const IARCSDongleSP& dongle) throw() = 0;
420 
425  virtual SDKResult SDK_CALLTYPE SetPermits(
426  const SDKString& permit_path) throw() = 0;
427 
433  virtual SDKResult SDK_CALLTYPE EnumPermits(
434  SDK_NAMESPACE::IEnumSDKComponentSP& permits) const throw() = 0;
435 
436  SDK_IMPLEMENT_IID(IARCSPermits);
437  SDK_END_INTERFACE(IARCSPermits);
438 };
439 SDK_DECLARE_IID(IARCSPermits)
440 
441 class IARCSCatalog : public SDK_GDB_NAMESPACE::ICatalog {
444 public:
453  virtual SDKResult SDK_CALLTYPE EnumCharts(
454  const SDK_GEOMETRY_NAMESPACE::IGeometrySP& geometry,
455  const SDK_GDB_NAMESPACE::IQueryParametersSP& query_parameters,
456  SDK_NAMESPACE::IEnumSDKComponentSP& enum_charts) throw() = 0;
457 
458  SDK_IMPLEMENT_IID(IARCSCatalog);
459  SDK_END_INTERFACE(IARCSCatalog);
460 };
461 SDK_DECLARE_IID(IARCSCatalog)
462 
463 class IARCSChart : public ISDKComponent {
466 public:
470  virtual SDKResult SDK_CALLTYPE GetStatus(ARCSStatus& status) const throw() = 0;
471 
476  virtual SDKResult SDK_CALLTYPE GetName(
477  SDKString& name) const throw() = 0;
478 
479  virtual SDKResult SDK_CALLTYPE GetRasterEx(SDKUInt8 palette,
480  bool indexed, bool low_resolution, IARCSRasterExSP& raster) throw() = 0;
481 
482  virtual SDKResult SDK_CALLTYPE GetPlansNumber(SDKUInt32 &number) throw() = 0;
483 
484  virtual SDKResult SDK_CALLTYPE GetPlan(SDKUInt32 number, IARCSPlanSP& pPlan) throw() = 0;
485 
486  virtual SDKResult SDK_CALLTYPE GetPalletesNum(SDKUInt32& num) throw() = 0;
487 
488  virtual SDKResult SDK_CALLTYPE GetDictionaryValue(const SDKUInt32 type, const
489  SDKAny& key, SDKAny& value) const throw() = 0;
490 
491  SDK_IMPLEMENT_IID(IARCSChart);
492  SDK_END_INTERFACE(IARCSChart);
493 };
494 SDK_DECLARE_IID(IARCSChart)
495 
496 class IARCSPlan : public ISDKComponent {
497 public:
498  virtual SDKResult SDK_CALLTYPE GetVertex(SDKUInt32 index,
499  geometry::IGeometrySP & pIGeometry) const throw() = 0;
500  virtual SDKResult SDK_CALLTYPE GetAttribute(SDKUInt32 id,
501  SDKAny& value) const throw() = 0;
502  virtual SDKResult SDK_CALLTYPE GetSubplanAttribute(SDKUInt32 index,
503  SDKUInt32 id, SDKAny& value) const throw() = 0;
504  virtual SDKResult SDK_CALLTYPE GetTestPoints(SDKUInt32 index,
505  geometry::IGeometrySP& pIGeoPoints,
506  geometry::IGeometrySP& pIMapPoints) const throw() = 0;
507  virtual SDKResult SDK_CALLTYPE GetProjection(SDKUInt32 index,
508  SDKUInt32 ptype, SDK_CRS_NAMESPACE::IProjectionSP& projection) const throw() = 0;
509  virtual SDKResult SDK_CALLTYPE GetNotes(
510  IEnumSDKComponentSP& notes) const throw() = 0;
511  virtual SDKResult SDK_CALLTYPE GetSubplanNum(SDKUInt32& count) const throw() = 0;
512  virtual SDKResult SDK_CALLTYPE GetSubplan(SDKUInt32 index,
513  IARCSSubplanSP& subplan) const throw() = 0;
514  virtual SDKResult SDK_CALLTYPE GetDataset(
515  SDK_GDB_NAMESPACE::IDatasetSP& dataset) const throw() = 0;
516 
517  SDK_IMPLEMENT_IID(IARCSPlan);
518  SDK_END_INTERFACE(IARCSPlan);
519 };
520 SDK_DECLARE_IID(IARCSPlan)
521 
522 class IARCSSubplan : public ISDKComponent {
523 public:
524  virtual SDKResult SDK_CALLTYPE GetVertex(
525  SDK_GEOMETRY_NAMESPACE::IGeometrySP& geometry) const throw() = 0;
526 
527  virtual SDKResult SDK_CALLTYPE GetTestPoints(
528  SDK_GEOMETRY_NAMESPACE::IGeometrySP& pIGeoPoints,
529  SDK_GEOMETRY_NAMESPACE::IGeometrySP& pIMapPoints) const throw() = 0;
530 
531  virtual SDKResult SDK_CALLTYPE GetAttribute(SDKUInt32 id,
532  SDKAny& value) const throw() = 0;
533 
534  virtual SDKResult SDK_CALLTYPE GetProjection(SDKUInt32 type,
535  SDK_CRS_NAMESPACE::IProjectionSP& projection) const throw() = 0;
536 
537  virtual SDKResult SDK_CALLTYPE GetNotes(
538  IEnumSDKComponentSP& notes) const throw() = 0;
539 
540  SDK_IMPLEMENT_IID(IARCSSubplan);
541  SDK_END_INTERFACE(IARCSSubplan);
542 };
543 SDK_DECLARE_IID(IARCSSubplan)
544 
545 
546 class IARCSNote : public ISDKComponent {
547 public:
548  virtual SDKResult SDK_CALLTYPE GetEnvelope(SDKRect2D& envelop) const throw() = 0;
549 
550  virtual SDKResult SDK_CALLTYPE GetType(SDKAny& type) const throw() = 0;
551 
552  virtual SDKResult SDK_CALLTYPE GetLocation(SDKAny& location) const throw() = 0;
553 
554  SDK_IMPLEMENT_IID(IARCSNote);
555  SDK_END_INTERFACE(IARCSNote);
556 };
557 SDK_DECLARE_IID(IARCSNote)
558 
559 class IARCSDictionary : public ISDKComponent {
562 public:
563  virtual SDKResult SDK_CALLTYPE GetClassCode(const SDKAny& key,
564  SDK_GDB_NAMESPACE::ClassCode& code) const throw() = 0;
565 
566  virtual SDKResult SDK_CALLTYPE GetValue(const SDKUInt32 type, const
567  SDKAny& key, SDKAny& value) const throw() = 0;
568 
569  virtual SDKResult SDK_CALLTYPE GetValue(const SDKUInt32 type,
570  const SDKAny& country, const SDKAny& key, SDKAny& value) const throw() = 0;
571 
572  SDK_IMPLEMENT_IID(IARCSDictionary);
573  SDK_END_INTERFACE(IARCSDictionary);
574 };
575 SDK_DECLARE_IID(IARCSDictionary);
576 
577 
578 class IARCSRasterEx : public ISDKComponent {
579 public:
580  virtual SDKResult SDK_CALLTYPE SetBuffer(SDKUInt8* data,
581  const SDKUInt32 data_size) throw() = 0;
582 
583  virtual SDKResult SDK_CALLTYPE GetInfo(SDKUInt32& raw_width,
584  SDKUInt32& raw_height, SDKUInt32& raw_stride,
585  SDKUInt32& raw_data_size, SDKUInt32& palette_size) const throw() = 0;
586  virtual SDKResult SDK_CALLTYPE GetData(const SDKUInt8** data,
587  SDKUInt32& real_width, SDKUInt32& real_height, SDKUInt32& real_stride,
588  SDKUInt32& real_data_size) const throw() = 0;
589  virtual SDKResult SDK_CALLTYPE GetPalette(const SDKUInt8* data,
590  SDKUInt32& data_size) const throw() = 0;
591 
592  SDK_IMPLEMENT_IID(IARCSRasterEx);
593  SDK_END_INTERFACE(IARCSRasterEx);
594 };
595 SDK_DECLARE_IID(IARCSRasterEx);
596 
597 
598 class IARCSPlanShift : public ISDKParameters {
599 public:
600  SDK_IMPLEMENT_IID(IARCSPlanShift);
601  SDK_END_INTERFACE(IARCSPlanShift);
602 };
603 SDK_DECLARE_IID(IARCSPlanShift);
604 
605 SDK_ARCS_END_NAMESPACE
606 
608 
609 #endif // SDK_ARCS_INTERFACE_H_
gdb_dataset.h
Describes interfaces that manages a geodatabase dataset object.
ARCSPlanAttribute
ARCSPlanAttribute
ARCS plan properties.
Definition: arcs_interface.h:186
IARCSPermits
Provides methods for permit management.
Definition: arcs_interface.h:412
PlanProjectionType
PlanProjectionType
ARCS projection type.
Definition: arcs_interface.h:221
IARCSInstaller
Provides methods to create ARCS collections. Use this interface to add a new ARCS Collection.
Definition: arcs_interface.h:270
ARCSPermitProperties
ARCSPermitProperties
ARCS catalog properties.
Definition: arcs_interface.h:128
ARCSPlanShiftProperty
ARCSPlanShiftProperty
ARCS plan properties.
Definition: arcs_interface.h:214
ARCSChartProperty
ARCSChartProperty
ARCS volumes properties.
Definition: arcs_interface.h:178
sdk_results.h
A list of SDK error/return results.
geometry.h
Describes interfaces that manages a geometry objects.
IARCSDongle
Provides methods for permit dongle.
Definition: arcs_interface.h:352
base_types.h
SDK base types.
IARCSCatalog
Provides methods for enumerate chart collections.
Definition: arcs_interface.h:443
IARCSDictionary
Provides methods for dictionary.
Definition: arcs_interface.h:561
arcs_const.h
Defines ARCS constants.
ARCSChartCatalogEntryProperty
ARCSChartCatalogEntryProperty
ARCS catalog properties.
Definition: arcs_interface.h:72
IARCSDongle::Initialize
virtual SDKResult SDK_CALLTYPE Initialize(const SDKString &dongle_data)=0
Initialize the dongle.
ARCSDictionaryType
ARCSDictionaryType
ARCS dictionary types.
Definition: arcs_interface.h:168
sdk_ref_ptr.h
Interfaces wrapper with reference count control.
gdb_workspace.h
Describes interfaces that manages a geodatabase workspace.
gdb_catalog.h
Describes interfaces that manages a geodatabase catalog.
IARCSDongle::GetHexString
virtual SDKResult SDK_CALLTYPE GetHexString(ARCSDongleData param, SDKString &out_str) const =0
Get the dongle content in hex.
crs_projection.h
Describes the interface that manages projection parameters.
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
IARCSDongle::Get
virtual SDKResult SDK_CALLTYPE Get(ARCSDongleData param, SDKUInt8 *data, SDKUInt32 &data_size) const =0
Get the dongle content in binary.
gdb_const.h
Geo database constants and structures.
sdk::ISDKProperties
Provides access to members that control the properties.
Definition: properties_interface.h:32
ClassCode
SDKUInt32 ClassCode
Definition of the ClassCode types.
Definition: gdb_const.h:229
IARCSPermits::SetDongle
virtual SDKResult SDK_CALLTYPE SetDongle(const IARCSDongleSP &dongle)=0
Set the dongle.
sdk_component_interface.h
Common base SDK interfaces.
IARCSCatalog::EnumCharts
virtual SDKResult SDK_CALLTYPE EnumCharts(const SDK_GEOMETRY_NAMESPACE::IGeometrySP &geometry, const SDK_GDB_NAMESPACE::IQueryParametersSP &query_parameters, SDK_NAMESPACE::IEnumSDKComponentSP &enum_charts)=0
Returns chart enumerator in the chart catalog with the specified geometric and semantic filters.
component_ids.h
All of objects IDs, which can be created by using CreateFactory method.
ARCSVolumesEntryProperty
ARCSVolumesEntryProperty
ARCS volumes properties.
Definition: arcs_interface.h:155
ISDKComponent
Base interface for all SDK interfaces.
Definition: sdk_component_interface.h:41
crs_const.h
Defines constants for the coordinate systems.
IARCSUserPermitUtil
Provides methods for user permit util.
Definition: arcs_interface.h:396
IARCSChart
Provides methods to access the ARCS chart.
Definition: arcs_interface.h:465
enum_interface.h
Describes a basic enumeration interfaces.
IARCSChart::GetStatus
virtual SDKResult SDK_CALLTYPE GetStatus(ARCSStatus &status) const =0
Returns the ARCS chart status.
IARCSPermits::SetPermits
virtual SDKResult SDK_CALLTYPE SetPermits(const SDKString &permit_path)=0
Set permits from the path.
ARCSBitmapPalette
ARCSBitmapPalette
ARCS palettes.
Definition: arcs_interface.h:148
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
IARCSPermits::EnumPermits
virtual SDKResult SDK_CALLTYPE EnumPermits(SDK_NAMESPACE::IEnumSDKComponentSP &permits) const =0
Enumerates the chart permits.
IARCSCollection
Provides methods to create ARCS chart collections.
Definition: arcs_interface.h:318
IARCSChart::GetName
virtual SDKResult SDK_CALLTYPE GetName(SDKString &name) const =0
Returns the ARCS chart name.