-
Notifications
You must be signed in to change notification settings - Fork 3
/
constants.php
2904 lines (2780 loc) · 110 KB
/
constants.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
//
// Copyright (C) 2004-2011 by Autodesk, Inc.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of version 2.1 of the GNU Lesser
// General Public License as published by the Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
//
/// \defgroup MgFeaturePropertyType MgFeaturePropertyType
/// \ingroup Feature_Properties_Module
/// \{
///////////////////////////////////////////////////////////
/// \brief
/// Defines names for the different types of property
/// definitions. See MgPropertyDefinition::GetPropertyType.
///
class MgFeaturePropertyType
{
/////////////////////////////////////////////////
/// \brief
/// Type name for a data property definition. See
/// MgDataPropertyDefinition.
const DataProperty = 100 ;
////////////////////////////////////////////////////
/// \brief
/// Type name for an object property definition. See
/// MgObjectPropertyDefinition.
const ObjectProperty = 101 ;
//////////////////////////////////////////////////////
/// \brief
/// Type name for a geometric property definition. See
/// MgGeometricPropertyDefinition.
const GeometricProperty = 102 ;
///////////////////////////////////////////////////////////
/// \brief
/// Type name for an association property definition.
///
/// \remarks
/// Currently there is no class for an association property
/// definition.
const AssociationProperty = 103 ;
///////////////////////////////////////////////////
/// Type name for a raster property definition. See
/// MgRasterPropertyDefinition.
const RasterProperty = 104 ;
}
/// \defgroup MgMimeType MgMimeType
/// \ingroup Common_Module
/// \{
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// Mime types for data to be sent to clients.
class MgMimeType
{
/// \if INTERNAL
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
/// \endif
/// application/agf
const Agf = "application/agf"; /// \if INTERNAL \endif
/// application/octet-stream
const Binary = "application/octet-stream"; /// \if INTERNAL \endif
/// model/vnd.dwf
const Dwf = "model/vnd.dwf"; /// \if INTERNAL \endif
/// image/gif
const Gif = "image/gif"; /// \if INTERNAL \endif
/// image/jpeg
const Jpeg = "image/jpeg"; /// \if INTERNAL \endif
/// image/png
const Png = "image/png"; /// \if INTERNAL \endif
/// text/plain
const Text = "text/plain"; /// \if INTERNAL \endif
/// image/tiff
const Tiff = "image/tiff"; /// \if INTERNAL \endif
/// text/xml
const Xml = "text/xml"; /// \if INTERNAL \endif
/// application/json
const Json = "application/json"; /// \if INTERNAL \endif
/// text/html
const Html = "text/html"; /// \if INTERNAL \endif
/// application/vnd.google-earth.kml+xml
const Kml = "application/vnd.google-earth.kml+xml"; /// \if INTERNAL \endif
/// application/vnd.google-earth.kmz
const Kmz = "application/vnd.google-earth.kmz"; /// \if INTERNAL \endif
}
/// \defgroup MgPropertyType MgPropertyType
/// \ingroup Feature_Properties_Module
/// \{
////////////////////////////////////////////////////////////
/// \brief
/// Defines the names for the various property types.
///
/// \remarks
/// All of the property types are data property types except
/// Feature, Geometry, Null, and Raster.
///
class MgPropertyType
{
///////////////////////////////////////////////////
/// \brief
/// Type name for a null property.
///
/// \remarks
/// This property type name is not currently used.
const Null = 0 ;
/////////////////////////////////////////////////////////
/// \brief
/// Type name for a boolean property (MgBooleanProperty).
const Boolean = 1 ;
////////////////////////////////////////////////////////
/// \brief
/// Type name for a byte (unsigned 8 bit value) property
/// (MgByteProperty).
const Byte = 2 ;
//////////////////////////////////////////////////////////////
/// \brief
/// Type name for an MgDateTime property (MgDateTimeProperty).
const DateTime = 3 ;
/////////////////////////////////////////////////////////
/// \brief
/// Type name for a single precision floating point value
/// property (MgSingleProperty).
const Single = 4 ;
/////////////////////////////////////////////////////////
/// \brief
/// Type name for a double precision floating point value
/// property (MgDoubleProperty).
const Double = 5 ;
////////////////////////////////////////////////////////
/// \brief
/// Type name for a 16 bit signed integer value property
/// (MgInt16Property).
const Int16 = 6 ;
////////////////////////////////////////////////////////
/// \brief
/// Type name for a 32 bit signed integer value property
/// (MgInt32Property).
const Int32 = 7 ;
////////////////////////////////////////////////////////
/// \brief
/// Type name for a 64 bit signed integer value property
/// (MgInt64Property).
const Int64 = 8 ;
///////////////////////////////////////////////////////
/// \brief
/// Type name for a string property (MgStringProperty).
const String = 9 ;
////////////////////////////////////////////////
/// \brief
/// Type name for a Binary Large OBject property
/// (MgBlobProperty).
const Blob = 10 ;
///////////////////////////////////////////////////
/// \brief
/// Type name for a Character Large OBject property
/// (MgClobProperty).
const Clob = 11 ;
/////////////////////////////////////////////////////////
/// \brief
/// Type name for a feature property (MgFeatureProperty).
const Feature = 12 ;
///////////////////////////////////////////////////////////
/// \brief
/// Type name for a geometry property (MgGeometryProperty).
const Geometry = 13 ;
///////////////////////////////////////////////////////
/// \brief
/// Type name for a raster property (MgRasterProperty).
const Raster = 14 ;
///////////////////////////////////////////////////////
/// \brief
/// Type name for a decimal property.
/// \since 2.2
const Decimal = 15 ;
}
/// \defgroup MgLayerGroupType MgLayerGroupType
/// \ingroup Maps_and_Layers_Module
/// \{
////////////////////////////////////////////////////////////////
/// \brief
/// MgLayerGroupType defines integer constants used to identify
/// the type of a layer group.
class MgLayerGroupType
{
////////////////////////////////////////////
/// \brief
/// Specifies that the layer group is a normal layer group.
///
const Normal = 1 ;
/////////////////////////////////////////////////
/// \brief
/// Specifies that the layer is a base map layer group (i.e.
/// it contains base map layers).
///
const BaseMap = 2 ;
}
/// \defgroup MgLayerType MgLayerType
/// \ingroup Maps_and_Layers_Module
/// \{
////////////////////////////////////////////////////////////////
/// \brief
/// MgLayerType defines integer constants used to identify the
/// type of a layer.
class MgLayerType
{
////////////////////////////////////////////
/// \brief
/// Specifies that the layer is a dynamic layer.
///
const Dynamic = 1 ;
/////////////////////////////////////////////////
/// \brief
/// Specifies that the layer is a base map layer.
///
const BaseMap = 2 ;
}
/// \defgroup MgServiceType MgServiceType
/// \ingroup Common_Module
/// \{
//////////////////////////////////////////////////////////////////////////////
/// \brief
/// Service types for Platform services.
class MgServiceType
{
////////////////////////////////////////////////////////////////
/// Resource Service
const ResourceService = 0 ;
////////////////////////////////////////////////////////////////
/// DWF Drawing Service
const DrawingService = 1 ;
////////////////////////////////////////////////////////////////
/// FDO Feature Service
const FeatureService = 2 ;
////////////////////////////////////////////////////////////////
/// Mapping Service
const MappingService = 3 ;
////////////////////////////////////////////////////////////////
/// Rendering Service
const RenderingService = 4 ;
////////////////////////////////////////////////////////////////
/// Tile Service
const TileService = 5 ;
////////////////////////////////////////////////////////////////
/// Kml Service
const KmlService = 6 ;
////////////////////////////////////////////////////////////////
/// Profiling Service
const ProfilingService = 10 ;
}
/// \endcond
///////////////////////////////////////////////////////////////////////////////
/// \cond INTERNAL
/// \brief
/// MapGuide users.
///
class MgUser
{
/// Site Administrator (Built-in account for administering the site)
const Administrator = "Administrator";
/// Anonymous User (Built-in account for guests with Viewer roles)
const Anonymous = "Anonymous";
/// Map Author (Built-in account for users with Author roles)
const Author = "Author";
/// WFS User (Built-in account for WFS users with Viewer roles)
const WfsUser = "WfsUser";
/// WMS User (Built-in account for WMS users with Viewer roles)
const WmsUser = "WmsUser";
}
/// \endcond
///////////////////////////////////////////////////////////////////////////////
/// \cond INTERNAL
/// \brief
/// MapGuide groups.
///
class MgGroup
{
/// Everyone group (Built-in group to include all users)
const Everyone = "Everyone";
}
/// \endcond
///////////////////////////////////////////////////////////////////////////////
/// \cond INTERNAL
/// \brief
/// MapGuide roles.
///
class MgRole
{
/// Administrator role (with read/write permission to resources by default)
const Administrator = "Administrator";
/// Author role (with read/write permission to resources by default)
const Author = "Author";
/// Viewer role (with read-only permission to resources by default)
const Viewer = "Viewer";
}
/// \defgroup MgFeatureCommandType MgFeatureCommandType
/// \ingroup Feature_Service_classes
/// \{
/////////////////////////////////////////////////////////
/// \brief
/// Is a set of constants used to specify the type of an
/// MgFeatureCommand object.
///
class MgFeatureCommandType
{
/////////////////////////////////////////////////////
/// Specifies the type of an MgInsertFeatures object.
const InsertFeatures = 0 ;
/////////////////////////////////////////////////////
/// Specifies the type of an MgUpdateFeatures object.
const UpdateFeatures = 1 ;
/////////////////////////////////////////////////////
/// Specifies the type of an MgDeleteFeatures object.
const DeleteFeatures = 2 ;
/////////////////////////////////////////////////////
/// Specifies the type of an MgLockFeatures object.
const LockFeatures = 3 ;
/////////////////////////////////////////////////////
/// Specifies the type of an MgUnlockFeatures object.
const UnlockFeatures = 4 ;
}
/// \defgroup MgFeatureGeometricType MgFeatureGeometricType
/// \ingroup Feature_Service_classes
/// \{
/////////////////////////////////////////////////////////////////
/// \brief
/// Is a set of constants specifying the dimensions of geometries
/// which can be stored in a geometry property.
/// \remarks
/// The constants can be bit-wise OR'd together. A value of this
/// type is returned by
/// MgGeometricPropertyDefinition::GetGeometryTypes.
///
class MgFeatureGeometricType
{
/////////////////////////////////////////////////////////////
/// Represents zero-dimensional geometric primitives, such as
/// MgPoint.
const Point = 1 ;
////////////////////////////////////////////////////////////
/// Represents one-dimensional geometric primitives, such as
/// MgLineString and MgCurveString.
const Curve = 2 ;
////////////////////////////////////////////////////////////
/// Represents two-dimensional geometric primitives, such as
/// MgPolygon and MgCurvePolygon.
const Surface = 4 ;
//////////////////////////////////////////////////////////////
/// Represents three-dimensional geometric primitives, such as
/// Cubes.
const Solid = 8 ;
}
/// \defgroup MgFeatureSpatialOperations MgFeatureSpatialOperations
/// \ingroup Feature_Service_classes
/// \{
/////////////////////////////////////////////////////////////
/// \brief
/// Is a set of constants used to type spatial operations.
/// \remarks
/// A value from this set of constants is used as an argument
/// incalls to MgFeatureQueryOptions::SetSpatialFilter.
///
class MgFeatureSpatialOperations
{
//////////////////////////////////////////////////////////////////////////////////////////////
/// Test whether the geometric property value spatially \link Contains contains \endlink
/// the literal geometric value.
const Contains = 0 ;
//////////////////////////////////////////////////////////////////////////////////
/// Test whether the geometric property value \link Crosses crosses \endlink
/// the given geometry.
const Crosses = 1 ;
///////////////////////////////////////////////////////////////////////
/// Test whether the geometric property value is \link Disjoint disjoint \endlink
/// from the given geometry.
const Disjoint = 2 ;
//////////////////////////////////////////////////////////////////////////////////
/// Test whether the geometric property value is \link Equals equal \endlink
/// to the given geometry.
const Equals = 3 ;
////////////////////////////////////////////////////////////////
/// Test whether the geometric property \link Intersects intersects \endlink
/// the given geometry.
const Intersects = 4 ;
//////////////////////////////////////////////////////////////////////////////
/// Test whether the geometric property \link Overlaps overlaps \endlink
/// the given geometry.
const Overlaps = 5 ;
/////////////////////////////////////////////////////////////////
/// Test whether the geometric property \link Touches touches \endlink the
/// given geometry.
const Touches = 6 ;
/////////////////////////////////////////////////////////////////////////////
/// Test whether the geometric property is \link Within within \endlink
/// the given geometry.
const Within = 7 ;
//////////////////////////////////////////////////////////////////////////////////////////
/// Test whether the geometric property value is \link CoveredBy covered by \endlink
/// the given geometry.
const CoveredBy = 8 ;
/////////////////////////////////////////////////////////////////////////////
/// Test whether the geometric property is \link Inside inside \endlink
/// the given geometry.
const Inside = 9 ;
//////////////////////////////////////////////////////////////////////////////////////////////////////////
/// Test whether the envelope of the geometric property \link EnvelopeIntersects intersects \endlink
/// the envelope of the given geometry.
const EnvelopeIntersects = 10 ;
}
/// \defgroup MgObjectPropertyType MgObjectPropertyType
/// \ingroup Feature_Schema_Module
/// \{
///////////////////////////////////////////////////////////////
/// \brief
/// Defines the type of an MgObjectPropertionDefinition object
/// property, that is, whether the property ccontains a single
/// feature class object, or an unordered or ordered collection
/// of them.
///
class MgObjectPropertyType
{
////////////////////////////////////////////////////////////////
/// Signifies that the object property contains a single feature
/// class object.
const Value = 0 ;
//////////////////////////////////////////////////////////////
/// Signifies that the object property contains more than one
/// feature class object. The collection of objects is in no
/// particular order relative to the identity property defined
/// for the collection. See
/// MgObjectPropertyDefinition::GetIdentityProperty.
const Collection = 1 ;
/////////////////////////////////////////////////////////////////
/// Signifies that the object property contains more than one
/// feature class object in ascending or descending order
/// relative to the identity property defined for the collection.
/// See MgObjectPropertyDefinition::GetIdentityProperty.
const OrderedCollection = 2 ;
}
/// \defgroup MgOrderingOption MgOrderingOption
/// \ingroup Feature_Service_classes
/// \{
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// \brief
/// Defines a type used to specify the order in which features
/// are returned by MgFeatureService::SelectFeatures. This type
/// is used as an argument to the MgFeatureQueryOptions::SetOrderingFilter.
///
class MgOrderingOption
{
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// \brief
/// Signifies that the features are returned in ascending order
/// relative to the properties specified in the first argument of
/// MgFeatureQueryOptions::SetOrderingFilter.
const Ascending = 0 ;
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// \brief
/// Signifies that the features are returned in descending order
/// relative to the properties specified in the first argument of
/// MgFeatureQueryOptions::SetOrderingFilter.
const Descending = 1 ;
}
/// \defgroup MgParameterDirection MgParameterDirection
/// \ingroup Feature_Service_classes
/// \{
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// The MgParameterDirection defines integer constants used to signify the
/// direction in which a parameter value will be used within the context of a
/// FDO Command.
/// \since 2.2
class MgParameterDirection
{
///////////////////////////////////////////////////
/// \brief
/// Specifies that the parameter is an input parameter.
///
const Input = 0 ;
///////////////////////////////////////////////////
/// \brief
/// Specifies that the parameter is an output parameter.
///
const Output = 1 ;
///////////////////////////////////////////////////
/// \brief
/// Specifies that the parameter is an input & output parameter.
///
const InputOutput = 2 ;
///////////////////////////////////////////////////
/// \brief
/// Specifies that the parameter is a return parameter.
///
const Ret = 3 ;
}
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// Enumerated values used to determine the type
/// of units for plot decorations (scale bar).
class MgRasterDataModelType
{
/// \if INTERNAL
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
/// \endif
/// Data is organized in an unknown or provider specific manner.
const Unknown = 0;
/// Data is rectangular grid, floating point data model.
const Data = 1;
/// Data is one bit (black/white - bitonal) pixels.
const Bitonal = 2;
/// Data is monochrome (black->gray->white) pixels.
/// It is necessary to know the BitsPerPixel value to interpret the data.
const Gray = 3;
/// Data is red/green/blue (in that order) pixels.
/// It is necessary to know the BitsPerPixel value to interpret the data.
const RGB = 4;
/// Data is red/green/blue/alpha (in that order) pixels; RGB with transparency.
/// It is necessary to know the BitsPerPixel value to interpret the data.
const RGBA = 5;
/// Data is monochrome but backed by a pallette (value->pallette->colour) pixels.
/// It is necessary to know the BitsPerPixel value to interpret the data.
const Palette = 6;
}
/// \defgroup MgReaderType MgReaderType
/// \ingroup Feature_Service_classes
/// \{
///////////////////////////////////////////////////////////////
/// \brief
/// Type of reader represented by an MgReader
///
/// \remarks
/// Defines the type of a reader whose class is derived from
/// MgReader. The three derived classes are MgDataReader,
/// MgFeatureReader, and MgSqlDataReader. An MgReaderType value
/// is returned by the reader's GetReaderType method.
///
class MgReaderType
{
/////////////////////////////////////////////////////////
/// Signifies that the object is of type MgFeatureReader.
const FeatureReader = 0 ;
//////////////////////////////////////////////////////
/// Signifies that the object is of type MgDataReader.
const DataReader = 1 ;
/////////////////////////////////////////////////////////
/// Signifies that the object is of type MgSqlDataReader.
const SqlDataReader = 2 ;
}
/// \endcond
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// Defines names for the different types of repositories.
/// \see
/// MgResourceIdentifier::SetRepositoryType
/// \see
/// MgResourceIdentifier::GetRepositoryType
///
/// \ingroup Resource_Service_classes
///
class MgRepositoryType
{
/// \if INTERNAL
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
/// \endif
////////////////////////////////////////////////////////////////
/// The repository is the \link library library \endlink.
const Library = "Library"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// The repository is a \link session_repository session repository \endlink,
/// used to store temporary data.
/// \note1
///
const Session = "Session"; /// \if INTERNAL \endif
}
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// Defines names for the different types of resources.
/// \see
/// MgResourceIdentifier::GetResourceType
/// \see
/// MgResourceIdentifier::SetResourceType
///
/// \ingroup Resource_Service_classes
///
class MgResourceType
{
////////////////////////////////////////////////////////////////
/// \brief
/// This resource is the runtime definition of a map.
///
/// \note1
///
/// \remarks
/// It is stored in the session repository to represent the
/// currently visible layers and viewed extents of a map. It is
/// constructed using a \link MgResourceType::MapDefinition MapDefinition \endlink
/// and may contain additional layers which have been added "on
/// the fly" by a web application. See \ref Maps_and_Layers_Module "Maps and Layers"
/// for more details.
///
const Map = "Map"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// This resource is a map definition.
///
/// \note1
///
/// \remarks
/// It represents an authored map and contains references to a \link MgResourceType::MapDefinition LayerDefinition \endlink
/// for each layer comprising the map.
///
/// \note
/// This is different from a \link MgResourceType::Map Map \endlink
/// resource, which records the current state of a map as it is
/// being viewed by an end user.
///
/// \see \ref MapDefinition_schema "MapDefinition schema"
///
const MapDefinition = "MapDefinition"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// This resource is a layer definition.
///
/// \remarks
/// It represents the stylization for a specific map layer. It
/// may also reference \link drawing_source DrawingSources \endlink and \link feature_source FeatureSources \endlink
/// depending on the source of the data.
///
/// \see \ref LayerDefinition_schema "LayerDefinition schema"
///
const LayerDefinition = "LayerDefinition"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// This resource is a \link drawing_source drawing source \endlink.
///
/// \note1
///
/// \remarks
/// The resource contains information required by MapGuide
/// to access data contained in a DWF.
///
/// \see \ref DrawingSource_schema "DrawingSource schema"
///
const DrawingSource = "DrawingSource"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// This resource is a \link feature_source feature source \endlink.
///
/// \remarks
/// Feature sources access data through FDO data providers like
/// the Oracle FDO provider or the SDF FDO provider. The resource
/// content contains the information required to access the
/// data.
///
/// \see \ref FeatureSource_schema "FeatureSource schema"
///
const FeatureSource = "FeatureSource"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// This resource is a folder.
///
/// \note1
///
/// \remarks
/// Folders in a repository operate in a similar manner to file
/// system folders. They contain other resources and can be
/// nested to create resource trees.
///
const Folder = "Folder"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// This resource is a load procedure definition.
///
/// \note1
///
/// \remarks
/// It records how to load specific data.
///
/// \see \ref LoadProcedure_schema "LoadProcedure schema"
///
const LoadProcedure = "LoadProcedure"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// This resource is a print layout.
///
/// \note1
///
/// \remarks
/// A print layout defines how a map is printed. It sets the size
/// and resolution of the map on paper and also determines the
/// location of direction arrows, legends, and other features.
///
/// \see \ref PrintLayout_schema "PrintLayout schema"
///
const PrintLayout = "PrintLayout"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// This resource is the runtime definition of a selection.
///
/// \note1
///
/// \remarks
/// It is stored in the session repository to represent the
/// current selection on a map.
///
const Selection = "Selection"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// This resource is a symbol definition.
///
/// \remarks
/// It represents the stylization for a specific symbol.
///
/// \see \ref SymbolDefinition_schema "SymbolDefinition schema"
///
const SymbolDefinition = "SymbolDefinition"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// This resource is a library of symbols.
///
/// \note1
///
/// \remarks
/// Symbols from a symbol library can be placed on a map to represent points
/// of interest. Symbol libraries are referenced from \link MgResourceType::LayerDefinition LayerDefinitions \endlink.
///
/// \see \ref SymbolLibrary_schema "SymbolLibrary schema"
///
const SymbolLibrary = "SymbolLibrary"; /// \if INTERNAL v \endif
////////////////////////////////////////////////////////////////
/// \brief
/// This resource represents the screen layout for a specific
/// map.
///
/// \note1
///
/// \remarks
/// Web layouts determine the location and content of toolbars,
/// the viewed map area, the legend, and viewed items.
/// \n
///
/// \see \ref WebLayout_schema "WebLayout schema"
///
const WebLayout = "WebLayout"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// This resource represents a web application definition
///
/// \note1
///
/// \remarks
/// Application definitions determine the location and content of toolbars,
/// the viewed map area, the legend, and viewed items.
///
/// \see \ref ApplicationDefinition_schema "ApplicationDefinition schema"
///
const ApplicationDefinition = "ApplicationDefinition"; /// \if INTERNAL \endif
}
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// Substitution tags used within the XML file for a resource.
///
/// \note1
///
/// \remarks
/// These tags are replaced by the resource service during
/// processing. This enables the resource service to manage the
/// storage of \link resource_data resource data \endlink.
/// For more information, see the \DevGuide.
///
/// \todo
/// [[Add examples for all these. ]]
///
/// \ingroup Resource_Service_classes
///
class MgResourceTag
{
/// \if INTERNAL
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
/// \endif
///////////////////////////////////////////////////////////
/// \brief
/// Replaced with the name of the currently logged in user.
///
const LoginUsername = "%MG_LOGIN_USERNAME%"; /// \if INTERNAL \endif
///////////////////////////////////////////////////////////////
/// \brief
/// Replaced with the password of the currently logged in user.
///
const LoginPassword = "%MG_LOGIN_PASSWORD%"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////
/// \brief
/// Replaced with the default resource-specific username.
///
const Username = "%MG_USERNAME%"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// Replaced with the default resource-specific password.
///
const Password = "%MG_PASSWORD%"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// Replaced with the location of data files associated with the
/// given resource. The trailing "/" is included.
///
const DataFilePath = "%MG_DATA_FILE_PATH%"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// Denotes beginning of data path alias.
///
const DataPathAliasBegin = "%MG_DATA_PATH_ALIAS["; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// Denotes end of data path alias.
///
const DataPathAliasEnd = "]%"; /// \if INTERNAL \endif
}
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// Defines reserved names for resource data.
///
/// \ingroup Resource_Service_classes
///
class MgResourceDataName
{
/////////////////////////////////////////////////////////////////
/// \brief
/// Data name for adding default credentials to a resource.
///
/// \note1
///
/// \remarks
/// For an example, see \link MgResourceService::SetResourceData SetResourceData \endlink.
///
const UserCredentials = "MG_USER_CREDENTIALS"; /// \if INTERNAL \endif
}
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// Defines the different types of \link resource_data resource data \endlink.
///
/// \note1
///
/// \remarks
/// For more information, see the \DevGuide.
///
/// \ingroup Resource_Service_classes
///
class MgResourceDataType
{
/// \if INTERNAL
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
/// \endif
/////////////////////////////////////////////////////////////////
/// \brief
/// Resource data stored as a file on disk.
/// \note1
///
/// \remarks
/// MapGuide creates a separate directory for each resource
/// and stores all resource data files in that directory. The
/// directory name can be dynamically substituted into the XML
/// resource content using \link MgResourceTag::DataFilePath DataFilePath \endlink.
/// \n
/// Large files can be uploaded using \link MgResourceService::ApplyResourcePackage ApplyResourcePackage \endlink.
/// Web server limitations (timeouts, post message sizes, etc.)
/// will typically limit direct HTTP uploads of file resources to
/// a few megabytes.
///
const File = "File"; /// \if INTERNAL \endif
/////////////////////////////////////////////////////////////////
/// \brief
/// Stream resource data is stored as a binary stream in the
/// repository database.
/// \note1
///
/// \remarks
/// Streams provide quick access to smaller data sets like symbol
/// libraries. They are not intended for data streams larger than
/// a few megabytes. Large data sets should be stored as files.
///
const Stream = "Stream"; /// \if INTERNAL \endif
////////////////////////////////////////////////////////////////
/// \brief
/// Resource data is stored as a string.
/// \note1
///
/// \remarks
/// Strings are typically used for small pieces of text, such as
/// credentials to connect to a database.
///
const String = "String"; /// \if INTERNAL \endif
}
/// \endcond
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// Types of resource permissions.
///
/// \note1
///
/// \ingroup Resource_Service_classes
///
class MgResourcePermission
{
/// \if INTERNAL
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
/// \endif
/// No Access permission.
const NoAccess = "n"; /// \if INTERNAL \endif
/// Read-Only permission.
const ReadOnly = "r"; /// \if INTERNAL \endif
/// Read/Write permission.
const ReadWrite = "r,w"; /// \if INTERNAL \endif
}
/// \defgroup MgSpatialContextExtentType MgSpatialContextExtentType
/// \ingroup Feature_Service_classes
/// \{
/////////////////////////////////////////////////////////////////
/// \brief
/// The SpatialContextExtentType enumeration defines how the extent of
/// a context should be handled by the provider.
class MgSpatialContextExtentType
{
/// The spatial extent of the context is static and must be specified
/// when the context is created.
const scStatic = 0 ;
/// The spatial extent of the context is dynamic and changes as data is
/// added and removed from the context.
const scDynamic = 1 ;
}
/// \defgroup MgCoordinateDimension MgCoordinateDimension
/// \ingroup Geometry_Module_classes
/// \{
///////////////////////////////////////////////////////////////
/// \brief
/// MgCoordinateDimension defines a set of integer constants
/// which can be OR'd together to specify the dimensionality of
/// an MgCoordinate instance.
///
class MgCoordinateDimension
{
/////////////////////////////////////////////////////////
/// \brief
/// Specifies that the coordinate has X and Y ordinates.