[mapguide-commits] r6959 - in branches/2.4/MgDev/Common: Foundation/Data Geometry/CoordinateSystem MapGuideCommon/MapLayer MapGuideCommon/Services PlatformBase/Exception PlatformBase/MapLayer PlatformBase/Services
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Wed Aug 29 09:02:53 PDT 2012
Author: jng
Date: 2012-08-29 09:02:52 -0700 (Wed, 29 Aug 2012)
New Revision: 6959
Modified:
branches/2.4/MgDev/Common/Foundation/Data/PropertyDefinition.h
branches/2.4/MgDev/Common/Foundation/Data/PropertyType.h
branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystem.h
branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemDatum.h
branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemEllipsoid.h
branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemFactory.h
branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGrids.h
branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemMathComparator.h
branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemTransform.h
branches/2.4/MgDev/Common/MapGuideCommon/MapLayer/Map.h
branches/2.4/MgDev/Common/MapGuideCommon/Services/ProfilingService.h
branches/2.4/MgDev/Common/MapGuideCommon/Services/RenderingOptions.h
branches/2.4/MgDev/Common/MapGuideCommon/Services/RenderingService.h
branches/2.4/MgDev/Common/MapGuideCommon/Services/Site.h
branches/2.4/MgDev/Common/MapGuideCommon/Services/TileService.h
branches/2.4/MgDev/Common/PlatformBase/Exception/FdoException.h
branches/2.4/MgDev/Common/PlatformBase/MapLayer/LayerBase.h
branches/2.4/MgDev/Common/PlatformBase/MapLayer/MapBase.h
branches/2.4/MgDev/Common/PlatformBase/MapLayer/SelectionBase.h
branches/2.4/MgDev/Common/PlatformBase/Services/ClassDefinition.h
branches/2.4/MgDev/Common/PlatformBase/Services/FeatureReader.h
branches/2.4/MgDev/Common/PlatformBase/Services/FeatureSchema.h
branches/2.4/MgDev/Common/PlatformBase/Services/FeatureService.h
branches/2.4/MgDev/Common/PlatformBase/Services/GeometricPropertyDefinition.h
branches/2.4/MgDev/Common/PlatformBase/Services/GeometryTypeInfo.h
branches/2.4/MgDev/Common/PlatformBase/Services/Parameter.h
branches/2.4/MgDev/Common/PlatformBase/Services/ParameterCollection.h
branches/2.4/MgDev/Common/PlatformBase/Services/ParameterDirection.h
branches/2.4/MgDev/Common/PlatformBase/Services/Reader.h
branches/2.4/MgDev/Common/PlatformBase/Services/ResourceService.h
branches/2.4/MgDev/Common/PlatformBase/Services/Transaction.h
Log:
#2097: Use the \since directive in doxygen to indicate classes and methods introduced into the MapGuide API (source: Every MapGuide RFC submitted that involved API changes/additions) and add remarks about using MgMap() instead of the other one.
Modified: branches/2.4/MgDev/Common/Foundation/Data/PropertyDefinition.h
===================================================================
--- branches/2.4/MgDev/Common/Foundation/Data/PropertyDefinition.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/Foundation/Data/PropertyDefinition.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -33,6 +33,7 @@
/// to store objects constructed from the concrete property
/// definition classes.
///
+/// \since 2.2
class MG_FOUNDATION_API MgPropertyDefinition : public MgProperty
{
MG_DECL_DYNCREATE();
Modified: branches/2.4/MgDev/Common/Foundation/Data/PropertyType.h
===================================================================
--- branches/2.4/MgDev/Common/Foundation/Data/PropertyType.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/Foundation/Data/PropertyType.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -122,6 +122,7 @@
///////////////////////////////////////////////////////
/// \brief
/// Type name for a decimal property.
+ /// \since 2.2
static const int Decimal = 15;
};
/// \}
Modified: branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystem.h
===================================================================
--- branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystem.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystem.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -71,10 +71,14 @@
virtual STRING GetEllipsoid()=0; /// __get
virtual STRING GetEllipsoidDescription()=0; /// __get
+ /// \since 2.3
virtual INT32 GetEpsgCode (void)=0; /// __get
+ /// \since 2.3
virtual INT32 GetSridCode (void)=0; /// __get
+ /// \since 2.3
virtual INT16 GetEpsgQuadrant (void)=0; /// __get
+ /// \since 2.0
virtual MgCoordinateSystemMeasure* GetMeasure()=0;
virtual MgStringCollection* GetCategories()=0;
virtual MgCoordinateSystemCatalog* GetCatalog()=0;
Modified: branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemDatum.h
===================================================================
--- branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemDatum.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemDatum.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -70,6 +70,7 @@
virtual bool IsLegalGroup(CREFSTRING sGroup)=0;
virtual STRING GetSource()=0;
virtual void SetSource(CREFSTRING sSource)=0;
+ /// \since 2.3
virtual INT16 GetEpsgCode()=0;
virtual void SetEpsgCode(INT16 epsgCode)=0;
virtual bool IsLegalSource(CREFSTRING sSource)=0;
Modified: branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemEllipsoid.h
===================================================================
--- branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemEllipsoid.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemEllipsoid.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -68,6 +68,7 @@
virtual bool IsLegalGroup(CREFSTRING sGroup)=0;
virtual STRING GetSource()=0;
virtual void SetSource(CREFSTRING sSource)=0;
+ /// \since 2.3
virtual INT16 GetEpsgCode()=0;
virtual void SetEpsgCode(INT16 epsgCode)=0;
virtual bool IsLegalSource(CREFSTRING sSource)=0;
Modified: branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemFactory.h
===================================================================
--- branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemFactory.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemFactory.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -168,6 +168,7 @@
/// The target coordinate system
/// \return
/// The coordinate system transform that can be used to transform coordinates
+ /// \since 2.0
virtual MgCoordinateSystemTransform* GetTransform(MgCoordinateSystem* pSource,
MgCoordinateSystem* pTarget);
Modified: branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGrids.h
===================================================================
--- branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGrids.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemGrids.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -71,6 +71,8 @@
/// <b>type</b> of unit must be consistent with the type of grid being drawn.
/// That is, specifying a Angular unit type when drawing a UTM grid will cause
/// an exception at the time the request for (say) grid lines is issued.
+///
+/// \since 2.2
class MG_GEOMETRY_API MgCoordinateSystemGridSpecification : public MgGuardDisposable
{
PUBLISHED_API:
@@ -687,6 +689,8 @@
/// Grid boundaries iusually start out as rectangles, but are often converted
/// to a series of complex curves approximated by multi-segment lines (i.e.
/// line strings).
+///
+/// \since 2.2
class MG_GEOMETRY_API MgCoordinateSystemGridBoundary : public MgGuardDisposable
{
PUBLISHED_API:
@@ -717,6 +721,7 @@
//=============================================================================
// Abstract base class for all grid generation objects (generic and
// specialized).
+/// \since 2.2
class MG_GEOMETRY_API MgCoordinateSystemGridBase : public MgGuardDisposable
{
PUBLISHED_API:
@@ -783,6 +788,7 @@
// the viewport coordinate system. The value returned by GetGridOrientation
// indicates the nature of the grid line in grid coordinates (i.e. easting or
// northing).
+/// \since 2.2
class MG_GEOMETRY_API MgCoordinateSystemGridLine : public MgGuardDisposable
{
PUBLISHED_API:
@@ -817,6 +823,7 @@
// //
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
+/// \since 2.2
class MG_GEOMETRY_API MgCoordinateSystemGridRegion : public MgGuardDisposable
{
PUBLISHED_API:
@@ -853,6 +860,7 @@
// In the case of a tick mark on a boundary line, since boundary lines are
// always maintained in the counterclockwise direction, the interior of the
// viewport will always be to the left of the direction vector.
+/// \since 2.2
class MG_GEOMETRY_API MgCoordinateSystemGridTick : public MgGuardDisposable
{
PUBLISHED_API:
@@ -878,6 +886,7 @@
// appear first in ascending order by grid value (easting in this case);
// followed by grid vertical lines in ascending order by grid value (northing
// in this case).
+/// \since 2.2
class MG_GEOMETRY_API MgCoordinateSystemGridLineCollection : public MgGuardDisposable
{
PUBLISHED_API:
@@ -904,6 +913,7 @@
//=============================================================================
// An MgCoordinateSystemGridRegionCollection is collection of
// MgCoordinateSystemGridRegion objects.
+/// \since 2.2
class MG_GEOMETRY_API MgCoordinateSystemGridRegionCollection : public MgGuardDisposable
{
PUBLISHED_API:
@@ -930,6 +940,7 @@
// MgCoordinateSystemGridTick objects. MgCoordinateSystemGridTickCollection
// objects will contain MgCoordinateSystemGridTick objects for the entire
// boundary, or for an individual grid line.
+/// \since 2.2
class MG_GEOMETRY_API MgCoordinateSystemGridTickCollection : public MgGuardDisposable
{
PUBLISHED_API:
Modified: branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemMathComparator.h
===================================================================
--- branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemMathComparator.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemMathComparator.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -38,6 +38,7 @@
/// when comparing datums. By default, this class compares any geodetic transformation
/// information it finds. If set to false, the MgCoordinateSystemMathComparator::SameDatum method
/// only compares ellipsoid information and any other, non-transformation related, properties.
+ /// \since 2.3
virtual void SetCompareInternalDatumOldParameters(bool) = 0;
/////////////////////////////////////////////////////////////
@@ -45,6 +46,7 @@
/// Returns the current comparison behavior for datums of this MgCoordinateSystemMathComparator
/// object. If true (default), this comparator compares geodetic transformation information
/// it might find for a datum object. If false, this comparison step is skipped.
+ /// \since 2.3
virtual bool GetCompareInternalDatumOldParameters() = 0;
protected:
Modified: branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemTransform.h
===================================================================
--- branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemTransform.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemTransform.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -489,8 +489,11 @@
virtual bool IsIgnoreOutsideDomainWarning()=0;
// Status Accumulator
+ /// \since 2.4
virtual INT32 GetSourceWarningCount (void)=0;
+ /// \since 2.4
virtual INT32 GetdatumWarningCount (void)=0;
+ /// \since 2.4
virtual INT32 GetTargetWarningCount (void)=0;
// Transformation status
Modified: branches/2.4/MgDev/Common/MapGuideCommon/MapLayer/Map.h
===================================================================
--- branches/2.4/MgDev/Common/MapGuideCommon/MapLayer/Map.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/MapGuideCommon/MapLayer/Map.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -256,6 +256,16 @@
/// MgMap();
/// \htmlinclude SyntaxBottom.html
///
+ /// \remarks
+ /// If you use this constructor, the following methods of the associated layer objects
+ /// are not available to be used.
+ /// \li MgLayerBase::GetClassDefinition()
+ /// \li MgLayerBase::SelectFeatures(MgFeatureQueryOptions*)
+ /// \li MgLayerBase::SelectAggregate(MgFeatureAggregateOptions*)
+ /// \li MgLayerBase::UpdateFeatures(MgFeatureCommandCollection*)
+ ///
+ /// To take advantage of these methods, you must use the following method instead:
+ /// \link MgMap(MgSiteConnection*) MgMap(MgSiteConnection* siteConnection) \endlink
MgMap();
//////////////////////////////////////////////////////////////////
Modified: branches/2.4/MgDev/Common/MapGuideCommon/Services/ProfilingService.h
===================================================================
--- branches/2.4/MgDev/Common/MapGuideCommon/Services/ProfilingService.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/MapGuideCommon/Services/ProfilingService.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -24,6 +24,7 @@
/// \brief
/// This class provides services to profile exsiting MapGuide APIs
+/// \since 2.4
class MG_MAPGUIDE_API MgProfilingService : public MgService
{
PUBLISHED_API:
Modified: branches/2.4/MgDev/Common/MapGuideCommon/Services/RenderingOptions.h
===================================================================
--- branches/2.4/MgDev/Common/MapGuideCommon/Services/RenderingOptions.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/MapGuideCommon/Services/RenderingOptions.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -26,6 +26,7 @@
/// \brief
/// Options for Rendering Service.
///
+/// \since 2.0
class MG_MAPGUIDE_API MgRenderingOptions: public MgSerializable
{
MG_DECL_DYNCREATE();
Modified: branches/2.4/MgDev/Common/MapGuideCommon/Services/RenderingService.h
===================================================================
--- branches/2.4/MgDev/Common/MapGuideCommon/Services/RenderingService.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/MapGuideCommon/Services/RenderingService.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -139,6 +139,7 @@
/// \return
/// A byte reader containing the rendered image
///
+ /// \since 2.0
virtual MgByteReader* RenderDynamicOverlay(
MgMap* map,
MgSelection* selection,
@@ -492,6 +493,7 @@
/// An MgSelection instance identifying the features that meet the
/// selection criteria. Returns null if no features are identified.
///
+ /// \since 1.2
virtual MgFeatureInformation* QueryFeatures(
MgMap* map,
MgStringCollection* layerNames,
@@ -570,6 +572,7 @@
/// An MgSelection instance identifying the features that meet the
/// selection criteria. Returns null if no features are identified.
///
+ /// \since 1.2
virtual MgBatchPropertyCollection* QueryFeatureProperties(
MgMap* map,
MgStringCollection* layerNames,
Modified: branches/2.4/MgDev/Common/MapGuideCommon/Services/Site.h
===================================================================
--- branches/2.4/MgDev/Common/MapGuideCommon/Services/Site.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/MapGuideCommon/Services/Site.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -339,6 +339,7 @@
/// \todo
/// [[What are the exceptions?]]
///
+ /// \since 2.2
INT32 GetSessionTimeout();
////////////////////////////////////////////////////////////////
@@ -369,6 +370,7 @@
/// \see
/// CreateSession
///
+ /// \since 2.0
STRING GetUserForSession();
///////////////////////////////////////////////////////////////////////////////////
@@ -381,6 +383,7 @@
/// \exception MgConnectionNotOpenException
/// \exception MgUserNotFoundException
///
+ /// \since 2.0
MgByteReader* EnumerateGroups( CREFSTRING user );
///////////////////////////////////////////////////////////////////////////////////
@@ -393,6 +396,7 @@
/// \exception MgConnectionNotOpenException
/// \exception MgUserNotFoundException
///
+ /// \since 2.0
MgStringCollection* EnumerateRoles( CREFSTRING user );
EXTERNAL_API:
Modified: branches/2.4/MgDev/Common/MapGuideCommon/Services/TileService.h
===================================================================
--- branches/2.4/MgDev/Common/MapGuideCommon/Services/TileService.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/MapGuideCommon/Services/TileService.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -109,6 +109,7 @@
/// \return
/// Default width of a tile in pixels.
///
+ /// \since 1.2
virtual INT32 GetDefaultTileSizeX() = 0;
//////////////////////////////////////////////////////////////////
@@ -118,6 +119,7 @@
/// \return
/// Default height of a tile in pixels.
///
+ /// \since 1.2
virtual INT32 GetDefaultTileSizeY() = 0;
INTERNAL_API:
Modified: branches/2.4/MgDev/Common/PlatformBase/Exception/FdoException.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Exception/FdoException.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Exception/FdoException.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -35,6 +35,7 @@
/// \return
/// native error code of an fdo exception
///
+ /// \since 2.2
INT64 GetNativeErrorCode();
EXTERNAL_API:
Modified: branches/2.4/MgDev/Common/PlatformBase/MapLayer/LayerBase.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/MapLayer/LayerBase.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/MapLayer/LayerBase.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -734,6 +734,7 @@
/// \exception MgInvalidArgumentException
/// \exception MgFdoException
///
+ /// \since 1.2
virtual MgClassDefinition* GetClassDefinition();
//////////////////////////////////////////////////////////////////
@@ -769,6 +770,7 @@
/// \exception MgInvalidArgumentException
/// \exception MgFdoException
///
+ /// \since 1.2
virtual MgFeatureReader* SelectFeatures(MgFeatureQueryOptions* options);
//////////////////////////////////////////////////////////////////
@@ -803,6 +805,7 @@
/// \exception MgInvalidArgumentException
/// \exception MgFdoException
///
+ /// \since 1.2
virtual MgDataReader* SelectAggregate(MgFeatureAggregateOptions* options);
//////////////////////////////////////////////////////////////////
@@ -860,6 +863,7 @@
/// \exception MgInvalidOperationException
/// \exception MgFdoException
///
+ /// \since 1.2
virtual MgPropertyCollection* UpdateFeatures(MgFeatureCommandCollection* commands);
INTERNAL_API:
Modified: branches/2.4/MgDev/Common/PlatformBase/MapLayer/MapBase.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/MapLayer/MapBase.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/MapLayer/MapBase.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -460,6 +460,7 @@
/// \param dpi (int)
/// Number of dots per inch of the map display
///
+ /// \since 2.4
virtual void SetDisplayDpi(INT32 dpi);
//////////////////////////////////////////////////////////////////
@@ -578,6 +579,7 @@
/// \return
/// Background color.
///
+ /// \since 2.4
virtual STRING GetBackgroundColor();
EXTERNAL_API:
Modified: branches/2.4/MgDev/Common/PlatformBase/MapLayer/SelectionBase.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/MapLayer/SelectionBase.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/MapLayer/SelectionBase.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -89,6 +89,7 @@
/// Returns Count of all selected features.
///
/// \note2
+ /// \since 2.0
INT32 GetSelectedFeaturesCount(MgLayerBase* layer, CREFSTRING className);
/// \brief
@@ -117,6 +118,7 @@
/// feature class in this selection.
///
/// \note2
+ /// \since 2.0
virtual MgFeatureReader* GetSelectedFeatures(MgLayerBase* layer, CREFSTRING className, bool mappedOnly);
/// Returns the selected feature data for the specified feature class.
@@ -144,6 +146,7 @@
/// feature class in this selection.
///
/// \note2
+ /// \since 2.0
virtual MgFeatureReader* GetSelectedFeatures(MgLayerBase* layer, CREFSTRING className, MgStringCollection* propertyNames);
/////////////////////////////////////////////////////////////////
Modified: branches/2.4/MgDev/Common/PlatformBase/Services/ClassDefinition.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Services/ClassDefinition.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Services/ClassDefinition.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -317,6 +317,7 @@
/// \return
/// Returns nothing.
///
+ /// \since 2.2
void Delete();
EXTERNAL_API:
Modified: branches/2.4/MgDev/Common/PlatformBase/Services/FeatureReader.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Services/FeatureReader.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Services/FeatureReader.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -373,6 +373,7 @@
/// \exception MgNullPropertyValueException
/// \exception MgFdoException
///
+ /// \since 2.2
virtual MgFeatureReader* GetFeatureObject(INT32 index) = 0;
Modified: branches/2.4/MgDev/Common/PlatformBase/Services/FeatureSchema.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Services/FeatureSchema.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Services/FeatureSchema.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -199,6 +199,7 @@
/// \return
/// Returns nothing.
///
+ /// \since 2.2
void Delete();
INTERNAL_API:
Modified: branches/2.4/MgDev/Common/PlatformBase/Services/FeatureService.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Services/FeatureService.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Services/FeatureService.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -385,11 +385,15 @@
/// \exception MgInvalidArgumentException
/// \exception MgFdoException
///
+ /// \since 2.3
virtual MgByteReader* GetCapabilities(CREFSTRING providerName, CREFSTRING connectionString) = 0;
/////////////////////////////////////////////////////////////////////////////////////////////
/// \brief
- /// Creates or updates a feature schema within the specified feature source.
+ /// Creates or updates a feature schema within the specified feature source. For this method to
+ /// actually delete any schema elements, the matching elements in the input schema must be marked
+ /// for deletion using the MgFeatureSchema::Delete(), MgClassDefinition::Delete() and
+ /// MgPropertyDefinition::Delete() methods
///
/// <!-- Syntax in .Net, Java, and PHP -->
/// \htmlinclude DotNetSyntaxTop.html
@@ -410,6 +414,7 @@
/// \return
/// Returns nothing.
///
+ /// \since 2.2
virtual void ApplySchema(MgResourceIdentifier* resource, MgFeatureSchema* schema) = 0;
///////////////////////////////////////////////////////////////////////////
@@ -460,6 +465,7 @@
/// provider documents for details on connection properties,
/// schema and classes.
///
+ /// \since 2.1
virtual MgFeatureSchemaCollection* DescribeSchema(MgResourceIdentifier* resource,
CREFSTRING schemaName,
MgStringCollection* classNames) = 0;
@@ -469,7 +475,7 @@
/// Gets the definitions of one or more schema contained in the
/// feature source. See \link Feature_Schema_Module Feature Schema \endlink.
///
- /// \remarks
+ /// \deprecated
/// This method has been deprecated. Use the following method:
/// \link MgFeatureService::DescribeSchema(MgResourceIdentifier* resource, CREFSTRING schemaName, MgStringCollection* classNames)
/// DescribeSchema(MgResourceIdentifier* resource, CREFSTRING schemaName, MgStringCollection* classNames) \endlink.
@@ -556,6 +562,7 @@
/// \exception MgInvalidArgumentException
/// \exception MgFdoException
///
+ /// \since 2.1
virtual STRING DescribeSchemaAsXml(MgResourceIdentifier* resource,
CREFSTRING schemaName,
MgStringCollection* classNames) = 0;
@@ -570,6 +577,8 @@
/// FDO XML schema, which are based on OGC GML schema. How to
/// specify a schema definition in XML is discussed in the
/// Autodesk FDO API Developer's Guide.
+ ///
+ /// \deprecated
/// This method has been deprecated. Use the following method:
/// \link MgFeatureService::DescribeSchemaAsXml(MgResourceIdentifier* resource, CREFSTRING schemaName, MgStringCollection* classNames)
/// DescribeSchemaAsXml(MgResourceIdentifier* resource, CREFSTRING schemaName, MgStringCollection* classNames) \endlink.
@@ -968,6 +977,7 @@
/// \exception MgInvalidOperationException
/// \exception MgFdoException
///
+ /// \since 2.2
virtual MgPropertyCollection* UpdateFeatures(MgResourceIdentifier* resource,
MgFeatureCommandCollection* commands,
MgTransaction* transaction) = 0;
@@ -1042,6 +1052,7 @@
/// \exception MgInvalidOperationException
/// \exception MgFdoException
///
+ /// \since 2.2
virtual MgTransaction* BeginTransaction(MgResourceIdentifier* resource) = 0;
////////////////////////////////////////////////////////////////////////////////////////////////
@@ -1150,6 +1161,7 @@
/// \exception MgInvalidOperationException
/// \exception MgFdoException
///
+ /// \since 2.2
virtual MgSqlDataReader* ExecuteSqlQuery(MgResourceIdentifier* resource,
CREFSTRING sqlStatement,
MgParameterCollection* parameters,
@@ -1256,6 +1268,7 @@
/// \exception MgInvalidOperationException
/// \exception MgFdoException
///
+ /// \since 2.2
virtual INT32 ExecuteSqlNonQuery(MgResourceIdentifier* resource,
CREFSTRING sqlNonSelectStatement,
MgParameterCollection* parameters,
Modified: branches/2.4/MgDev/Common/PlatformBase/Services/GeometricPropertyDefinition.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Services/GeometricPropertyDefinition.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Services/GeometricPropertyDefinition.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -95,6 +95,7 @@
/// \return
/// Returns a list of geometry types that are supported.
///
+ /// \since 2.0
MgGeometryTypeInfo * GetSpecificGeometryTypes(); /// __get, __set
//////////////////////////////////////////////////////////////
@@ -256,6 +257,7 @@
/// \return
/// Returns nothing.
///
+ /// \since 2.0
void SetSpecificGeometryTypes(MgGeometryTypeInfo * typeInfo);
/////////////////////////////////////////////////////////////////////////////////////////
Modified: branches/2.4/MgDev/Common/PlatformBase/Services/GeometryTypeInfo.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Services/GeometryTypeInfo.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Services/GeometryTypeInfo.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -28,6 +28,7 @@
/// \brief
/// Defines a list of geometric types. This is typically used for geometric property description.
///
+/// \since 2.0
class MG_PLATFORMBASE_API MgGeometryTypeInfo : public MgSerializable
{
MG_DECL_DYNCREATE();
Modified: branches/2.4/MgDev/Common/PlatformBase/Services/Parameter.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Services/Parameter.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Services/Parameter.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -29,6 +29,7 @@
/// parameter when a command is executed. Typically, it is used to bind
/// parameters to the SQL command.
///
+/// \since 2.2
class MG_PLATFORMBASE_API MgParameter : public MgNamedSerializable
{
MG_DECL_DYNCREATE();
Modified: branches/2.4/MgDev/Common/PlatformBase/Services/ParameterCollection.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Services/ParameterCollection.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Services/ParameterCollection.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -37,6 +37,7 @@
/// \note
/// Collections are <i>not</i> thread safe and ordered in the sequence of add operation.
///
+/// \since 2.2
class MG_PLATFORMBASE_API MgParameterCollection : public MgCollection
{
MG_DECL_DYNCREATE();
Modified: branches/2.4/MgDev/Common/PlatformBase/Services/ParameterDirection.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Services/ParameterDirection.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Services/ParameterDirection.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -27,6 +27,7 @@
/// 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 MG_FOUNDATION_API MgParameterDirection
{
PUBLISHED_API:
Modified: branches/2.4/MgDev/Common/PlatformBase/Services/Reader.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Services/Reader.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Services/Reader.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -106,6 +106,7 @@
/// \return
/// Returns the property name.
///
+ /// \since 2.2
virtual STRING GetPropertyName(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -154,6 +155,7 @@
/// \return
/// Returns an MgPropertyType value.
///
+ /// \since 2.2
virtual INT32 GetPropertyType(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -611,6 +613,7 @@
/// \return
/// Returns the property index.
///
+ /// \since 2.2
virtual INT32 GetPropertyIndex(CREFSTRING propertyName) = 0;
/////////////////////////////////////////////////////////////////////
@@ -637,6 +640,7 @@
/// \return
/// Returns true if the value is null; otherwise returns false.
///
+ /// \since 2.2
virtual bool IsNull(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -669,7 +673,7 @@
///
/// \exception MgInvalidPropertyTypeException.
///
- ///
+ /// \since 2.2
virtual bool GetBoolean(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -702,7 +706,7 @@
///
/// \exception MgInvalidPropertyTypeException.
///
- ///
+ /// \since 2.2
virtual BYTE GetByte(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -735,7 +739,7 @@
///
/// \exception MgInvalidPropertyTypeException.
///
- ///
+ /// \since 2.2
virtual MgDateTime* GetDateTime(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -768,7 +772,7 @@
///
/// \exception MgInvalidPropertyTypeException.
///
- ///
+ /// \since 2.2
virtual float GetSingle(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -801,7 +805,7 @@
///
/// \exception MgInvalidPropertyTypeException.
///
- ///
+ /// \since 2.2
virtual double GetDouble(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -834,7 +838,7 @@
///
/// \exception MgInvalidPropertyTypeException
///
- ///
+ /// \since 2.2
virtual INT16 GetInt16(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -867,7 +871,7 @@
///
/// \exception MgInvalidPropertyTypeException.
///
- ///
+ /// \since 2.2
virtual INT32 GetInt32(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -903,6 +907,7 @@
/// \note
/// INT64 is actually a pointer to an Integer64 object
///
+ /// \since 2.2
virtual INT64 GetInt64(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -935,7 +940,7 @@
///
/// \exception MgInvalidPropertyTypeException.
///
- ///
+ /// \since 2.2
virtual STRING GetString(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -968,7 +973,7 @@
///
/// \exception MgInvalidPropertyTypeException
///
- ///
+ /// \since 2.2
virtual MgByteReader* GetBLOB(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -1001,7 +1006,7 @@
///
/// \exception MgInvalidPropertyTypeException.
///
- ///
+ /// \since 2.2
virtual MgByteReader* GetCLOB(INT32 index) = 0;
/////////////////////////////////////////////////////////////////////
@@ -1035,7 +1040,7 @@
///
/// \exception MgInvalidPropertyTypeException
///
- ///
+ /// \since 2.2
virtual MgByteReader* GetGeometry(INT32 index) = 0;
///////////////////////////////////////////////////////////////////////
@@ -1069,7 +1074,7 @@
/// \exception MgFdoException MgInvalidPropertyTypeException
/// \exception MgInvalidPropertyTypeException.
///
- ///
+ /// \since 2.2
virtual MgRaster* GetRaster(INT32 index) = 0;
Modified: branches/2.4/MgDev/Common/PlatformBase/Services/ResourceService.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Services/ResourceService.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Services/ResourceService.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -484,6 +484,7 @@
/// \exception MgInvalidResourceNameException
/// \exception MgInvalidResourceTypeException
///
+ /// \since 2.0
MgByteReader* EnumerateResources(MgResourceIdentifier* resource,
INT32 depth, CREFSTRING type, bool computeChildren);
@@ -869,6 +870,7 @@
/// in the source folder are overwritten. The rest should are
/// left intact.
///
+ /// \since 2.2
virtual void MoveResource(MgResourceIdentifier* sourceResource,
MgResourceIdentifier* destResource, bool overwrite, bool cascade);
@@ -1012,6 +1014,7 @@
/// \exception MgInvalidResourceNameException
/// \exception MgInvalidResourceTypeException
///
+ /// \since 2.2
virtual MgStringCollection* GetResourceContents(MgStringCollection* resources,
MgStringCollection* preProcessTags);
@@ -1702,6 +1705,7 @@
/// Returns an MgByteReader object containing the unmanaged data
/// in XML format using the \link UnmanagedDataList_schema UnmanagedDataList_schema \endlink
///
+ /// \since 1.2
virtual MgByteReader* EnumerateUnmanagedData(CREFSTRING path, bool recursive, CREFSTRING type, CREFSTRING filter);
INTERNAL_API:
Modified: branches/2.4/MgDev/Common/PlatformBase/Services/Transaction.h
===================================================================
--- branches/2.4/MgDev/Common/PlatformBase/Services/Transaction.h 2012-08-29 14:36:17 UTC (rev 6958)
+++ branches/2.4/MgDev/Common/PlatformBase/Services/Transaction.h 2012-08-29 16:02:52 UTC (rev 6959)
@@ -23,6 +23,8 @@
/// MgTransaction represents a transaction to be performed in a DataStore.
/// If the transaction is time out, commit or rollback a transaction will
/// result in one exception MgFeatureServiceException thrown.
+///
+/// \since 2.2
class MG_PLATFORMBASE_API MgTransaction : public MgSerializable
{
PUBLISHED_API:
@@ -44,14 +46,16 @@
///
virtual MgResourceIdentifier* GetFeatureSource() = 0;
- /// \brief
+ /// \brief
/// Create a save point in this transaction.
///
/// \param suggestName
/// Suggested save point name.
///
- /// \returns
+ /// \return
/// The actual name used
+ ///
+ /// \since 2.4
virtual STRING AddSavePoint(CREFSTRING suggestName) = 0;
/// \brief
@@ -60,9 +64,10 @@
/// \param savePointName
/// Save point name.
///
- /// \returns
+ /// \return
/// Returns nothing
-
+ ///
+ /// \since 2.4
virtual void ReleaseSavePoint(CREFSTRING savePointName) = 0;
/// \brief
@@ -71,8 +76,10 @@
/// \param savePointName
/// Save point name.
///
- /// \returns
+ /// \return
/// Returns nothing
+ ///
+ /// \since 2.4
virtual void Rollback(CREFSTRING savePointName) = 0;
protected:
More information about the mapguide-commits
mailing list