[mapguide-commits] r6958 - in branches/2.4/MgDev/Common: Foundation/Exception Geometry/CoordinateSystem
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Wed Aug 29 07:36:17 PDT 2012
Author: jng
Date: 2012-08-29 07:36:17 -0700 (Wed, 29 Aug 2012)
New Revision: 6958
Modified:
branches/2.4/MgDev/Common/Foundation/Exception/Exception.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
Log:
#2097: Document methods affected by MapGuide RFC89
Modified: branches/2.4/MgDev/Common/Foundation/Exception/Exception.h
===================================================================
--- branches/2.4/MgDev/Common/Foundation/Exception/Exception.h 2012-08-29 13:03:23 UTC (rev 6957)
+++ branches/2.4/MgDev/Common/Foundation/Exception/Exception.h 2012-08-29 14:36:17 UTC (rev 6958)
@@ -53,6 +53,9 @@
/// Localized exception message. See MgSiteConnection for information on specifying
/// the locale.
///
+ /// \remarks
+ /// This method used to be called GetMessage prior to MapGuide Open Source 2.2 / MapGuide Enterprise 2011 / AutoCAD Map3D 2011
+ ///
STRING GetExceptionMessage() throw();
///////////////////////////////////////////////////////////////////////////
Modified: branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystem.h
===================================================================
--- branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystem.h 2012-08-29 13:03:23 UTC (rev 6957)
+++ branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystem.h 2012-08-29 14:36:17 UTC (rev 6958)
@@ -52,6 +52,16 @@
virtual double GetMinY()=0; /// __get
virtual double GetMaxX()=0; /// __get
virtual double GetMaxY()=0; /// __get
+ ///////////////////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Returns the CS-Map coordinate system code
+ ///
+ /// \return
+ /// The CS-Map coordinate system code
+ ///
+ /// \remarks
+ /// This method used to be called GetCode prior to MapGuide Open Source 2.2 / MapGuide Enterprise 2011 / AutoCAD Map3D 2011
+ ///
virtual STRING GetCsCode()=0; /// __get
virtual STRING GetDescription()=0; /// __get
virtual STRING GetProjection()=0; /// __get
@@ -68,7 +78,27 @@
virtual MgCoordinateSystemMeasure* GetMeasure()=0;
virtual MgStringCollection* GetCategories()=0;
virtual MgCoordinateSystemCatalog* GetCatalog()=0;
+ ///////////////////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Sets the CS-Map coordinate system code for this coordinate system
+ ///
+ /// \param sCode (String/string)
+ /// The CS-Map coordinate system code
+ ///
+ /// \remarks
+ /// This method used to be called SetCode prior to MapGuide Open Source 2.2 / MapGuide Enterprise 2011 / AutoCAD Map3D 2011
+ ///
virtual void SetCsCode(CREFSTRING sCode)=0;
+ ///////////////////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Checks whether the given CS-Map coordinate system code is a legal one
+ ///
+ /// \return
+ /// true if the given code is a legal one, false otherwise
+ ///
+ /// \remarks
+ /// This method used to be called IsLegalCode prior to MapGuide Open Source 2.2 / MapGuide Enterprise 2011 / AutoCAD Map3D 2011
+ ///
virtual bool IsLegalCsCode(CREFSTRING sCode)=0;
virtual bool IsValid()=0;
virtual bool IsUsable(MgCoordinateSystemCatalog *pCatalog)=0;
Modified: branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemDatum.h
===================================================================
--- branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemDatum.h 2012-08-29 13:03:23 UTC (rev 6957)
+++ branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemDatum.h 2012-08-29 14:36:17 UTC (rev 6958)
@@ -26,8 +26,38 @@
DECLARE_CLASSNAME(MgCoordinateSystemDatum)
PUBLISHED_API:
+ ///////////////////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Returns the CS-Map coordinate system datum code
+ ///
+ /// \return
+ /// The CS-Map coordinate system datum code
+ ///
+ /// \remarks
+ /// This method used to be called GetCode prior to MapGuide Open Source 2.2 / MapGuide Enterprise 2011 / AutoCAD Map3D 2011
+ ///
virtual STRING GetDtCode()=0;
+ ///////////////////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Sets the CS-Map coordinate system datum code for this datum
+ ///
+ /// \param sCode (String/string)
+ /// The CS-Map coordinate system datum code
+ ///
+ /// \remarks
+ /// This method used to be called SetCode prior to MapGuide Open Source 2.2 / MapGuide Enterprise 2011 / AutoCAD Map3D 2011
+ ///
virtual void SetDtCode(CREFSTRING sCode)=0;
+ ///////////////////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Checks whether the specified CS-Map coordinate system datum code is a legal one
+ ///
+ /// \return
+ /// true if the given code is a legal one, false otherwise
+ ///
+ /// \remarks
+ /// This method used to be called IsLegalCode prior to MapGuide Open Source 2.2 / MapGuide Enterprise 2011 / AutoCAD Map3D 2011
+ ///
virtual bool IsLegalDtCode(CREFSTRING sCode)=0;
virtual bool IsValid()=0;
virtual bool IsUsable(MgCoordinateSystemCatalog *pCatalog)=0;
Modified: branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemEllipsoid.h
===================================================================
--- branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemEllipsoid.h 2012-08-29 13:03:23 UTC (rev 6957)
+++ branches/2.4/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemEllipsoid.h 2012-08-29 14:36:17 UTC (rev 6958)
@@ -23,8 +23,38 @@
DECLARE_CLASSNAME(MgCoordinateSystemEllipsoid)
PUBLISHED_API:
+ ///////////////////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Returns the CS-Map coordinate system ellipsoid code
+ ///
+ /// \return
+ /// The CS-Map coordinate system ellipsoid code
+ ///
+ /// \remarks
+ /// This method used to be called GetCode prior to MapGuide Open Source 2.2 / MapGuide Enterprise 2011 / AutoCAD Map3D 2011
+ ///
virtual STRING GetElCode()=0; /// __get
+ ///////////////////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Sets the CS-Map coordinate system ellipsoid code for this ellipsoid
+ ///
+ /// \param sCode (String/string)
+ /// The CS-Map coordinate system ellipsoid code
+ ///
+ /// \remarks
+ /// This method used to be called SetCode prior to MapGuide Open Source 2.2 / MapGuide Enterprise 2011 / AutoCAD Map3D 2011
+ ///
virtual void SetElCode(CREFSTRING sCode)=0;
+ ///////////////////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Checks whether the specified CS-Map coordinate system ellipsoid code is a legal one
+ ///
+ /// \return
+ /// true if the given code is a legal one, false otherwise
+ ///
+ /// \remarks
+ /// This method used to be called IsLegalCode prior to MapGuide Open Source 2.2 / MapGuide Enterprise 2011 / AutoCAD Map3D 2011
+ ///
virtual bool IsLegalElCode(CREFSTRING sCode)=0;
virtual bool IsValid()=0;
virtual bool IsUsable()=0;
More information about the mapguide-commits
mailing list