[fdo-commits] r710 - in
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands: .
DataStore Feature Locking LongTransaction SQL Schema
SpatialContext UnitOfMeasure
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 1 20:09:38 EST 2007
Author: gregboone
Date: 2007-02-01 20:09:37 -0500 (Thu, 01 Feb 2007)
New Revision: 710
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgICreateDataStore.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgICreateDataStoreImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDataStorePropertyDictionaryImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDataStoreReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDataStoreReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDestroyDataStore.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDestroyDataStoreImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIListDataStores.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIListDataStoresImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIBaseSelect.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIBaseSelectImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDataReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDataReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDelete.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDeleteImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIFeatureReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIFeatureReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIInsert.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIInsertImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelect.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelectAggregates.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelectAggregatesImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelectImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIUpdate.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIUpdateImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIAcquireLockImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockInfoImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockOwnersImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockedObjects.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockedObjectsImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockConflictReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockConflictReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockOwnersReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockedObjectReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIReleaseLockImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgLockType.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIActivateLTCheckpointImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIActivateLongTransactionImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIChangeLTPrivilegesImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIChangeLongTransactionSet.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIChangeLongTransactionSetImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICommitLongTransaction.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICommitLongTransactionImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLTCheckpointImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLongTransaction.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLongTransactionCheckpoint.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLongTransactionImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIDeactivateLongTransaction.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIDeactivateLongTransactionImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIFreezeLongTransaction.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIFreezeLongTransactionImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionCheckpoints.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionCheckpointsImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionPrivileges.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionPrivilegesImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactions.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionsImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionsInSet.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionsInSetImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTCheckpointReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTConflictDirectiveEnumerator.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTConflictDirectiveEnumeratorImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTPrivilegeReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionCheckpointReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionPrivilegeReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionSetReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionSetReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLTCheckpointImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLongTransaction.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLongTransactionCheckpoint.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLongTransactionImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionConflictResolution.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionFreezeOperations.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionPrivilegeOperations.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionPrivileges.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionSetOperations.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLCommand.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLCommandImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLDataReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLDataReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIApplySchema.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIApplySchemaImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchema.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchemaImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchemaMapping.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchemaMappingImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDestroySchema.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDestroySchemaImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIPhysicalElementMapping.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIPhysicalPropertyMapping.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalClassMapping.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalElementMapping.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalPropertyMapping.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalSchemaMapping.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalSchemaMappingCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIActivateSpatialContext.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIActivateSpatialContextImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgICreateSpatialContext.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgICreateSpatialContextImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIDestroySpatialContext.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIDestroySpatialContextImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIGetSpatialContexts.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIGetSpatialContextsImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgISpatialContextReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgISpatialContextReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgSpatialContextExtentType.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgBaseUnit.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgICreateMeasureUnit.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgICreateMeasureUnitImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIDestroyMeasureUnit.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIDestroyMeasureUnitImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIGetMeasureUnits.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIGetMeasureUnitsImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIMeasureUnitReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIMeasureUnitReaderImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgBatchParameterValueCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgICommand.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgICommandImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgIFeatureCommandImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgIdentifierCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgParameterValue.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgParameterValueCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgPropertyValue.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgPropertyValueCollection.h
Log:
893057: DOC: FDO Managed API Documentation Updates
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgICreateDataStore.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgICreateDataStore.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgICreateDataStore.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -32,11 +32,11 @@
public:
/// \brief
/// Gets the IDataStorePropertyDictionary interface that
- /// can be used to dynamically query and set the properties required
+ /// can be used to dynamically query and set the properties required
/// to create a new datastore.
///
/// \return
- /// Returns the property dictionary
+ /// Returns the DataStore property dictionary
///
__property NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE::IDataStorePropertyDictionary* get_DataStoreProperties();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgICreateDataStoreImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgICreateDataStoreImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgICreateDataStoreImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,10 +27,10 @@
public __gc __interface IDataStorePropertyDictionary;
/// \brief
-/// The ISQLCommand interface defines the SQL command, which supports the
-/// execution of a SQL statement against an underlying RDBMS. Two execute
-/// methods are provided to distinguish between statements that return table data
-/// versus those that execute non query type operations.
+/// The ICreateDataStoreImp class is a concrete implementation of interface ICreateDataStore.
+/// ICreateDataStoreImp defines the create datastore command, which can be used to create new
+/// provider specific datastores. The input is provided through a dictionary of name value
+/// pairs that is provider dependant.
private __gc class ICreateDataStoreImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE::ICreateDataStore
{
public:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDataStorePropertyDictionaryImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDataStorePropertyDictionaryImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDataStorePropertyDictionaryImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,10 +26,10 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE
/// \brief
-/// The ISQLCommand interface defines the SQL command, which supports the
-/// execution of a SQL statement against an underlying RDBMS. Two execute
-/// methods are provided to distinguish between statements that return table data
-/// versus those that execute non query type operations.
+/// The IDataStorePropertyDictionaryImp class represents a concret implementation of interface
+/// IDataStorePropertyDictionary. IDataStorePropertyDictionaryImp exposes a dictionary style interface
+/// to the datastore properties. The properties required to create or destroy a datastore
+/// can be determined and their values can be set through this interface.
private __gc class IDataStorePropertyDictionaryImp : public NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnectionPropertyDictionaryImp, public NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE::IDataStorePropertyDictionary
{
public:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDataStoreReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDataStoreReader.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDataStoreReader.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -50,7 +50,7 @@
/// \brief
/// Gets the flag that indicates whether the datastore is FDO enabled.
- /// Non-FDO databases are also referred to as “Foreign?datastores.
+ /// Non-FDO databases are also referred to as 'Foreign' datastores.
///
/// \return
/// Returns the flag
@@ -58,7 +58,7 @@
System::Boolean GetIsFdoEnabled();
/// \brief
- /// Gets the IConnectionPropertyDictionary interface that
+ /// Gets the IDataStorePropertyDictionary interface that
/// includes the properties of the datastores set at datastore create
/// time, with the exception of password.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDataStoreReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDataStoreReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDataStoreReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,10 +26,12 @@
public __gc __interface IDataStorePropertyDictionary;
/// \brief
-/// The ISQLCommand interface defines the SQL command, which supports the
-/// execution of a SQL statement against an underlying RDBMS. Two execute
-/// methods are provided to distinguish between statements that return table data
-/// versus those that execute non query type operations.
+/// The IDataStoreReaderImp class is a concrete implementation class of the
+/// IDataStoreReader interface. IDataStoreReaderImp provides a forward-only, read-only iterator
+/// for reading feature data. A reference to an IDataStoreReader is returned
+/// from the IListDataStores command. Because the initial position of the
+/// IDataStoreReader is prior to the first item, you must call
+/// ReadNext to begin accessing any data.
private __gc class IDataStoreReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE::IDataStoreReader
{
public:
@@ -59,7 +61,7 @@
System::Boolean GetIsFdoEnabled();
/// \brief
- /// Gets the IConnectionPropertyDictionary interface that
+ /// Gets the IDataStorePropertyDictionary interface that
/// includes the properties of the datastores set at datastore create
/// time, with the exception of password.
///
@@ -92,8 +94,10 @@
inline FdoIDataStoreReader* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
- System::Void ReleaseUnmanagedObject();
+ System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDestroyDataStore.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDestroyDataStore.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDestroyDataStore.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,7 +24,7 @@
public __gc __interface IDataStorePropertyDictionary;
/// \brief
-/// The IDestroyDataStore interface defines the create datastore command,
+/// The IDestroyDataStore interface defines the destroy datastore command,
/// which can be used to create new provider specific datastores. The input is provided
/// through a dictionary of name value pairs that is provider dependant.
public __gc __interface IDestroyDataStore : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
@@ -32,8 +32,8 @@
public:
/// \brief
/// Gets the IDataStorePropertyDictionary interface that
- /// can be used to dynamically query and set the properties required
- /// to create a new datastore.
+ /// can be used to dynamically query and set the properties required
+ /// to destroy a datastore.
///
/// \return
/// Returns the property dictionary
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDestroyDataStoreImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDestroyDataStoreImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIDestroyDataStoreImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,17 +27,18 @@
public __gc __interface IDataStorePropertyDictionary;
/// \brief
-/// The ISQLCommand interface defines the SQL command, which supports the
-/// execution of a SQL statement against an underlying RDBMS. Two execute
-/// methods are provided to distinguish between statements that return table data
-/// versus those that execute non query type operations.
-private __gc class IDestroyDataStoreImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE::IDestroyDataStore
+/// The IDestroyDataStoreImp class is a concrete implementation of interface IDestroyDataStore.
+/// The IDestroyDataStoreImp class defines the destroy datastore command,
+/// which can be used to create new provider specific datastores. The input is provided
+/// through a dictionary of name value pairs that is provider dependant.
+private __gc class IDestroyDataStoreImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE::IDestroyDataStore
{
public:
/// \brief
/// Gets the IDataStorePropertyDictionary interface that
/// can be used to dynamically query and set the properties required
- /// to create a new datastore.
+ /// to destroy a datastore.
///
/// \return
/// Returns the property dictionary
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIListDataStores.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIListDataStores.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIListDataStores.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,7 +24,7 @@
public __gc __interface IDataStoreReader;
/// \brief
-/// The FdoIListDataStores interface defines the list datastores command,
+/// The IListDataStores interface defines the list datastores command,
/// which provides a way to get a list of datastores at a particular server.
public __gc __interface IListDataStores : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
{
@@ -32,7 +32,7 @@
/// \brief
/// Gets the flag that indicates whether to include or
/// not include Non-FDO enabled datastores in the returned list.
- /// These are also referred to as “Foreign?datastores.
+ /// These are also referred to as 'Foreign' datastores.
///
/// \return
/// Returns the flag
@@ -42,7 +42,7 @@
/// \brief
/// Sets the flag to indicate whether to include or not include
/// Non-FDO enabled datastores in the returned list. These are also
- /// referred to as “Foreign?datastores.
+ /// referred to as 'Foreign' datastores.
///
/// \return
/// Returns nothing
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIListDataStoresImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIListDataStoresImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/DataStore/mgIListDataStoresImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,15 +27,17 @@
public __gc __interface IDataStoreReader;
/// \brief
+/// The IListDataStoresImp class is a concrete implementation of interface IListDataStores.
/// The IListDataStores interface defines the list datastores command,
/// which provides a way to get a list of datastores at a particular server.
-private __gc class IListDataStoresImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE::IListDataStores
+private __gc class IListDataStoresImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE::IListDataStores
{
public:
/// \brief
/// Gets the flag that indicates whether to include or
/// not include Non-FDO enabled datastores in the returned list.
- /// These are also referred to as “Foreign?datastores.
+ /// These are also referred to as 'Foreign' datastores.
///
/// \return
/// Returns the flag
@@ -45,7 +47,7 @@
/// \brief
/// Sets the flag to indicate whether to include or not include
/// Non-FDO enabled datastores in the returned list. These are also
- /// referred to as “Foreign?datastores.
+ /// referred to as 'Foreign' datastores.
///
/// \return
/// Returns nothing
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIBaseSelect.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIBaseSelect.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIBaseSelect.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -28,7 +28,8 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
/// \brief
-/// The ISelect interface defines the Select command, which queries for features
+/// The IBaseSelect interface defines a base interface for the the
+/// FDO ISelect command, which queries for features
/// of a given class that match the specified criteria. Input to the select
/// command includes the name of the class, the list of properties to be
/// returned, and a filter. All but the class name is optional. If the list of
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIBaseSelectImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIBaseSelectImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIBaseSelectImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,7 +26,9 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
/// \brief
-/// The ISelect interface defines the Select command, which queries for features
+/// The IBaseSelectImp class is a concrete implementation class for
+/// interface IBaseSelect. The IBaseSelect interface defines a base interface for the the
+/// FDO ISelect command, which queries for features
/// of a given class that match the specified criteria. Input to the select
/// command includes the name of the class, the list of properties to be
/// returned, and a filter. All but the class name is optional. If the list of
@@ -37,7 +39,8 @@
/// supports locking, then the select command can optionally lock all of the
/// features selected, via the ExecuteWithLock method (see "Locking
/// Commands" for more information on locking features).
-private __gc class IBaseSelectImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IBaseSelect
+private __gc class IBaseSelectImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IBaseSelect
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDataReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDataReader.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDataReader.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -28,7 +28,7 @@
/// \brief
/// The IDataReader interface provides a forward-only, read-only
/// iterator for reading relational table data. A reference to an
-/// IDataReader is returned from the SQLCommands ExecuteReader method.
+/// IDataReader is returned from the ISQLCommands ExecuteReader method.
/// The initial position of the IDataReader interface is prior to the first item.
/// Thus, you must call ReadNext to begin accessing any data.
public __gc __interface IDataReader : public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IReader
@@ -60,12 +60,12 @@
/// Input the property name.
///
/// \return
- /// Returns the type of the property.
+ /// Returns the data type of the property corresponding to the property name.
///
NAMESPACE_OSGEO_FDO_SCHEMA::DataType GetDataType(System::String* name);
/// \brief
- /// Gets the FDO property type of a given property. This is used
+ /// Gets the property type of a given property. This is used
/// to indicate if a given property is a geometric property or a data property. If the property is
/// a PropertyType_DataProperty, then GetDataType can be used to to find the data type of the property.
///
@@ -73,7 +73,7 @@
/// Input the property name.
///
/// \return
- /// Returns the FDO property type.
+ /// Returns the property type corresponding to the property name.
///
NAMESPACE_OSGEO_FDO_SCHEMA::PropertyType GetPropertyType(System::String* name);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDataReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDataReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDataReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -29,7 +29,8 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
/// \brief
-/// The IDataReader interface provides a forward-only, read-only
+/// The IDataReaderImp class is a concrete implementation class for
+/// IDataReader. The IDataReader interface provides a forward-only, read-only
/// iterator for reading relational table data. A reference to an
/// IDataReader is returned from the SQLCommands ExecuteReader method.
/// The initial position of the IDataReader interface is prior to the first item.
@@ -63,12 +64,12 @@
/// Input the property name.
///
/// \return
- /// Returns the type of the property.
+ /// Returns the data type of the property corresponding to the property name.
///
NAMESPACE_OSGEO_FDO_SCHEMA::DataType GetDataType(System::String* name);
/// \brief
- /// Gets the FDO property type of a given property. This is used
+ /// Gets the property type of a given property. This is used
/// to indicate if a given property is a geometric property or a data property. If the property is
/// a PropertyType_DataProperty, then GetDataType can be used to to find the data type of the property.
///
@@ -76,7 +77,7 @@
/// Input the property name.
///
/// \return
- /// Returns the FDO property type.
+ /// Returns the property type corresponding to the property name.
///
NAMESPACE_OSGEO_FDO_SCHEMA::PropertyType GetPropertyType(System::String* name);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDelete.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDelete.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDelete.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,7 +27,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
/// \brief
-/// The IDelete interface defines the Delete command, which deletes instances of
+/// The IDelete interface defines the FDO Delete command, which deletes instances of
/// a given class that match the specified criteria. Input to the delete command
/// includes the name of the class, and filter criteria by which to identify the
/// instances to be deleted. The filter may be specified either as text or as an
@@ -41,19 +41,19 @@
{
public:
/// \brief
- /// Executes the delete command and returns the number of instances
+ /// Executes the delete command and returns the number of features
/// deleted
///
/// \return
- /// Returns the number of instances deleted.
+ /// Returns the number of features deleted.
///
System::Int32 Execute();
/// \brief
- /// Deleting objects might result in lock conflicts if objects
+ /// Deleting objects might result in lock conflicts if objects
/// to be deleted are not exclusively locked for the user attempting to
/// delete the object. A lock conflict report is generated.
- /// The function GetLockConflicts returns a lock conflict reader that provides
+ /// This function returns a lock conflict reader that provides
/// access to the list of lock conflicts that occurred during the execution
/// of the delete operation.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDeleteImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDeleteImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIDeleteImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -30,7 +30,8 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
/// \brief
-/// The IDelete interface defines the Delete command, which deletes instances of
+/// The IDeleteImp class is a concrete implementation class for interface IDelete.
+/// The IDelete interface defines the FDO Delete command, which deletes instances of
/// a given class that match the specified criteria. Input to the delete command
/// includes the name of the class, and filter criteria by which to identify the
/// instances to be deleted. The filter may be specified either as text or as an
@@ -40,7 +41,8 @@
/// to simply by the class name. Instances at a nested scope (i.e. instances
/// within a object collection property) are referred to by the containing class
/// name, followed by a '.', followed by the object collection property name.
-private __gc class IDeleteImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IDelete
+private __gc class IDeleteImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IDelete
{
public:
/// \brief
@@ -53,10 +55,10 @@
System::Int32 Execute();
/// \brief
- /// Deleting objects might result in lock conflicts if objects
+ /// Deleting objects might result in lock conflicts if objects
/// to be deleted are not exclusively locked for the user attempting to
/// delete the object. A lock conflict report is generated.
- /// The function GetLockConflicts returns a lock conflict reader that provides
+ /// This function returns a lock conflict reader that provides
/// access to the list of lock conflicts that occurred during the execution
/// of the delete operation.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIFeatureReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIFeatureReader.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIFeatureReader.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -52,7 +52,7 @@
/// reader is returned. The outermost reader has a depth of 0.
///
/// \return
- /// Returns the depth
+ /// Returns the reader depth
///
System::Int32 GetDepth();
@@ -66,10 +66,8 @@
/// until a call to ReadNext() or Close(), or the disposal of this reader
/// object.
///
- /// \param propertyName
+ /// \param name
/// Input the property name.
- /// \param count
- /// Output the number of bytes in the array.
///
/// \return
/// Returns a pointer to the byte array in FGF format.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIFeatureReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIFeatureReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIFeatureReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -30,12 +30,14 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
/// \brief
+/// The IFeatureReaderImp class is a concrete implementation class for interface IFeatureReader.
/// The IFeatureReader interface provides a forward-only, read-only iterator
/// for reading feature data. A reference to an IFeatureReader is returned
/// from the Select and SelectAndLock commands. Because the initial position of the
/// IFeatureReader is prior to the first item, you must call
/// ReadNext to begin accessing any data.
-private __gc class IFeatureReaderImp : public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IReaderImp, public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IFeatureReader
+private __gc class IFeatureReaderImp : public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IReaderImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IFeatureReader
{
public:
/// \brief
@@ -55,7 +57,7 @@
/// reader is returned. The outermost reader has a depth of 0.
///
/// \return
- /// Returns the depth
+ /// Returns the feature reader depth
///
System::Int32 GetDepth();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIInsert.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIInsert.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIInsert.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -33,7 +33,7 @@
public __gc __interface IFeatureReader;
/// \brief
-/// The FdoIInsert interface defines the Insert command, which inserts a new
+/// The IInsert interface defines the Insert command, which inserts a new
/// instance of a given class. Input to the insert command includes the name of
/// the class and a collection of property values. Properties that are
/// not specified and do not have a default value will be assigned a null value
@@ -91,7 +91,7 @@
/// inserts can be performed by using Parameters for each of the property
/// values, then adding collections of parameter values to the
/// BatchParameterValueCollection. Each ParameterValueCollection in the
- /// BatchParameterValueCollection should contain one FdoParameterValue for each
+ /// BatchParameterValueCollection should contain one ParameterValue for each
/// of the parameters specified for property values.
///
/// \return
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIInsertImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIInsertImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIInsertImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -36,6 +36,7 @@
public __gc __interface IFeatureReader;
/// \brief
+/// The IInsertImp class is a concrete implementation class for interface IInsert.
/// The IInsert interface defines the Insert command, which inserts a new
/// instance of a given class. Input to the insert command includes the name of
/// the class and a collection of property values. Properties that are
@@ -46,7 +47,8 @@
/// by the class name. Instances at a nested scope (i.e. instances within a
/// object collection property) are referred to by the containing class name,
/// followed by a '.', followed by the object collection property name.
-private __gc class IInsertImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IInsert
+private __gc class IInsertImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IInsert
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIReader.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIReader.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -33,10 +33,9 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
/// \brief
-/// The IFeatureReader interface provides a forward-only, read-only iterator
-/// for reading feature data. A reference to an IFeatureReader is returned
-/// from the Select and SelectAndLock commands. Because the initial position of the
-/// IFeatureReader is prior to the first item, you must call
+/// The IReader interface provides a forward-only, read-only iterator
+/// for reading data. Because the initial position of the
+/// IReader is prior to the first item, you must call
/// ReadNext to begin accessing any data.
public __gc __interface IReader : public System::IDisposable
{
@@ -235,7 +234,7 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the IFeatureReader object, freeing any resources it may be holding.
+ /// Closes the IReader object, freeing any resources it may be holding.
///
/// \return
/// Returns nothing
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -37,12 +37,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
/// \brief
-/// The IFeatureReader interface provides a forward-only, read-only iterator
-/// for reading feature data. A reference to an IFeatureReader is returned
-/// from the Select and SelectAndLock commands. Because the initial position of the
-/// IFeatureReader is prior to the first item, you must call
+/// The IReaderImp class is a concrete implementation class for interface IReader.
+/// The IReader interface provides a forward-only, read-only iterator for reading data.
+/// Because the initial position of the IReader is prior to the first item, you must call
/// ReadNext to begin accessing any data.
-private __gc class IReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IReader
+private __gc class IReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IReader
{
public:
/// \brief
@@ -60,7 +60,7 @@
/// \brief
/// Gets the byte value of the specified property. No conversion is
- /// performed, thus the property must be FdoDataType_Byte or an
+ /// performed, thus the property must be DataType_Byte or an
/// exception is thrown.
///
/// \param name
@@ -246,8 +246,10 @@
///
System::Void Close();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
IReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelect.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelect.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelect.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -100,9 +100,9 @@
NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IFeatureReader* ExecuteWithLock();
/// \brief
- /// When executing the operation ExecuteWithLock lock
- /// conflicts may occur. Those lock conflicts are reported. The
- /// function GetLockConflicts returns a lock conflict reader
+ /// When executing the operation ExecuteWithLock lock
+ /// conflicts may occur. Those lock conflicts are reported.
+ /// This function returns a lock conflict reader
/// providing access to the list of lock conflicts that occurred
/// during the execution of the operation.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelectAggregates.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelectAggregates.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelectAggregates.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -50,10 +50,12 @@
/// \brief
/// Set the distinct option of the selection.
- /// Non-simple properties such as object properties, geometry properties, raster properties, association properties, etc. will not be supported with Distinct.
+ /// Non-simple properties such as object properties, geometry properties,
+ /// raster properties, association properties, etc. will not be supported with Distinct.
///
/// \param value
- /// true or false; when set to true, only distinct values are returned. Otherwise all values are returned
+ /// true or false; when set to true, only distinct values are returned.
+ /// Otherwise all values are returned
///
/// \return
/// Returns nothing
@@ -70,9 +72,10 @@
__property System::Boolean get_Distinct();
/// \brief
- /// Gets the IdentifierCollection that holds the list of group by property names. If empty no grouping is used. This list is initially
- /// empty and the caller need to add the property that the command should use as a group by criteria. No LOB or Geometry type properties
- /// can be used for ordering.
+ /// Gets the IdentifierCollection that holds the list of group by property names.
+ /// If empty no grouping is used. This list is initially empty and the
+ /// caller need to add the property that the command should use as a group by criteria.
+ /// No LOB or Geometry type properties can be used for ordering.
///
/// \return
/// Returns the list of group by property names.
@@ -80,8 +83,10 @@
__property NAMESPACE_OSGEO_FDO_COMMANDS::IdentifierCollection* get_Grouping();
/// \brief
- /// Set the grouping by filter. Use the grouping filter to restrict the groups of returned properties to those groups for
- /// which the specified filter is TRUE. For example "order by city" and "min(lanes) = 2". The Filter have to evalute to a
+ /// Set the grouping by filter. Use the grouping filter to restrict
+ /// the groups of returned properties to those groups for
+ /// which the specified filter is TRUE. For example "order by city"
+ /// and "min(lanes) = 2". The Filter have to evalute to a
/// binary value(true or false).
///
/// \param filter
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelectAggregatesImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelectAggregatesImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelectAggregatesImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -35,12 +35,14 @@
public __gc __interface IDataReader;
/// \brief
+/// The ISelectAggregateImp class is a cocrete implementation of interface ISelectAggregates.
/// The ISelectAggregate interface defines a Select command that handle selection of properties that include
/// the use of aggregate functions. This command differs from the ISelect command in a number of ways.
/// It handles selection of properties that are aggregate functions and supports selecting distinct property values.
/// It also includes grouping criteria. The execute method returns an IDataReader which is not tied to a specific class.
/// Unlike Select, ISelectAggregate does not include any locking functions.
-private __gc class ISelectAggregatesImp : public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IBaseSelectImp, public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::ISelectAggregates
+private __gc class ISelectAggregatesImp : public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IBaseSelectImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::ISelectAggregates
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelectImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelectImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgISelectImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,6 +26,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
/// \brief
+/// The ISelectImp class is a concrete implementation of interface ISelect.
/// The ISelect interface defines the Select command, which queries for features
/// of a given class that match the specified criteria. Input to the select
/// command includes the name of the class, the list of properties to be
@@ -33,7 +34,7 @@
/// properties to be returned is empty then all properties are returned. The
/// filter may be specified either as text or as an expression tree (most likely
/// produced by a query builder). The result of executing a select command is an
-/// FdoIFeatureReader reference (see "Reading Features"). If the feature provider
+/// IFeatureReader reference (see "Reading Features"). If the feature provider
/// supports locking, then the select command can optionally lock all of the
/// features selected, via the ExecuteWithLock method (see "Locking
/// Commands" for more information on locking features).
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIUpdate.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIUpdate.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIUpdate.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -64,11 +64,11 @@
System::Int32 Execute();
/// \brief
- /// Updating objects might result in lock conflicts if objects
+ /// Updating objects might result in lock conflicts if objects
/// to be updated are not exclusively locked for the user attempting to
/// update the object. If objects to be updated are not exclusively locked for the
/// user attempting to update the object, a lock conflict report is generated.
- /// The function GetLockConflicts returns a lock conflict reader providing
+ /// This function returns a lock conflict reader providing
/// access to the list of lock conflicts that occurred during the execution
/// of the update operation.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIUpdateImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIUpdateImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Feature/mgIUpdateImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,6 +26,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
/// \brief
+/// The IUpdateImp class is a concrete implementation of interface IUpdate.
/// The IUpdate interface defines the Update command, which modifies instances
/// of a given class that match the specified criteria. Input to the update
/// command includes the name of the class, the list of property name/value
@@ -37,7 +38,8 @@
/// by the class name. Instances at a nested scope (i.e., instances within an
/// object collection property) are referred to by the containing class name,
/// followed by a '.', followed by the object collection property name.
-private __gc class IUpdateImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IUpdate
+private __gc class IUpdateImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IUpdate
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIAcquireLockImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIAcquireLockImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIAcquireLockImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -29,6 +29,7 @@
public __gc __interface ILockConflictReader;
/// \brief
+/// The IAcquireLockImp class is a concrete implementation of IAcquireLock.
/// The IAcquireLock interface locks feature instances of a given class
/// that match the specified criteria. Input to the acquire lock command
/// includes the name of the class, the lock type, the lock strategy, and
@@ -50,7 +51,8 @@
/// specified in the filter that are already locked by someone else.
/// The command returns an empty ILockConflictReader list if all of the
/// feature instances specified in the filter were successfully locked.
-private __gc class IAcquireLockImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::IAcquireLock
+private __gc class IAcquireLockImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::IAcquireLock
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockInfoImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockInfoImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockInfoImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,10 +27,12 @@
public __gc __interface ILockedObjectReader;
/// \brief
+/// The IGetLockInfoImp class is a concrete implementation of IGetLockedObjects.
/// The IGetLockInfo interface defines the GetLockInfo command, which gets a
/// lock information for the feature instances of a given class that match the
/// specified filter. If the filter is empty, all feature instances of the given class are selected.
-private __gc class IGetLockInfoImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::IGetLockInfo
+private __gc class IGetLockInfoImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::IGetLockInfo
{
public:
/// \brief
@@ -42,6 +44,16 @@
NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::ILockedObjectReader* Execute();
public:
+ /// \brief
+ /// Constructs an IGetLockInfoImp managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IGetLockInfoImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockOwnersImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockOwnersImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockOwnersImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,10 +27,12 @@
public __gc __interface ILockOwnersReader;
/// \brief
+/// The IGetLockOwnersImp class is a concrete implementation of IGetLockedObjects.
/// The IGetLockOwners interface defines the GetLockOwners command, which gets a
/// list of all lock owners. A connected user has the status of being a lock owner as
/// does a user who has released all of his locks.
-private __gc class IGetLockOwnersImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::IGetLockOwners
+private __gc class IGetLockOwnersImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::IGetLockOwners
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockedObjects.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockedObjects.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockedObjects.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -52,7 +52,8 @@
/// Executes the GetLockedObjects command, returning an ILockedObjectReader.
///
/// \return
- /// Returns a list of all of the objects currently locked by a particular user.i The list might be empty if the user does not have anything locked.
+ /// Returns a list of all of the objects currently locked by a particular user.
+ /// The list might be empty if the user does not have anything locked.
///
NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::ILockedObjectReader* Execute();
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockedObjectsImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockedObjectsImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIGetLockedObjectsImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,9 +27,11 @@
public __gc __interface ILockedObjectReader;
/// \brief
+/// The IGetLockedObjectsImp class is a concrete implementation of IGetLockedObjects.
/// The IGetLockedObjects interface defines the GetLockedObjects command, which
/// gets a list of all objects that are currently locked by a particular user.
-private __gc class IGetLockedObjectsImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::IGetLockedObjects
+private __gc class IGetLockedObjectsImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::IGetLockedObjects
{
public:
/// \brief
@@ -55,7 +57,8 @@
/// Executes the GetLockedObjects command, returning an ILockedObjectReader.
///
/// \return
- /// Returns a list of all of the objects currently locked by a particular user.i The list might be empty if the user does not have anything locked.
+ /// Returns a list of all of the objects currently locked by a particular user.
+ /// The list might be empty if the user does not have anything locked.
///
NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::ILockedObjectReader* Execute();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockConflictReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockConflictReader.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockConflictReader.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -33,7 +33,7 @@
/// that are already locked by someone else.
/// \remarks
/// A reference to an ILockConflictReader is returned from the
-/// FdoIAcquireLock, FdoISelect, FdoIReleaseLock, FdoIUpdate, and FdoIDelete commands. The
+/// AcquireLock, Select, ReleaseLock, Update, and Delete commands. The
/// initial position of the ILockConflictReader is prior to the first item,
/// thus you must call ReadNext to begin accessing any data.
public __gc __interface ILockConflictReader : public System::IDisposable
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockConflictReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockConflictReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockConflictReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -30,6 +30,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING
/// \brief
+/// The ILockConflictReaderImp class is a concrete implementation of ILockConflictReaderImp.
/// The ILockConflictReader interface provides forward only, read-only
/// functionality for identifying features that have a lock conflict.
/// Features with a lock conflict are those that the caller is attempting to modify
@@ -39,7 +40,8 @@
/// IAcquireLock, ISelect, IReleaseLock, IUpdate, and IDelete commands. The
/// initial position of the ILockConflictReader is prior to the first item,
/// thus you must call ReadNext to begin accessing any data.
-private __gc class ILockConflictReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::ILockConflictReader
+private __gc class ILockConflictReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::ILockConflictReader
{
public:
/// \brief
@@ -111,8 +113,10 @@
///
System::Void Close();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ILockConflictReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockOwnersReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockOwnersReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockOwnersReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -25,6 +25,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING
/// \brief
+/// The ILockOwnersReaderImp class is a concrete implementation of ILockOwnersReader.
/// The ILockOwnersReader interface provides forward-only, read-only functionality
/// for identifying users. A connected user has status of lock owner even if he has
/// no locks or has released his locks.
@@ -33,7 +34,8 @@
/// ILockOwnersReader interface is returned from the GetLockOwners command. The initial
/// position of the ILockOwnersReader interface is prior to the first item. Thus, you
/// must call ReadNext to begin accessing any data.
-private __gc class ILockOwnersReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::ILockOwnersReader
+private __gc class ILockOwnersReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::ILockOwnersReader
{
public:
/// \brief
@@ -63,8 +65,10 @@
///
System::Void Close();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ILockOwnersReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockedObjectReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockedObjectReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgILockedObjectReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -30,14 +30,16 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING
/// \brief
-/// The FdoILockedObjectReader interface provides forward-only, read-only
+/// The ILockedObjectReaderImp class is a concrete implementation of ILockedObjectReader.
+/// The ILockedObjectReader interface provides forward-only, read-only
/// functionality to identify lock information for a set of objects.
/// \remarks
/// A reference to an ILockedObjectReader interface is returned from the GetLockedObjects
/// and GetLockInfo commands. The initial position of the ILockInfoReader is
/// prior to the first item. Thus, you must call ReadNext to begin accessing
/// any data.
-private __gc class ILockedObjectReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::ILockedObjectReader
+private __gc class ILockedObjectReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::ILockedObjectReader
{
public:
/// \brief
@@ -108,8 +110,10 @@
///
System::Void Close();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ILockedObjectReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIReleaseLockImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIReleaseLockImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgIReleaseLockImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,6 +27,7 @@
public __gc __interface ILockConflictReader;
/// \brief
+/// The IReleaseLockImp class is a concrete implementation of IReleaseLock.
/// The IReleaseLock interface defines the ReleaseLock command, which releases
/// locks from feature instances of a given class that match the specified
/// criteria. Input to the release lock command includes the name of the class
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgLockType.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgLockType.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Locking/mgLockType.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -25,8 +25,8 @@
/// a locked object indicates a user's access privileges (including the user
/// who applied the persistent lock) to an object.
/// <p>
-/// The enumeration values are used with the commands FdoIAcquireLock, FdoISelect
-/// and FdoIGetLockInfo. With the command FdoIAcquireLock or FdoISelect, the
+/// The enumeration values are used with the AcquireLock, Select
+/// and GetLockInfo commands. With the command AcquireLock or Select, the
/// specified value indicates the lock type to be used when applying a lock on
/// an object. With the command IGetLockInfo, the enumaration values are used
/// to report lock types back to the user.
@@ -37,21 +37,21 @@
/// to an object.
/// <param name="LockType_None">
/// Indicates that an object is unlocked.
-/// This type cannot be used with the commands IAcquireLock and FdoISelect.
+/// This type cannot be used with the commands AcquireLock and Select.
/// </param>
/// <param name="LockType_Unsupported">
/// Indicates that an unsupported lock
/// type has been encountered. This type cannot be used with the commands
-/// IAcquireLock and ISelect.
+/// AcquireLock and Select.
/// </param>
/// <param name="LockType_Shared">
/// Indicates a shared lock type. The type can
-/// be used with the commands IAcquireLock and ISelect.
+/// be used with the commands AcquireLock and Select.
/// </param>
/// <param name="LockType_Transaction">
/// Indicates that a transaction lock
/// should be applied on an object. This type can be used with the commands
-/// IAcquireLock and ISelect.
+/// AcquireLock and Select.
/// </param>
/// <param name="LockType_Exclusive">
/// Indicates that only this user can modify
@@ -59,7 +59,7 @@
/// other long transaction, including the root long transaction if it is not the current
/// long transaction.
/// <P>
-/// The type can be used with the commands IAcquireLock and ISelect.
+/// The type can be used with the commands AcquireLock and Select.
/// </param>
/// <param name="LockType_LongTransactionExclusive">
/// Indicates that only this user can
@@ -68,7 +68,7 @@
/// situation (for example, if only a root long transaction exists), the lock behaves
/// like an Exclusive lock.
/// <P>
-/// The type can be used with the commands IAcquireLock and ISelect.
+/// The type can be used with the commands AcquireLock and Select.
/// </param>
/// <param name="LockType_AllLongTransactionExclusive">
/// Indicates that only this user can
@@ -77,7 +77,7 @@
/// containing the object being locked. When not in a long transaction situation (for example,
/// if only a root long transaction exists), the lock behaves like an Exclusive lock.
/// <P>
-/// This type can be used with the commands IAcquireLock and ISelect.
+/// This type can be used with the commands AcquireLock and Select.
/// </param>
public __value enum LockType
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIActivateLTCheckpointImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIActivateLTCheckpointImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIActivateLTCheckpointImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,6 +26,8 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
+/// The IActivateLongTransactionCheckpointImp class is a
+/// concrete implementation of IActivateLongTransactionCheckpoint.
/// The IActivateLongTransactionCheckpoint interface defines the
/// IActivateLongTransactionCheckpointImp command, which allows the user to
/// activate the named checkpoint for the given long transaction. As a result,
@@ -33,7 +35,8 @@
/// it is not already the active long transaction. The user requires the access
/// privilege on the long transaction for which the attempt is made to activate a
/// checkpoint.
-private __gc class IActivateLongTransactionCheckpointImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IActivateLongTransactionCheckpoint
+private __gc class IActivateLongTransactionCheckpointImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IActivateLongTransactionCheckpoint
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIActivateLongTransactionImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIActivateLongTransactionImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIActivateLongTransactionImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,13 +26,15 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
+/// The IActivateLongTransactionImp class is a concrete implementation of IActivateLongTransaction.
/// The IActivateLongTransaction interface defines the ActivateLongTransaction
/// command, which activates a long transaction where feature manipulation and
/// locking commands operate on it. Input to the activate
/// long transaction command is the long transaction name. The Execute operation
/// activates the identified long transaction if the user has access privileges
/// for it.
-private __gc class IActivateLongTransactionImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IActivateLongTransaction
+private __gc class IActivateLongTransactionImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IActivateLongTransaction
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIChangeLTPrivilegesImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIChangeLTPrivilegesImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIChangeLTPrivilegesImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,12 +27,15 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoIChangeLongTransactionPrivileges interface defines the
+/// The IChangeLongTransactionPrivileges class is a
+/// concrete implementation of IChangeLongTransactionPrivileges.
+/// The IChangeLongTransactionPrivileges interface defines the
/// ChangeLongTransactionPrivileges command, which grants or revokes long
/// transaction privileges for the named user. The ability to change the
/// privileges might be restricted by the datastore security if the long
/// transaction doesn’t belong to the user executing the command.
-private __gc class IChangeLongTransactionPrivilegesImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IChangeLongTransactionPrivileges
+private __gc class IChangeLongTransactionPrivilegesImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IChangeLongTransactionPrivileges
{
public:
/// \brief
@@ -77,21 +80,21 @@
/// \brief
/// Gets the privilege flags to grant or revoke.The returned value may be
- /// any combination of the values from the FdoLongTransactionPrivileges
+ /// any combination of the values from the LongTransactionPrivileges
/// enumeration combined via a bit-wise or operation.
///
/// \return
- /// Returns the privileges as a bit masked value based on FdoLongTransactionPrivileges enumeration
+ /// Returns the privileges as a bit masked value based on LongTransactionPrivileges enumeration
///
__property System::Int32 get_Privileges();
/// \brief
/// Sets the privilege flags to grant or revoke. The privileges value may be
- /// any combination of the values from the FdoLongTransactionPrivileges
+ /// any combination of the values from the LongTransactionPrivileges
/// enumeration combined via a bit-wise or operation.
///
/// \param value
- /// Input the privileges as a bit masked value based on FdoLongTransactionPrivileges enumeration
+ /// Input the privileges as a bit masked value based on LongTransactionPrivileges enumeration
///
/// \return
/// Returns nothing
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIChangeLongTransactionSet.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIChangeLongTransactionSet.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIChangeLongTransactionSet.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,7 +24,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoIChangeLongTransactionSet interface defines the ChangeLongTransactionSet
+/// The IChangeLongTransactionSet interface defines the ChangeLongTransactionSet
/// command, which allows the user to add a transaction to, remove a transaction
/// from, or clear the long transaction selection set. Users can add or remove
/// long transactions to the selection set for which they have access
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIChangeLongTransactionSetImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIChangeLongTransactionSetImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIChangeLongTransactionSetImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,13 +27,16 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
+/// The IChangeLongTransactionSetImp class is a
+/// concrete implementation of IChangeLongTransactionSet.
/// The IChangeLongTransactionSet interface defines the ChangeLongTransactionSet
/// command, which allows the user to add a transaction to, remove a transaction
/// from, or clear the long transaction selection set. Users can add or remove
/// long transactions to the selection set for which they have access
/// privileges. Any attempt to add a long transaction for which the user does
/// not have the access privilege will result in a failure of the command.
-private __gc class IChangeLongTransactionSetImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IChangeLongTransactionSet
+private __gc class IChangeLongTransactionSetImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IChangeLongTransactionSet
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICommitLongTransaction.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICommitLongTransaction.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICommitLongTransaction.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,7 +24,7 @@
public __gc __interface ILongTransactionConflictDirectiveEnumerator;
/// \brief
-/// The FdoICommitLongTransaction interface defines the CommitLongTransaction
+/// The ICommitLongTransaction interface defines the CommitLongTransaction
/// command, which allows a user to execute commit operations on a long
/// transaction. Two different commit operations are distinguished: full and partial.
///
@@ -62,7 +62,7 @@
__property System::Void set_Name(System::String* value);
/// Executes the commit long transaction command and returns an
- /// FdoILongTransactionConflictDirectiveEnumerator.
+ /// ILongTransactionConflictDirectiveEnumerator.
/// If the returned enumerator's count is 0 then
/// no conflicts were detected and the command was executed successfully.
/// Otherwise conflicts were detected and the user must specify how to
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICommitLongTransactionImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICommitLongTransactionImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICommitLongTransactionImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,7 +27,9 @@
public __gc __interface ILongTransactionConflictDirectiveEnumerator;
/// \brief
-/// The FdoICommitLongTransaction interface defines the CommitLongTransaction
+/// The ICommitLongTransactionImp class is a
+/// concrete implementation of ICommitLongTransaction.
+/// The ICommitLongTransaction interface defines the CommitLongTransaction
/// command, which allows a user to execute commit operations on a long
/// transaction. Two different commit operations are distinguished: full and partial.
///
@@ -42,7 +44,8 @@
/// In addition, a full commit can be performed on a leaf long transaction
/// only. A long transaction is a leaf long transaction if it does not
/// have descendent versions.
-private __gc class ICommitLongTransactionImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ICommitLongTransaction
+private __gc class ICommitLongTransactionImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ICommitLongTransaction
{
public:
/// \brief
@@ -65,7 +68,7 @@
__property System::Void set_Name(System::String* value);
/// Executes the commit long transaction command and returns an
- /// FdoILongTransactionConflictDirectiveEnumerator.
+ /// ILongTransactionConflictDirectiveEnumerator.
/// If the returned enumerator's count is 0 then
/// no conflicts were detected and the command was executed successfully.
/// Otherwise conflicts were detected and the user must specify how to
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLTCheckpointImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLTCheckpointImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLTCheckpointImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,7 +26,9 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoICreateLongTransactionCheckpoint interface defines the
+/// The ICreateLongTransactionCheckpointImp class is a
+/// concrete implementation of ICreateLongTransactionCheckpoint.
+/// The ICreateLongTransactionCheckpoint interface defines the
/// CreateLongTransactionCheckpoint command, which allows the user to create a
/// checkpoint for any long transaction to which the user has the access privileges.
private __gc class ICreateLongTransactionCheckpointImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ICreateLongTransactionCheckpoint
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLongTransaction.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLongTransaction.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLongTransaction.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -23,7 +23,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoICreateLongTransaction interface defines the CreateLongTransaction
+/// The ICreateLongTransaction interface defines the CreateLongTransaction
/// command which creates a long transaction that is based upon the currently
/// active long transaction. If no long transaction is active, then the long
/// transaction is based upon the root data. Input to the create long
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLongTransactionCheckpoint.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLongTransactionCheckpoint.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLongTransactionCheckpoint.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -23,7 +23,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoICreateLongTransactionCheckpoint interface defines the
+/// The ICreateLongTransactionCheckpoint interface defines the
/// CreateLongTransactionCheckpoint command, which allows the user to create a
/// checkpoint for any long transaction to which the user has the access privileges.
public __gc __interface ICreateLongTransactionCheckpoint : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLongTransactionImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLongTransactionImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgICreateLongTransactionImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,13 +26,15 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoICreateLongTransaction interface defines the CreateLongTransaction
+/// The ICreateLongTransactionImp class is a
+/// concrete implementation of ICreateLongTransaction.
/// command which creates a long transaction that is based upon the currently
/// active long transaction. If no long transaction is active, then the long
/// transaction is based upon the root data. Input to the create long
/// transaction command includes a name and description for the new long
/// transaction.
-private __gc class ICreateLongTransactionImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ICreateLongTransaction
+private __gc class ICreateLongTransactionImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ICreateLongTransaction
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIDeactivateLongTransaction.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIDeactivateLongTransaction.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIDeactivateLongTransaction.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -23,7 +23,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoIDeactivateLongTransaction interface defines the
+/// The IDeactivateLongTransaction interface defines the
/// DeactivateLongTransaction command, which deactivates the active long
/// transaction where feature manipulation commands operate on it. If the
/// active long transaction is the root long transaction, then no long
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIDeactivateLongTransactionImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIDeactivateLongTransactionImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIDeactivateLongTransactionImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,12 +26,15 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoIDeactivateLongTransaction interface defines the
+/// The IDeactivateLongTransactionImp class is a
+/// concrete implementation of IDeactivateLongTransaction.
+/// The IDeactivateLongTransaction interface defines the
/// DeactivateLongTransaction command, which deactivates the active long
/// transaction where feature manipulation commands operate on it. If the
/// active long transaction is the root long transaction, then no long
/// transaction will be deactivated.
-private __gc class IDeactivateLongTransactionImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IDeactivateLongTransaction
+private __gc class IDeactivateLongTransactionImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IDeactivateLongTransaction
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIFreezeLongTransaction.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIFreezeLongTransaction.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIFreezeLongTransaction.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,7 +24,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoIFreezeLongTransaction interface defines the FreezeLongTransaction
+/// The IFreezeLongTransaction interface defines the FreezeLongTransaction
/// command, which freezes or thaws a long transaction. When a long transaction
/// is frozen the user who froze it gains exclusive access to it. Other users can
/// read it, but not apply any updates.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIFreezeLongTransactionImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIFreezeLongTransactionImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIFreezeLongTransactionImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,7 +27,9 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoIFreezeLongTransaction interface defines the FreezeLongTransaction
+/// The IFreezeLongTransactionImp class is a
+/// concrete implementation of IFreezeLongTransaction.
+/// The IFreezeLongTransaction interface defines the FreezeLongTransaction
/// command, which freezes or thaws a long transaction. When a long transaction
/// is frozen the user who froze it gains exclusive access to it. Other users can
/// read it, but not apply any updates.
@@ -35,7 +37,8 @@
/// the operation to perform. The Execute method performs the specified
/// operation on the identified long transaction if the user has access
/// privileges for the indicated long transaction.
-private __gc class IFreezeLongTransactionImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IFreezeLongTransaction
+private __gc class IFreezeLongTransactionImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IFreezeLongTransaction
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionCheckpoints.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionCheckpoints.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionCheckpoints.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,7 +24,7 @@
public __gc __interface ILongTransactionCheckpointReader;
/// \brief
-/// The FdoIGetLongTransactionCheckpoints interface defines the
+/// The IGetLongTransactionCheckpoints interface defines the
/// GetLongTransactionCheckpoints command, which allows the user to enumerate
/// the checkpoints for a given long transaction. To execute the operation, the
/// user must have access privilege to the long transaction.
@@ -52,7 +52,7 @@
/// \brief
/// Executes the get long transaction checkpoints command, returning a
- /// reference to an FdoILongTransactionCheckpointReader.
+ /// reference to an ILongTransactionCheckpointReader.
///
/// \return
/// Returns nothing
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionCheckpointsImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionCheckpointsImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionCheckpointsImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,7 +27,9 @@
public __gc __interface ILongTransactionCheckpointReader;
/// \brief
-/// The FdoIGetLongTransactionCheckpoints interface defines the
+/// The IGetLongTransactionCheckpointsImp class is a
+/// concrete implementation of IGetLongTransactionCheckpoints.
+/// The IGetLongTransactionCheckpoints interface defines the
/// GetLongTransactionCheckpoints command, which allows the user to enumerate
/// the checkpoints for a given long transaction. To execute the operation, the
/// user must have access privilege to the long transaction.
@@ -55,7 +57,7 @@
/// \brief
/// Executes the get long transaction checkpoints command, returning a
- /// reference to an FdoILongTransactionCheckpointReader.
+ /// reference to an ILongTransactionCheckpointReader.
///
/// \return
/// Returns nothing
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionPrivileges.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionPrivileges.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionPrivileges.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,7 +24,7 @@
public __gc __interface ILongTransactionPrivilegeReader;
/// \brief
-/// The FdoIGetLongTransactionPrivileges interface defines the
+/// The IGetLongTransactionPrivileges interface defines the
/// GetLongTransactionPrivileges command, which allows the user to enumerate the
/// privileges of a long transaction established for each user. The ability to
/// successfully execute the command might be restricted by the datastore security
@@ -55,7 +55,7 @@
/// \brief
/// Executes the GetLongTransactionPrivileges command, returning a reference
- /// to an FdoILongTransactionPrivilegeReader.
+ /// to an ILongTransactionPrivilegeReader.
///
/// \return
/// Returns the long transaction privilege reader.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionPrivilegesImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionPrivilegesImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionPrivilegesImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,12 +27,15 @@
public __gc __interface ILongTransactionPrivilegeReader;
/// \brief
-/// The FdoIGetLongTransactionPrivileges interface defines the
+/// The IGetLongTransactionPrivilegesImp class is a
+/// concrete implementation of IGetLongTransactionPrivileges.
+/// The IGetLongTransactionPrivileges interface defines the
/// GetLongTransactionPrivileges command, which allows the user to enumerate the
/// privileges of a long transaction established for each user. The ability to
/// successfully execute the command might be restricted by the datastore security
/// if the long transaction doesn’t belong to the user executing the command.
-private __gc class IGetLongTransactionPrivilegesImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IGetLongTransactionPrivileges
+private __gc class IGetLongTransactionPrivilegesImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IGetLongTransactionPrivileges
{
public:
/// \brief
@@ -58,7 +61,7 @@
/// \brief
/// Executes the GetLongTransactionPrivileges command, returning a reference
- /// to an FdoILongTransactionPrivilegeReader.
+ /// to an ILongTransactionPrivilegeReader.
///
/// \return
/// Returns the long transaction privilege reader.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactions.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactions.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactions.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,9 +24,9 @@
public __gc __interface ILongTransactionReader;
/// \brief
-/// The FdoIGetLongTransactions interface defines the GetLongTransactions
+/// The IGetLongTransactions interface defines the GetLongTransactions
/// command. It allows a user to retrieve long transaction information for all or
-/// a specific long transaction. The command returns a FdoILongTransactionReader
+/// a specific long transaction. The command returns a ILongTransactionReader
/// object enumerating the identified long transactions.
public __gc __interface IGetLongTransactions : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
{
@@ -55,7 +55,7 @@
/// \brief
/// Executes the GetLongTransactions command returning a reference to an
- /// FdoILongTransactionReader.
+ /// ILongTransactionReader.
///
/// \return
/// Returns a long transaction reader
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionsImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionsImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionsImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,11 +27,13 @@
public __gc __interface ILongTransactionReader;
/// \brief
-/// The FdoIGetLongTransactions interface defines the GetLongTransactions
+/// The IGetLongTransactionsImp class is a concrete implementation of IGetLongTransactions.
+/// The IGetLongTransactions interface defines the GetLongTransactions
/// command. It allows a user to retrieve long transaction information for all or
-/// a specific long transaction. The command returns a FdoILongTransactionReader
+/// a specific long transaction. The command returns a ILongTransactionReader
/// object enumerating the identified long transactions.
-private __gc class IGetLongTransactionsImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IGetLongTransactions
+private __gc class IGetLongTransactionsImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IGetLongTransactions
{
public:
/// \brief
@@ -58,7 +60,7 @@
/// \brief
/// Executes the GetLongTransactions command returning a reference to an
- /// FdoILongTransactionReader.
+ /// ILongTransactionReader.
///
/// \return
/// Returns a long transaction reader
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionsInSet.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionsInSet.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionsInSet.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,7 +24,7 @@
public __gc __interface ILongTransactionSetReader;
/// \brief
-/// The FdoIGetLongTransactionsInSet interface defines the GetLongTransactionsInSet
+/// The IGetLongTransactionsInSet interface defines the GetLongTransactionsInSet
/// command, which allows the user to enumerate the list of versions
/// participating in the long transaction selection set.
public __gc __interface IGetLongTransactionsInSet : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
@@ -32,7 +32,7 @@
public:
/// \brief
/// Executes the GetLongTransactionsInSet command, returning a reference
- /// to an FdoILongTransactionSetReader.
+ /// to an ILongTransactionSetReader.
///
/// \return
/// Returns the long transaction reader
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionsInSetImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionsInSetImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIGetLongTransactionsInSetImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,15 +27,17 @@
public __gc __interface ILongTransactionSetReader;
/// \brief
-/// The FdoIGetLongTransactionsInSet interface defines the GetLongTransactionsInSet
+/// The IGetLongTransactionsInSetImp class is a concrete implementation of IGetLongTransactionsInSet.
+/// The IGetLongTransactionsInSet interface defines the GetLongTransactionsInSet
/// command, which allows the user to enumerate the list of versions
/// participating in the long transaction selection set.
-private __gc class IGetLongTransactionsInSetImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IGetLongTransactionsInSet
+private __gc class IGetLongTransactionsInSetImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IGetLongTransactionsInSet
{
public:
/// \brief
/// Executes the GetLongTransactionsInSet command, returning a reference
- /// to an FdoILongTransactionSetReader.
+ /// to an ILongTransactionSetReader.
///
/// \return
/// Returns the long transaction reader
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTCheckpointReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTCheckpointReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTCheckpointReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -25,13 +25,16 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoILongTransactionCheckpointReader interface provides forward only,
+/// The ILongTransactionCheckpointReaderImp class is a concrete
+/// implementation of ILongTransactionCheckpointReader.
+/// The ILongTransactionCheckpointReader interface provides forward only,
/// read-only functionality for enumerating long transaction checkpoints.
-/// A reference to an FdoILongTransactionCheckpointReader is returned from
+/// A reference to an ILongTransactionCheckpointReader is returned from
/// the GetLongTransactionCheckpoints command. The initial position of
-/// the FdoILongTransactionCheckpointReader is prior to the first item.
+/// the ILongTransactionCheckpointReader is prior to the first item.
/// Thus, you must call ReadNext to begin accessing any data.
-private __gc class ILongTransactionCheckpointReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionCheckpointReader
+private __gc class ILongTransactionCheckpointReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionCheckpointReader
{
public:
/// \brief
@@ -78,7 +81,7 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the FdoILongTransactionCheckpointReader object, freeing any
+ /// Closes the ILongTransactionCheckpointReader object, freeing any
/// resources it may be holding.
///
/// \return
@@ -94,8 +97,10 @@
inline FdoILongTransactionCheckpointReader* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
- System::Void ReleaseUnmanagedObject();
+ System::Void ReleaseUnmanagedObject();
+/// \endcond
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTConflictDirectiveEnumerator.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTConflictDirectiveEnumerator.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTConflictDirectiveEnumerator.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -30,7 +30,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoILongTransactionConflictDirective interface is used to specify how
+/// The ILongTransactionConflictDirective interface is used to specify how
/// conflict should be resolved for a particular object.
public __gc __interface ILongTransactionConflictDirectiveEnumerator : public System::IDisposable
{
@@ -44,29 +44,29 @@
__property System::String* get_FeatureClassName();
/// \brief
- /// Returns FdoPropertyValueCollection containing the property values that
+ /// Returns PropertyValueCollection containing the property values that
/// uniquely identify the current feature in conflict.
///
/// \return
- /// Returns FdoPropertyValueCollection
+ /// Returns PropertyValueCollection
///
__property NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValueCollection* get_Identity();
/// \brief
- /// Gets the FdoLongTransactionConflictResolution value to use for the current
- /// feature. The default value is FdoLongTransactionConflictResolution_Child.
+ /// Gets the LongTransactionConflictResolution value to use for the current
+ /// feature. The default value is LongTransactionConflictResolution_Child.
///
/// \return
- /// Returns FdoLongTransactionConflictResolution value
+ /// Returns LongTransactionConflictResolution value
///
__property NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::LongTransactionConflictResolution get_Resolution();
/// \brief
- /// Sets the FdoLongTransactionConflictResolution value to use for the current
- /// feature. The default value is FdoLongTransactionConflictResolution_Child.
+ /// Sets the LongTransactionConflictResolution value to use for the current
+ /// feature. The default value is LongTransactionConflictResolution_Child.
///
/// \param value
- /// Input the FdoLongTransactionConflictResolution value
+ /// Input the LongTransactionConflictResolution value
///
/// \return
/// Returns nothing
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTConflictDirectiveEnumeratorImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTConflictDirectiveEnumeratorImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTConflictDirectiveEnumeratorImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -30,9 +30,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoILongTransactionConflictDirective interface is used to specify how
+/// The ILongTransactionConflictDirectiveEnumeratorImp class is a concrete
+/// implementation of ILongTransactionConflictDirectiveEnumerator.
+/// The ILongTransactionConflictDirective interface is used to specify how
/// conflict should be resolved for a particular object.
-private __gc class ILongTransactionConflictDirectiveEnumeratorImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionConflictDirectiveEnumerator
+private __gc class ILongTransactionConflictDirectiveEnumeratorImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionConflictDirectiveEnumerator
{
public:
/// \brief
@@ -44,29 +47,29 @@
__property System::String* get_FeatureClassName();
/// \brief
- /// Returns FdoPropertyValueCollection containing the property values that
+ /// Returns PropertyValueCollection containing the property values that
/// uniquely identify the current feature in conflict.
///
/// \return
- /// Returns FdoPropertyValueCollection
+ /// Returns PropertyValueCollection
///
__property NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValueCollection* get_Identity();
/// \brief
- /// Gets the FdoLongTransactionConflictResolution value to use for the current
- /// feature. The default value is FdoLongTransactionConflictResolution_Child.
+ /// Gets the LongTransactionConflictResolution value to use for the current
+ /// feature. The default value is LongTransactionConflictResolution_Child.
///
/// \return
- /// Returns FdoLongTransactionConflictResolution value
+ /// Returns LongTransactionConflictResolution value
///
__property NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::LongTransactionConflictResolution get_Resolution();
/// \brief
- /// Sets the FdoLongTransactionConflictResolution value to use for the current
- /// feature. The default value is FdoLongTransactionConflictResolution_Child.
+ /// Sets the LongTransactionConflictResolution value to use for the current
+ /// feature. The default value is LongTransactionConflictResolution_Child.
///
/// \param value
- /// Input the FdoLongTransactionConflictResolution value
+ /// Input the LongTransactionConflictResolution value
///
/// \return
/// Returns nothing
@@ -103,8 +106,10 @@
///
System::Void Reset();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ILongTransactionConflictDirectiveEnumeratorImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTPrivilegeReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTPrivilegeReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILTPrivilegeReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,7 +24,17 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
-private __gc class ILongTransactionPrivilegeReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionPrivilegeReader
+/// \brief
+/// The ILongTransactionPrivilegeReaderImp class is a concrete
+/// implementation of ILongTransactionPrivilegeReader.
+/// The ILongTransactionPrivilegeReader interface provides forward only,
+/// read-only functionality for enumerating long transaction privileges.
+/// A reference to an FdoILongTransactionPrivilegeReader is returned from
+/// the GetLongTransactionPrivileges command. The initial position of
+/// the ILongTransactionPrivilegeReader is prior to the first item.
+/// Thus, you must call ReadNext to begin accessing any data.
+private __gc class ILongTransactionPrivilegeReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionPrivilegeReader
{
public:
/// \brief
@@ -38,11 +48,11 @@
/// \brief
/// Gets the privileges granted to the user currently being read. The
/// returned value may be any combination of the values from the
- /// FdoLongTransactionPrivileges enumeration combined via a bit-wise or
+ /// LongTransactionPrivileges enumeration combined via a bit-wise or
/// operation.
///
/// \return
- /// Returns the privileges as a bit masked value based on FdoLongTransactionPrivileges enumeration
+ /// Returns the privileges as a bit masked value based on LongTransactionPrivileges enumeration
///
System::Int32 GetPrivileges();
@@ -57,7 +67,7 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the FdoILongTransactionPrivilegesReader object, freeing any
+ /// Closes the ILongTransactionPrivilegesReader object, freeing any
/// resources it may be holding.
///
/// \return
@@ -73,8 +83,10 @@
inline FdoILongTransactionPrivilegeReader* GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
+/// \endcond
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionCheckpointReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionCheckpointReader.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionCheckpointReader.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -21,11 +21,11 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoILongTransactionCheckpointReader interface provides forward only,
+/// The ILongTransactionCheckpointReader interface provides forward only,
/// read-only functionality for enumerating long transaction checkpoints.
-/// A reference to an FdoILongTransactionCheckpointReader is returned from
+/// A reference to an ILongTransactionCheckpointReader is returned from
/// the GetLongTransactionCheckpoints command. The initial position of
-/// the FdoILongTransactionCheckpointReader is prior to the first item.
+/// the ILongTransactionCheckpointReader is prior to the first item.
/// Thus, you must call ReadNext to begin accessing any data.
public __gc __interface ILongTransactionCheckpointReader : public System::IDisposable
{
@@ -74,7 +74,7 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the FdoILongTransactionCheckpointReader object, freeing any
+ /// Closes the ILongTransactionCheckpointReader object, freeing any
/// resources it may be holding.
///
/// \return
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionPrivilegeReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionPrivilegeReader.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionPrivilegeReader.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -20,6 +20,13 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
+/// \brief
+/// The ILongTransactionPrivilegeReader interface provides forward only,
+/// read-only functionality for enumerating long transaction privileges.
+/// A reference to an FdoILongTransactionPrivilegeReader is returned from
+/// the GetLongTransactionPrivileges command. The initial position of
+/// the ILongTransactionPrivilegeReader is prior to the first item.
+/// Thus, you must call ReadNext to begin accessing any data.
public __gc __interface ILongTransactionPrivilegeReader : public System::IDisposable
{
public:
@@ -34,11 +41,11 @@
/// \brief
/// Gets the privileges granted to the user currently being read. The
/// returned value may be any combination of the values from the
- /// FdoLongTransactionPrivileges enumeration combined via a bit-wise or
+ /// LongTransactionPrivileges enumeration combined via a bit-wise or
/// operation.
///
/// \return
- /// Returns the privileges as a bit masked value based on FdoLongTransactionPrivileges enumeration
+ /// Returns the privileges as a bit masked value based on LongTransactionPrivileges enumeration
///
System::Int32 GetPrivileges();
@@ -53,7 +60,7 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the FdoILongTransactionPrivilegesReader object, freeing any
+ /// Closes the ILongTransactionPrivilegesReader object, freeing any
/// resources it may be holding.
///
/// \return
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionReader.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionReader.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -21,10 +21,10 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoILongTransactionReader interface provides forward only,
+/// The ILongTransactionReader interface provides forward only,
/// read-only functionality for enumerating long transactions. A reference
-/// to an FdoILongTransactionReader is returned from the GetLongTransactions
-/// command. The initial position of the FdoILongTransactionReader is prior
+/// to an ILongTransactionReader is returned from the GetLongTransactions
+/// command. The initial position of the ILongTransactionReader is prior
/// to the first item. Thus, you must call ReadNext to begin accessing any
/// data.
public __gc __interface ILongTransactionReader : public System::IDisposable
@@ -121,7 +121,7 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the FdoILongTransactionReader object, freeing any
+ /// Closes the ILongTransactionReader object, freeing any
/// resources it may be holding.
///
/// \return
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,13 +26,15 @@
public __gc __interface ILongTransactionReader;
/// \brief
-/// The FdoILongTransactionReader interface provides forward only,
+/// The ILongTransactionReaderImp class is a concrete implementation of ILongTransactionReader.
+/// The ILongTransactionReader interface provides forward only,
/// read-only functionality for enumerating long transactions. A reference
-/// to an FdoILongTransactionReader is returned from the GetLongTransactions
-/// command. The initial position of the FdoILongTransactionReader is prior
+/// to an ILongTransactionReader is returned from the GetLongTransactions
+/// command. The initial position of the ILongTransactionReader is prior
/// to the first item. Thus, you must call ReadNext to begin accessing any
/// data.
-private __gc class ILongTransactionReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionReader
+private __gc class ILongTransactionReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionReader
{
public:
/// \brief
@@ -126,7 +128,7 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the FdoILongTransactionReader object, freeing any
+ /// Closes the ILongTransactionReader object, freeing any
/// resources it may be holding.
///
/// \return
@@ -134,8 +136,10 @@
///
System::Void Close();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ILongTransactionReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionSetReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionSetReader.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionSetReader.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -21,11 +21,11 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoILongTransactionSetReader interface provides forward only, read-only
+/// The ILongTransactionSetReader interface provides forward only, read-only
/// functionality for enumerating the versions in the long transaction selection
-/// set. A reference to an FdoILongTransactionSetReader is returned from the
+/// set. A reference to an ILongTransactionSetReader is returned from the
/// GetLongTransactionsInSet command. The initial position of the
-/// FdoILongTransactionSetReader is prior to the first item. Thus, you must
+/// ILongTransactionSetReader is prior to the first item. Thus, you must
/// call ReadNext to begin accessing any data.
public __gc __interface ILongTransactionSetReader : public System::IDisposable
{
@@ -59,7 +59,7 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the FdoILongTransactionSetReader object, freeing any resources
+ /// Closes the ILongTransactionSetReader object, freeing any resources
/// it may be holding.
///
/// \return
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionSetReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionSetReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgILongTransactionSetReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -25,11 +25,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoILongTransactionSetReader interface provides forward only, read-only
+/// The ILongTransactionSetReaderImp class is a concrete implementation of ILongTransactionSetReader.
+/// The ILongTransactionSetReader interface provides forward only, read-only
/// functionality for enumerating the versions in the long transaction selection
-/// set. A reference to an FdoILongTransactionSetReader is returned from the
+/// set. A reference to an ILongTransactionSetReader is returned from the
/// GetLongTransactionsInSet command. The initial position of the
-/// FdoILongTransactionSetReader is prior to the first item. Thus, you must
+/// ILongTransactionSetReader is prior to the first item. Thus, you must
/// call ReadNext to begin accessing any data.
private __gc class ILongTransactionSetReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionSetReader
{
@@ -63,7 +64,7 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the FdoILongTransactionSetReader object, freeing any resources
+ /// Closes the ILongTransactionSetReader object, freeing any resources
/// it may be holding.
///
/// \return
@@ -71,8 +72,10 @@
///
System::Void Close();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ILongTransactionSetReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLTCheckpointImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLTCheckpointImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLTCheckpointImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,12 +26,15 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoIRollbackLongTransactionCheckpoint interface defines the
+/// The IRollbackLongTransactionCheckpointImp class is a concrete
+/// implementation of IRollbackLongTransactionCheckpoint.
+/// The IRollbackLongTransactionCheckpoint interface defines the
/// RollbackLongTransactionCheckpoint command, which allows the user to roll back
/// changes to a named checkpoint for the given long transaction. The user
/// requires the access privilege on the long transaction for which the user tries
/// to perform the operation.
-private __gc class IRollbackLongTransactionCheckpointImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IRollbackLongTransactionCheckpoint
+private __gc class IRollbackLongTransactionCheckpointImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IRollbackLongTransactionCheckpoint
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLongTransaction.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLongTransaction.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLongTransaction.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -23,7 +23,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoIRollbackLongTransaction interface defines the RollbackLongTransaction
+/// The IRollbackLongTransaction interface defines the RollbackLongTransaction
/// command, which allows a user to execute rollback operations on a long
/// transaction. Two different rollback operations are distinguished: full and partial.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLongTransactionCheckpoint.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLongTransactionCheckpoint.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLongTransactionCheckpoint.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -23,7 +23,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoIRollbackLongTransactionCheckpoint interface defines the
+/// The IRollbackLongTransactionCheckpoint interface defines the
/// RollbackLongTransactionCheckpoint command, which allows the user to roll back
/// changes to a named checkpoint for the given long transaction. The user
/// requires the access privilege on the long transaction for which the user tries
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLongTransactionImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLongTransactionImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgIRollbackLongTransactionImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,7 +26,8 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoIRollbackLongTransaction interface defines the RollbackLongTransaction
+/// The IRollbackLongTransactionImp class is a concrete implementation of IRollbackLongTransaction.
+/// The IRollbackLongTransaction interface defines the RollbackLongTransaction
/// command, which allows a user to execute rollback operations on a long
/// transaction. Two different rollback operations are distinguished: full and partial.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionConflictResolution.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionConflictResolution.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionConflictResolution.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -21,16 +21,16 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoLongTransactionConflictResolution enumeration defines the list of
+/// The LongTransactionConflictResolution enumeration defines the list of
/// available options for resolving conflict.
-/// <param name="FdoLongTransactionConflictResolution_Unresolved">
+/// <param name="LongTransactionConflictResolution_Unresolved">
/// Indicates that the conflict cannot be resolved.
/// </param>
-/// <param name="FdoLongTransactionConflictResolution_Child">
+/// <param name="LongTransactionConflictResolution_Child">
/// Indicates the data is to be kept as defined in the long transaction to be committed,
/// overwriting the data in the long transaction's parent.
/// </param>
-/// <param name="FdoLongTransactionConflictResolution_Parent">
+/// <param name="LongTransactionConflictResolution_Parent">
/// Indicates the data is to be kept as defined in the versions parent, discarding the data
/// as defined in the long transaction to be committed.
/// </param>
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionFreezeOperations.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionFreezeOperations.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionFreezeOperations.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -21,11 +21,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoLongTransactionFreezeOperations enumeration defines the list of available operations that can be performed by the FreezeLongTransaction command.
-/// <param name="FdoLongTransactionFreezeOperations_Freeze">
+/// The LongTransactionFreezeOperations enumeration defines the
+/// list of available operations that can be performed by the FreezeLongTransaction command.
+/// <param name="LongTransactionFreezeOperations_Freeze">
/// Freeze the long transaction for exclusive update
/// </param>
-/// <param name="FdoLongTransactionFreezeOperations_Thaw">
+/// <param name="LongTransactionFreezeOperations_Thaw">
/// Thaw the long transaction
/// </param>
[System::FlagsAttribute]
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionPrivilegeOperations.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionPrivilegeOperations.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionPrivilegeOperations.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -21,13 +21,13 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoLongTransactionPrivilegeOperations enumeration defines the list
+/// The LongTransactionPrivilegeOperations enumeration defines the list
/// of available operations that can be performed by the
/// ChangeLongTransactionPrivileges command.
-/// <param name="FdoLongTransactionPrivilegeOperations_Grant">
+/// <param name="LongTransactionPrivilegeOperations_Grant">
/// Indicates the user is to be granted the specified privileges.
/// </param>
-/// <param name="FdoLongTransactionPrivilegeOperations_Revoke">
+/// <param name="LongTransactionPrivilegeOperations_Revoke">
/// Indicates the specified privileges are to be revoked from the user.
/// </param>
[System::FlagsAttribute]
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionPrivileges.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionPrivileges.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionPrivileges.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -21,34 +21,34 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoLongTransactionPrivileges enumeration defines the long transaction
+/// The LongTransactionPrivileges enumeration defines the long transaction
/// privilege flags.
-/// <param name="FdoLongTransactionPrivileges_Access">
+/// <param name="LongTransactionPrivileges_Access">
/// The access privilege is required for a user if the user needs to access
/// a long transaction.
/// </param>
-/// <param name="FdoLongTransactionPrivileges_Create">
+/// <param name="LongTransactionPrivileges_Create">
/// A user must have access and create privileges on the active long
/// transaction if the user wants to create a new long transaction as a
/// descendent of the active long transaction.
/// </param>
-/// <param name="FdoLongTransactionPrivileges_Commit">
+/// <param name="LongTransactionPrivileges_Commit">
/// A user must have access and commit privileges on a long transaction
/// in order to commit it. In addition, the user needs access privilege to
/// the long transaction's parent. The user also needs remove privilege on
/// the long transaction to be committed if the operation to be executed
/// is a commit and not a partial commit.
/// </param>
-/// <param name="FdoLongTransactionPrivileges_Rollback">
+/// <param name="LongTransactionPrivileges_Rollback">
/// A user must have access and rollback privileges on a long transaction
/// in order to roll it back. In addition, the user requires access
/// privilege for each of the descendent versions involved in the operation. The user also requires the remove privilege for each of the versions involved in the operation if a rollback and not a partial rollback operation is executed.
/// </param>
-/// <param name="FdoLongTransactionPrivileges_Remove">
+/// <param name="LongTransactionPrivileges_Remove">
/// The long transaction privilege is required if the user should be allowed to remove the
/// long transaction in the progress of a commit or roll back operation.
/// </param>
-/// <param name="FdoLongTransactionPrivileges_Freeze">
+/// <param name="LongTransactionPrivileges_Freeze">
/// The user requires the access and freeze privileges on a long
/// transaction for which the user wants to gain exclusive access to a
/// long transaction.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionSetOperations.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionSetOperations.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/LongTransaction/mgLongTransactionSetOperations.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -21,15 +21,15 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
/// \brief
-/// The FdoLongTransactionSetOperations enumeration defines the list of
+/// The LongTransactionSetOperations enumeration defines the list of
/// available operations that can be performed by the ChangeLongTransactionSet command.
-/// <param name="FdoLongTransactionSetOperations_Add">
+/// <param name="LongTransactionSetOperations_Add">
/// Add the specified long transaction to the selection set.
/// </param>
-/// <param name="FdoLongTransactionSetOperations_Remove">
+/// <param name="LongTransactionSetOperations_Remove">
/// Remove the specified long transaction from the selection set.
/// </param>
-/// <param name="FdoLongTransactionSetOperations_Clear">
+/// <param name="LongTransactionSetOperations_Clear">
/// Clear the selection set.
/// </param>
[System::FlagsAttribute]
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLCommand.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLCommand.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLCommand.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,7 +24,7 @@
public __gc __interface ISQLDataReader;
/// \brief
-/// The FdoISQLCommand interface defines the SQL command, which supports the
+/// The ISQLCommand interface defines the SQL command, which supports the
/// execution of a SQL statement against an underlying RDBMS. Two execute
/// methods are provided to distinguish between statements that return table data
/// versus those that execute non query type operations.
@@ -61,7 +61,7 @@
/// \brief
/// Executes the SQL statement against the connection object and returns
- /// an FdoISQLDataReader.
+ /// an ISQLDataReader.
///
/// \return
/// Returns the data reader.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLCommandImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLCommandImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLCommandImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,11 +27,13 @@
public __gc __interface ISQLDataReader;
/// \brief
-/// The FdoISQLCommand interface defines the SQL command, which supports the
+/// The ISQLCommandImp class is a concrete implementation of ISQLCommand.
+/// The ISQLCommand interface defines the SQL command, which supports the
/// execution of a SQL statement against an underlying RDBMS. Two execute
/// methods are provided to distinguish between statements that return table data
/// versus those that execute non query type operations.
-private __gc class ISQLCommandImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_SQL::ISQLCommand
+private __gc class ISQLCommandImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_SQL::ISQLCommand
{
public:
/// \brief
@@ -64,7 +66,7 @@
/// \brief
/// Executes the SQL statement against the connection object and returns
- /// an FdoISQLDataReader.
+ /// an ISQLDataReader.
///
/// \return
/// Returns the data reader.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLDataReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLDataReader.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLDataReader.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -32,10 +32,10 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SQL
/// \brief
-/// The FdoISQLDataReader interface provides a forward-only, read-only
+/// The ISQLDataReader interface provides a forward-only, read-only
/// iterator for reading relational table data. A reference to an
-/// FdoISQLDataReader is returned from the SQLCommands ExecuteReader method.
-/// The initial position of the FdoISQLDataReader interface is prior to the first item.
+/// ISQLDataReader is returned from the SQLCommands ExecuteReader method.
+/// The initial position of the ISQLDataReader interface is prior to the first item.
/// Thus, you must call ReadNext to begin accessing any data.
public __gc __interface ISQLDataReader : public System::IDisposable
{
@@ -71,21 +71,21 @@
NAMESPACE_OSGEO_FDO_SCHEMA::DataType GetColumnType(System::String* name);
/// \brief
- /// Gets the FDO property type of the column with the specified name. This is used
+ /// Gets property type of the column with the specified name. This is used
/// to indicate if a given column is a geometric property or a data property. If the column is
- /// a FdoPropertyType_DataProperty, then GetColumnType can be used to find the data type of the column.
+ /// a PropertyType_DataProperty, then GetColumnType can be used to find the data type of the column.
///
/// \param propertyName
/// Input the column name.
///
/// \return
- /// Returns the FDO property type of the column.
+ /// Returns property type of the column.
///
NAMESPACE_OSGEO_FDO_SCHEMA::PropertyType GetPropertyType(System::String* name);
/// \brief
/// Gets the Boolean value of the specified column. No conversion is
- /// performed, thus the column must be FdoDataType_Boolean or an
+ /// performed, thus the column must be DataType_Boolean or an
/// exception is thrown.
///
/// \param name
@@ -98,7 +98,7 @@
/// \brief
/// Gets the byte value of the specified column. No conversion is
- /// performed, thus the column must be FdoDataType_Byte or an
+ /// performed, thus the column must be DataType_Byte or an
/// exception is thrown.
///
/// \param name
@@ -111,7 +111,7 @@
/// \brief
/// Gets the date time value of the specified column. No conversion
- /// is performed, thus the column must be FdoDataType_DateTime or
+ /// is performed, thus the column must be DataType_DateTime or
/// an exception is thrown.
///
/// \param name
@@ -137,46 +137,46 @@
/// \brief
/// Gets the signed 16-bit integer value of the specified column. No conversion is
- /// performed, thus the column must be FdoDataType_Int16 or an
+ /// performed, thus the column must be DataType_Int16 or an
/// exception is thrown.
///
/// \param name
/// Input the column name.
///
/// \return
- /// Returns the FdoInt16 value.
+ /// Returns the Int16 value.
///
System::Int16 GetInt16(System::String* name);
/// \brief
/// Gets the signed 32-bit integer value of the specified column. No conversion is
- /// performed, thus the column must be FdoDataType_Int32 or an
+ /// performed, thus the column must be DataType_Int32 or an
/// exception is thrown.
///
/// \param name
/// Input the column name.
///
/// \return
- /// Returns the FdoInt32 value.
+ /// Returns the Int32 value.
///
System::Int32 GetInt32(System::String* name);
/// \brief
/// Gets the signed 64-bit integer value of the specified column. No conversion
- /// is performed, thus the column must be FdoDataType_Int64 or an
+ /// is performed, thus the column must be DataType_Int64 or an
/// exception is thrown.
///
/// \param name
/// Input the column name.
///
/// \return
- /// Returns the FdoInt64 value.
+ /// Returns the Int64 value.
///
System::Int64 GetInt64(System::String* name);
/// \brief
/// Gets the single-precision floating point value of the specified column.
- /// No conversion is performed, thus the column must be FdoDataType_Single
+ /// No conversion is performed, thus the column must be DataType_Single
/// or an exception is thrown.
///
/// \param name
@@ -189,7 +189,7 @@
/// \brief
/// Gets the string value of the specified column. No conversion is
- /// performed, thus the column must be FdoDataType_String or an
+ /// performed, thus the column must be DataType_String or an
/// exception is thrown.
///
/// \param name
@@ -202,8 +202,8 @@
/// \brief
/// Gets a LOBValue reference. The LOB is fully read in and data available.
- /// Because no conversion is performed, the property must be FdoDataType_BLOB or
- /// FdoDataType_CLOB etc. (a LOB type)
+ /// Because no conversion is performed, the property must be DataType_BLOB or
+ /// DataType_CLOB etc. (a LOB type)
///
/// \param propertyName
/// Input the property name.
@@ -214,11 +214,11 @@
NAMESPACE_OSGEO_FDO_EXPRESSION::LOBValue* GetLOB(System::String* name);
/// \brief
- /// Gets a reference of the specified LOB property as a FdoBLOBStreamReader or
- /// FdoCLOBStreamReader etc. to allow reading in blocks of data.
- /// Because no conversion is performed, the property must be FdoDataType_BLOB
- /// or FdoDataType_CLOB etc. (a LOB type)
- /// Cast the FdoIStreamReader to the appropiate LOB Stream Reader.
+ /// Gets a reference of the specified LOB property as a BLOBStreamReader or
+ /// CLOBStreamReader etc. to allow reading in blocks of data.
+ /// Because no conversion is performed, the property must be DataType_BLOB
+ /// or DataType_CLOB etc. (a LOB type)
+ /// Cast the IStreamReader to the appropiate LOB Stream Reader.
///
/// \param propertyName
/// Input the property name.
@@ -263,7 +263,7 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the FdoISQLDataReader object, freeing any resources it may be holding.
+ /// Closes the ISQLDataReader object, freeing any resources it may be holding.
///
/// \return
/// Returns nothing
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLDataReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLDataReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SQL/mgISQLDataReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -35,12 +35,14 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SQL
/// \brief
-/// The FdoISQLDataReader interface provides a forward-only, read-only
+/// The ISQLDataReaderImp class is a concrete implementation of ISQLDataReader.
+/// The ISQLDataReader interface provides a forward-only, read-only
/// iterator for reading relational table data. A reference to an
-/// FdoISQLDataReader is returned from the SQLCommands ExecuteReader method.
-/// The initial position of the FdoISQLDataReader interface is prior to the first item.
+/// ISQLDataReader is returned from the SQLCommands ExecuteReader method.
+/// The initial position of the ISQLDataReader interface is prior to the first item.
/// Thus, you must call ReadNext to begin accessing any data.
-private __gc class ISQLDataReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_SQL::ISQLDataReader
+private __gc class ISQLDataReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_SQL::ISQLDataReader
{
public:
/// \brief
@@ -74,21 +76,21 @@
NAMESPACE_OSGEO_FDO_SCHEMA::DataType GetColumnType(System::String* name);
/// \brief
- /// Gets the FDO property type of the column with the specified name. This is used
+ /// Gets property type of the column with the specified name. This is used
/// to indicate if a given column is a geometric property or a data property. If the column is
- /// a FdoPropertyType_DataProperty, then GetColumnType can be used to find the data type of the column.
+ /// a PropertyType_DataProperty, then GetColumnType can be used to find the data type of the column.
///
/// \param propertyName
/// Input the column name.
///
/// \return
- /// Returns the FDO property type of the column.
+ /// Returns property type of the column.
///
NAMESPACE_OSGEO_FDO_SCHEMA::PropertyType GetPropertyType(System::String* name);
/// \brief
/// Gets the Boolean value of the specified column. No conversion is
- /// performed, thus the column must be FdoDataType_Boolean or an
+ /// performed, thus the column must be DataType_Boolean or an
/// exception is thrown.
///
/// \param name
@@ -101,7 +103,7 @@
/// \brief
/// Gets the byte value of the specified column. No conversion is
- /// performed, thus the column must be FdoDataType_Byte or an
+ /// performed, thus the column must be DataType_Byte or an
/// exception is thrown.
///
/// \param name
@@ -114,7 +116,7 @@
/// \brief
/// Gets the date time value of the specified column. No conversion
- /// is performed, thus the column must be FdoDataType_DateTime or
+ /// is performed, thus the column must be DataType_DateTime or
/// an exception is thrown.
///
/// \param name
@@ -140,46 +142,46 @@
/// \brief
/// Gets the signed 16-bit integer value of the specified column. No conversion is
- /// performed, thus the column must be FdoDataType_Int16 or an
+ /// performed, thus the column must be DataType_Int16 or an
/// exception is thrown.
///
/// \param name
/// Input the column name.
///
/// \return
- /// Returns the FdoInt16 value.
+ /// Returns the Int16 value.
///
System::Int16 GetInt16(System::String* name);
/// \brief
/// Gets the signed 32-bit integer value of the specified column. No conversion is
- /// performed, thus the column must be FdoDataType_Int32 or an
+ /// performed, thus the column must be DataType_Int32 or an
/// exception is thrown.
///
/// \param name
/// Input the column name.
///
/// \return
- /// Returns the FdoInt32 value.
+ /// Returns the Int32 value.
///
System::Int32 GetInt32(System::String* name);
/// \brief
/// Gets the signed 64-bit integer value of the specified column. No conversion
- /// is performed, thus the column must be FdoDataType_Int64 or an
+ /// is performed, thus the column must be DataType_Int64 or an
/// exception is thrown.
///
/// \param name
/// Input the column name.
///
/// \return
- /// Returns the FdoInt64 value.
+ /// Returns the Int64 value.
///
System::Int64 GetInt64(System::String* name);
/// \brief
/// Gets the single-precision floating point value of the specified column.
- /// No conversion is performed, thus the column must be FdoDataType_Single
+ /// No conversion is performed, thus the column must be DataType_Single
/// or an exception is thrown.
///
/// \param name
@@ -192,7 +194,7 @@
/// \brief
/// Gets the string value of the specified column. No conversion is
- /// performed, thus the column must be FdoDataType_String or an
+ /// performed, thus the column must be DataType_String or an
/// exception is thrown.
///
/// \param name
@@ -205,8 +207,8 @@
/// \brief
/// Gets a LOBValue reference. The LOB is fully read in and data available.
- /// Because no conversion is performed, the property must be FdoDataType_BLOB or
- /// FdoDataType_CLOB etc. (a LOB type)
+ /// Because no conversion is performed, the property must be DataType_BLOB or
+ /// DataType_CLOB etc. (a LOB type)
///
/// \param propertyName
/// Input the property name.
@@ -217,11 +219,11 @@
NAMESPACE_OSGEO_FDO_EXPRESSION::LOBValue* GetLOB(System::String* name);
/// \brief
- /// Gets a reference of the specified LOB property as a FdoBLOBStreamReader or
- /// FdoCLOBStreamReader etc. to allow reading in blocks of data.
- /// Because no conversion is performed, the property must be FdoDataType_BLOB
- /// or FdoDataType_CLOB etc. (a LOB type)
- /// Cast the FdoIStreamReader to the appropiate LOB Stream Reader.
+ /// Gets a reference of the specified LOB property as a BLOBStreamReader or
+ /// CLOBStreamReader etc. to allow reading in blocks of data.
+ /// Because no conversion is performed, the property must be DataType_BLOB
+ /// or DataType_CLOB etc. (a LOB type)
+ /// Cast the IStreamReader to the appropiate LOB Stream Reader.
///
/// \param propertyName
/// Input the property name.
@@ -266,15 +268,17 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the FdoISQLDataReader object, freeing any resources it may be holding.
+ /// Closes the ISQLDataReader object, freeing any resources it may be holding.
///
/// \return
/// Returns nothing
///
System::Void Close();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ISQLDataReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIApplySchema.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIApplySchema.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIApplySchema.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -28,10 +28,10 @@
public __gc class PhysicalSchemaMapping;
/// \brief
-/// The FdoIApplySchema interface defines the ApplySchema command, which creates or
+/// The IApplySchema interface defines the ApplySchema command, which creates or
/// updates a feature schema within the DataStore. Input to the ApplySchema
/// command is the feature schema instance to be created or updated. Optionally,
-/// a provider-specific FdoIPhysicalSchemaMapping interface can be specified that can be
+/// a provider-specific IPhysicalSchemaMapping interface can be specified that can be
/// used to control how the feature schema elements are mapped into physical
/// storage.
public __gc __interface IApplySchema : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
@@ -57,20 +57,20 @@
__property System::Void set_FeatureSchema(NAMESPACE_OSGEO_FDO_SCHEMA::FeatureSchema* value);
/// \brief
- /// Gets the FdoPhysicalSchemaMapping used to specify how the schema definition
+ /// Gets the PhysicalSchemaMapping used to specify how the schema definition
/// gets mapped into physical storage.
///
/// \return
- /// Returns FdoPhysicalSchemaMapping
+ /// Returns PhysicalSchemaMapping
///
__property NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* get_PhysicalMapping();
/// \brief
- /// Sets the FdoPhysicalSchemaMapping used to specify how the schema definition
+ /// Sets the PhysicalSchemaMapping used to specify how the schema definition
/// gets mapped into physical storage.
///
/// \param value
- /// Input the FdoPhysicalSchemaMapping
+ /// Input the PhysicalSchemaMapping
///
/// \return
/// Returns nothing
@@ -110,7 +110,7 @@
/// or the schema itself, then those classes (or the schema, if it is marked
/// as deleted) must not contain any instance data. If they do, an exception
/// will be thrown.
- /// Implementors must call FdoFeatureSchema::AcceptChanges() when Execute() succeeds.
+ /// Implementors must call FeatureSchema::AcceptChanges() when Execute() succeeds.
/// It must be called after the schema has been successfully applied, in
/// order to synchronize the states of the schema elements.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIApplySchemaImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIApplySchemaImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIApplySchemaImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -31,13 +31,15 @@
public __gc class PhysicalSchemaMapping;
/// \brief
-/// The FdoIApplySchema interface defines the ApplySchema command, which creates or
+/// The IApplySchemaImp class is a concrete implementation of IApplySchema.
+/// The IApplySchema interface defines the ApplySchema command, which creates or
/// updates a feature schema within the DataStore. Input to the ApplySchema
/// command is the feature schema instance to be created or updated. Optionally,
-/// a provider-specific FdoIPhysicalSchemaMapping interface can be specified that can be
+/// a provider-specific IPhysicalSchemaMapping interface can be specified that can be
/// used to control how the feature schema elements are mapped into physical
/// storage.
-private __gc class IApplySchemaImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IApplySchema
+private __gc class IApplySchemaImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IApplySchema
{
public:
/// \brief
@@ -60,20 +62,20 @@
__property System::Void set_FeatureSchema(NAMESPACE_OSGEO_FDO_SCHEMA::FeatureSchema* value);
/// \brief
- /// Gets the FdoPhysicalSchemaMapping used to specify how the schema definition
+ /// Gets the PhysicalSchemaMapping used to specify how the schema definition
/// gets mapped into physical storage.
///
/// \return
- /// Returns FdoPhysicalSchemaMapping
+ /// Returns PhysicalSchemaMapping
///
__property NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* get_PhysicalMapping();
/// \brief
- /// Sets the FdoPhysicalSchemaMapping used to specify how the schema definition
+ /// Sets the PhysicalSchemaMapping used to specify how the schema definition
/// gets mapped into physical storage.
///
/// \param value
- /// Input the FdoPhysicalSchemaMapping
+ /// Input the PhysicalSchemaMapping
///
/// \return
/// Returns nothing
@@ -113,7 +115,7 @@
/// or the schema itself, then those classes (or the schema, if it is marked
/// as deleted) must not contain any instance data. If they do, an exception
/// will be thrown.
- /// Implementors must call FdoFeatureSchema::AcceptChanges() when Execute() succeeds.
+ /// Implementors must call FeatureSchema::AcceptChanges() when Execute() succeeds.
/// It must be called after the schema has been successfully applied, in
/// order to synchronize the states of the schema elements.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchema.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchema.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchema.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,10 +27,10 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
/// \brief
-/// The FdoIDescribeSchema interface defines the DescribeSchema command, which
+/// The IDescribeSchema interface defines the DescribeSchema command, which
/// describes the feature schemas available from the connection. The DescribeSchema
/// command can describe a single schema or all schemas available from
-/// the connection. The Execute operation returns an FdoFeatureSchemaCollection
+/// the connection. The Execute operation returns an FeatureSchemaCollection
/// object.
public __gc __interface IDescribeSchema : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
{
@@ -58,17 +58,17 @@
/// \brief
/// Executes the DescribeSchema command and returns a
- /// FdoFeatureSchemaCollection. If a schema name is given that has
+ /// FeatureSchemaCollection. If a schema name is given that has
/// references to another schema, the dependent schemas will
/// be returned as well. If the specified schema name does not exist,
/// the Execute method throws an exception.
///
/// \return
/// Returns the schema collection representing the schema created.
- /// The element states for all elements will be set to FdoSchemaElementState_Unchanged.
+ /// The element states for all elements will be set to SchemaElementState_Unchanged.
/// Each provider-specific implementation of Execute() can ensure
/// that this is the case by
- /// calling FdoFeatureSchema::AcceptChanges() for each feature schema
+ /// calling FeatureSchema::AcceptChanges() for each feature schema
/// in the returned collection.
///
NAMESPACE_OSGEO_FDO_SCHEMA::FeatureSchemaCollection* Execute();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchemaImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchemaImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchemaImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -30,12 +30,14 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
/// \brief
-/// The FdoIDescribeSchema interface defines the DescribeSchema command, which
+/// The IDescribeSchemaImp class is a concrete implementation of IDescribeSchema.
+/// The IDescribeSchema interface defines the DescribeSchema command, which
/// describes the feature schemas available from the connection. The DescribeSchema
/// command can describe a single schema or all schemas available from
-/// the connection. The Execute operation returns an FdoFeatureSchemaCollection
+/// the connection. The Execute operation returns an FeatureSchemaCollection
/// object.
-private __gc class IDescribeSchemaImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IDescribeSchema
+private __gc class IDescribeSchemaImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IDescribeSchema
{
public:
/// \brief
@@ -61,17 +63,17 @@
/// \brief
/// Executes the DescribeSchema command and returns a
- /// FdoFeatureSchemaCollection. If a schema name is given that has
+ /// FeatureSchemaCollection. If a schema name is given that has
/// references to another schema, the dependent schemas will
/// be returned as well. If the specified schema name does not exist,
/// the Execute method throws an exception.
///
/// \return
/// Returns the schema collection representing the schema created.
- /// The element states for all elements will be set to FdoSchemaElementState_Unchanged.
+ /// The element states for all elements will be set to SchemaElementState_Unchanged.
/// Each provider-specific implementation of Execute() can ensure
/// that this is the case by
- /// calling FdoFeatureSchema::AcceptChanges() for each feature schema
+ /// calling FeatureSchema::AcceptChanges() for each feature schema
/// in the returned collection.
///
NAMESPACE_OSGEO_FDO_SCHEMA::FeatureSchemaCollection* Execute();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchemaMapping.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchemaMapping.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchemaMapping.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,11 +24,11 @@
public __gc class PhysicalSchemaMappingCollection;
/// \brief
-/// The FdoIDescribeSchemaMapping interface defines the DescribeSchemaMapping command, which
+/// The IDescribeSchemaMapping interface defines the DescribeSchemaMapping command, which
/// describes the logical to physical schema mappings for feature schemas
/// available from the connection. The DescribeSchemaMapping
/// command can describe the mappings for a single schema or all schemas available from
-/// the connection. The Execute operation returns an FdoPhysicalSchemaMappingCollection
+/// the connection. The Execute operation returns an PhysicalSchemaMappingCollection
/// object.
public __gc __interface IDescribeSchemaMapping : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
{
@@ -80,7 +80,7 @@
/// \brief
/// Executes the DescribeSchemaMapping command and returns a
- /// FdoPhysicalSchemaMappingCollection. If the specified schema name does not exist,
+ /// PhysicalSchemaMappingCollection. If the specified schema name does not exist,
/// the Execute method throws an exception.
///
/// \return
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchemaMappingImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchemaMappingImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDescribeSchemaMappingImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,13 +27,15 @@
public __gc class PhysicalSchemaMappingCollection;
/// \brief
-/// The FdoIDescribeSchemaMapping interface defines the DescribeSchemaMapping command, which
+/// The IDescribeSchemaMappingImp class is a concrete implementation of IDescribeSchemaMapping.
+/// The IDescribeSchemaMapping interface defines the DescribeSchemaMapping command, which
/// describes the logical to physical schema mappings for feature schemas
/// available from the connection. The DescribeSchemaMapping
/// command can describe the mappings for a single schema or all schemas available from
-/// the connection. The Execute operation returns an FdoPhysicalSchemaMappingCollection
+/// the connection. The Execute operation returns an PhysicalSchemaMappingCollection
/// object.
-private __gc class IDescribeSchemaMappingImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IDescribeSchemaMapping
+private __gc class IDescribeSchemaMappingImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IDescribeSchemaMapping
{
public:
/// \brief
@@ -83,7 +85,7 @@
/// \brief
/// Executes the DescribeSchemaMapping command and returns a
- /// FdoPhysicalSchemaMappingCollection. If the specified schema name does not exist,
+ /// PhysicalSchemaMappingCollection. If the specified schema name does not exist,
/// the Execute method throws an exception.
///
/// \return
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDestroySchema.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDestroySchema.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDestroySchema.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -23,7 +23,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
/// \brief
-/// The FdoIDestroySchema interface defines the DestroySchema command, which
+/// The IDestroySchema interface defines the DestroySchema command, which
/// destroys a schema definition, including all class definitions, relationship
/// definitions, and instance data within it. If elements in other schemas refer
/// to the schema to be destroyed command, execution will fail. Input to the
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDestroySchemaImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDestroySchemaImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIDestroySchemaImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,12 +26,14 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
/// \brief
-/// The FdoIDestroySchema interface defines the DestroySchema command, which
+/// The IDestroySchemaImp class is a concrete implementation of IDestroySchema.
+/// The IDestroySchema interface defines the DestroySchema command, which
/// destroys a schema definition, including all class definitions, relationship
/// definitions, and instance data within it. If elements in other schemas refer
/// to the schema to be destroyed command, execution will fail. Input to the
/// delete schema command is the name of the schema to be destroyed.
-private __gc class IDestroySchemaImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IDestroySchema
+private __gc class IDestroySchemaImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IDestroySchema
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIPhysicalElementMapping.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIPhysicalElementMapping.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIPhysicalElementMapping.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -37,36 +37,36 @@
public __gc class PhysicalSchemaMapping;
/// \brief
-/// FdoPhysicalElementMapping is an abstract class that acts as a base class for all
+/// PhysicalElementMapping is an abstract class that acts as a base class for all
/// Physical Schema Mapping Override classes. FDO also provides a number of sub-classes
/// for particular types of Provider-specific override classes:
///
-/// \li \c FdoPhysicalClassMapping: All classes corresponding to Feature Classes
-/// must be based on FdoPhysicalClassMapping.
-/// \li \c FdoPhysicalPropertyMapping: Must be the base for all classes corresponding to
+/// \li \c PhysicalClassMapping: All classes corresponding to Feature Classes
+/// must be based on PhysicalClassMapping.
+/// \li \c PhysicalPropertyMapping: Must be the base for all classes corresponding to
/// Properties.
-/// \li \c FdoPhysicalSchemaMapping: Must be the base for all types of schema override sets.
+/// \li \c PhysicalSchemaMapping: Must be the base for all types of schema override sets.
/// \li \c Other types of schema override classes can be based directly on
-/// FdoPhysicalElementMapping.
+/// PhysicalElementMapping.
///
public __gc __interface IPhysicalElementMapping : public NAMESPACE_OSGEO_COMMON_XML::IXmlSaxHandler
{
public:
/// \brief
- /// Gets the parent of this FdoPhysicalElementMapping or null if this object has not
+ /// Gets the parent of this PhysicalElementMapping or null if this object has not
/// been added to a parent object.
///
/// \return
- /// Returns FdoPhysicalElementMapping of parent
+ /// Returns PhysicalElementMapping of parent
///
__property NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IPhysicalElementMapping* get_Parent();
/// \brief
- /// Gets the FdoPhysicalSchemaMapping that this element is a part of. Returns null if this
+ /// Gets the PhysicalSchemaMapping that this element is a part of. Returns null if this
/// object has not been added to a feature schema.
///
/// \return
- /// Returns FdoPhysicalSchemaMapping this object is a part of
+ /// Returns PhysicalSchemaMapping this object is a part of
///
__property NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* get_SchemaMapping();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIPhysicalPropertyMapping.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIPhysicalPropertyMapping.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgIPhysicalPropertyMapping.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -33,7 +33,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
/// \brief
-/// FdoPhysicalPropertyMapping is an abstract class that acts as a base class for all
+/// PhysicalPropertyMapping is an abstract class that acts as a base class for all
/// Physical Schema Mapping property overrides.
public __gc __interface IPhysicalPropertyMapping : public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IPhysicalElementMapping
{
@@ -60,7 +60,7 @@
/// property names to be valid XML element names. Can be extended to handle
/// particular XML attributes and sub-elements for derived classes.
/// <p><b>Note:</b> Schema Override elements that do not require name encoding
- /// should be based on FdoPhysicalElementMapping instead of this class.
+ /// should be based on PhysicalElementMapping instead of this class.
///
/// \param xmlWriter
/// Input write the element to this XML writer
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalClassMapping.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalClassMapping.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalClassMapping.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -36,7 +36,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
/// \brief
-/// FdoPhysicalClassMapping is an abstract class that acts as a base class for all
+/// PhysicalClassMapping is an abstract class that acts as a base class for all
/// Physical Schema Mapping class overrides.
public __gc class PhysicalClassMapping : public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalElementMapping
{
@@ -65,7 +65,7 @@
/// suffix to the name. Can be extended to handle
/// particular XML attributes for derived classes.
/// <p><b>Note:</b> Schema Override elements that do not require name encoding
- /// should be based on FdoPhysicalElementMapping instead of this class.
+ /// should be based on PhysicalElementMapping instead of this class.
///
/// \param xmlWriter
/// Input write the class to this XML writer
@@ -78,8 +78,10 @@
/// Write this element to XML.
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
+/// \cond DOXYGEN-IGNORE
public protected:
PhysicalClassMapping(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \endcond
public private:
inline FdoPhysicalClassMapping* GetImpObj();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalElementMapping.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalElementMapping.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalElementMapping.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -41,36 +41,36 @@
public __gc class PhysicalSchemaMapping;
/// \brief
-/// FdoPhysicalElementMapping is an abstract class that acts as a base class for all
+/// PhysicalElementMapping is an abstract class that acts as a base class for all
/// Physical Schema Mapping Override classes. FDO also provides a number of sub-classes
/// for particular types of Provider-specific override classes:
///
-/// \li \c FdoPhysicalClassMapping: All classes corresponding to Feature Classes
-/// must be based on FdoPhysicalClassMapping.
-/// \li \c FdoPhysicalPropertyMapping: Must be the base for all classes corresponding to
+/// \li \c PhysicalClassMapping: All classes corresponding to Feature Classes
+/// must be based on PhysicalClassMapping.
+/// \li \c PhysicalPropertyMapping: Must be the base for all classes corresponding to
/// Properties.
-/// \li \c FdoPhysicalSchemaMapping: Must be the base for all types of schema override sets.
+/// \li \c PhysicalSchemaMapping: Must be the base for all types of schema override sets.
/// \li \c Other types of schema override classes can be based directly on
-/// FdoPhysicalElementMapping.
+/// PhysicalElementMapping.
///
public __gc class PhysicalElementMapping : public NAMESPACE_OSGEO_COMMON_XML::XmlSaxHandler, public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IPhysicalElementMapping
{
public:
/// \brief
- /// Gets the parent of this FdoPhysicalElementMapping or null if this object has not
+ /// Gets the parent of this PhysicalElementMapping or null if this object has not
/// been added to a parent object.
///
/// \return
- /// Returns FdoPhysicalElementMapping of parent
+ /// Returns PhysicalElementMapping of parent
///
__property NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IPhysicalElementMapping* get_Parent();
/// \brief
- /// Gets the FdoPhysicalSchemaMapping that this element is a part of. Returns null if this
+ /// Gets the PhysicalSchemaMapping that this element is a part of. Returns null if this
/// object has not been added to a feature schema.
///
/// \return
- /// Returns FdoPhysicalSchemaMapping this object is a part of
+ /// Returns PhysicalSchemaMapping this object is a part of
///
__property NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* get_SchemaMapping();
@@ -147,8 +147,10 @@
NAMESPACE_OSGEO_COMMON_XML::IXmlSaxHandler* DuplicateSubElementError(NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* context, System::String* parentElement, System::String* subElement, System::String* subElementName);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public protected:
PhysicalElementMapping(System::IntPtr unmanaged, System::Boolean autoDelete);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalPropertyMapping.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalPropertyMapping.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalPropertyMapping.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -36,7 +36,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
/// \brief
-/// FdoPhysicalPropertyMapping is an abstract class that acts as a base class for all
+/// PhysicalPropertyMapping is an abstract class that acts as a base class for all
/// Physical Schema Mapping property overrides.
public __gc class PhysicalPropertyMapping : public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalElementMapping, public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::IPhysicalPropertyMapping
{
@@ -63,7 +63,7 @@
/// property names to be valid XML element names. Can be extended to handle
/// particular XML attributes and sub-elements for derived classes.
/// <p><b>Note:</b> Schema Override elements that do not require name encoding
- /// should be based on FdoPhysicalElementMapping instead of this class.
+ /// should be based on PhysicalElementMapping instead of this class.
///
/// \param xmlWriter
/// Input write the element to this XML writer
@@ -75,8 +75,10 @@
///
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
+/// \cond DOXYGEN-IGNORE
public protected:
PhysicalPropertyMapping(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \endcond
public private:
inline FdoPhysicalPropertyMapping* GetImpObj();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalSchemaMapping.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalSchemaMapping.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalSchemaMapping.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,16 +24,34 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
+/// \brief
+/// PhysicalSchemaMapping is an abstract class that is the base class of
+/// all Schema Override sets. Each instance contains the overrides for a
+/// particular Feature Schema and FDO Provider.
+/// Each FDO Provider, that allows Schema Overrides, must create a sub-class of this
+/// class. This sub-class must implement the overrides that are specific to the
+/// provider. The Provider can also add support, for serializing to an XML document,
+/// by overriding the functions inherited from XmlSerializable.
public __gc class PhysicalSchemaMapping : public NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalElementMapping
{
public:
+ /// \brief
+ /// Gets the name of the applicable FDO provider.
+ ///
+ /// \return
+ /// Returns the name of FDO provider to which this Schema Override set
+ /// applies. The provider name must conform to the format:
+ /// "[Company].[Provider].[Version]".
+ ///
__property System::String* get_Provider();
public protected:
PhysicalSchemaMapping(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
PhysicalSchemaMapping(NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* schemaMapping, System::Boolean autoDelete);
+/// \endcond
public private:
inline FdoPhysicalSchemaMapping* GetImpObj();
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalSchemaMappingCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalSchemaMappingCollection.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/Schema/mgPhysicalSchemaMappingCollection.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -47,9 +47,28 @@
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class PhysicalSchemaMappingCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList, public NAMESPACE_OSGEO_FDO_XML::IXmlDeserializable, public NAMESPACE_OSGEO_FDO_XML::IXmlSerializable
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// A Nested class defined to provide enumeration of Dictionary elements
+ ///
+ /// Enumerators can be used to read the data in the collection,
+ /// but they cannot be used to modify the underlying collection.
+ ///
+ /// An enumerator remains valid as long as the collection remains unchanged.
+ /// If changes are made to the collection, such as adding, modifying, or deleting
+ /// elements, the enumerator is irrecoverably invalidated and the next call to
+ /// MoveNext or Reset throws an InvalidOperationException. If the collection is
+ /// modified between MoveNext and Current, Current returns the element that it is
+ /// set to, even if the enumerator is already invalidated.
+ ///
+ /// The enumerator does not have exclusive access to the collection; therefore,
+ /// enumerating through a collection is intrinsically not a thread-safe procedure.
+ /// Even when a collection is synchronized, other threads can still modify the
+ /// collection, which causes the enumerator to throw an exception. To guarantee
+ /// thread safety during enumeration, you can either lock the collection during
+ /// the entire enumeration or catch the exceptions resulting from changes made
+ /// by other threads.
///
__gc class Enumerator : public System::Collections::IEnumerator
{
@@ -58,15 +77,47 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(PhysicalSchemaMappingCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
- __property System::Object* get_Current();
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
+ __property System::Object *get_Current();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first object in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
System::Boolean MoveNext();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
System::Void Reset();
};
@@ -79,54 +130,55 @@
inline FdoPhysicalSchemaMappingCollection* GetImpObj();
private:
- // System::Collections::ICollection interfaces
- System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+ // System::Collections::ICollection interface properties
+ __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
- __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ // System::Collections::ICollection interface methods
+ System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
- __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+ // System::Collections::IList interface properties
+ __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ __property System::Boolean System::Collections::IList::get_IsReadOnly();
+ __property Object* System::Collections::IList::get_Item(System::Int32 index);
+ __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
- // System::Collections::IList interfaces
- __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ // System::Collections::IList interface methods
+ System::Int32 System::Collections::IList::Add(Object* value);
+ System::Boolean System::Collections::IList::Contains(Object* value);
+ System::Int32 System::Collections::IList::IndexOf(Object* value);
+ System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
+ System::Void System::Collections::IList::Remove(Object* value);
+/// \endcond
- __property System::Boolean System::Collections::IList::get_IsReadOnly();
-
- System::Int32 System::Collections::IList::Add(Object* value);
-
- System::Boolean System::Collections::IList::Contains(Object* value);
-
- System::Int32 System::Collections::IList::IndexOf(Object* value);
-
- System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
-
- System::Void System::Collections::IList::Remove(Object* value);
-
- __property Object* System::Collections::IList::get_Item(System::Int32 index);
-
- __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
-
public:
/// \brief
- /// Constructs a new empty string collection
+ /// Constructs a new empty string collection
///
/// \return
- /// Returns FdoStringCollection
+ /// Returns StringCollection
///
///
PhysicalSchemaMappingCollection();
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
+ /// \return
+ /// Returns the number of items in the collection.
+ ///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
+ /// \return
+ /// Returns an enumerator on the dictionary.
+ ///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping from this collection.
+ /// Removes the index-th PhysicalSchemaMapping from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -134,63 +186,63 @@
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
/// \brief
- /// Adds a NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping object into the collection.
+ /// Adds a PhysicalSchemaMapping object into the collection.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping object to add.
+ /// Input the PhysicalSchemaMapping object to add.
///
/// \return
- /// Returns the position into which the new element was inserted.
+ /// Returns the position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* value);
/// \brief
- /// Determines the index of a specific NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping object.
+ /// Determines the index of a specific PhysicalSchemaMapping object.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping object to locate in the collection.
+ /// Input the PhysicalSchemaMapping object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* value);
/// \brief
- /// Inserts a NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping object into the collection at the specified position.
+ /// Inserts a PhysicalSchemaMapping object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping object to insert.
+ /// Input the PhysicalSchemaMapping object to insert.
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* value);
/// \brief
- /// Removes the first occurrence of a specific NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping object.
+ /// Removes the first occurrence of a specific PhysicalSchemaMapping object.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping object to remove from the collection.
+ /// Input the PhysicalSchemaMapping object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* value);
/// \brief
- /// Determines whether the collection contains a specific NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping object.
+ /// Determines whether the collection contains a specific PhysicalSchemaMapping object.
///
/// \param value
- /// Input The NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping object to search in the collection.
+ /// Input The PhysicalSchemaMapping object to search in the collection.
///
/// \return
- /// Returns true if the value is found in the collection; otherwise, false.
+ /// Returns true if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -201,17 +253,48 @@
/// \brief
- /// Gets or sets a NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping to retrieve or set (System::Int32).
+ /// The index of the item in the collection. The index is 0 based.
///
+ /// \return
+ /// Returns an instance of a the collected item.
+ /// Throws an instance of Exception if the index is out of range or an error occurs.
+ ///
__property NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* get_RealTypeItem(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* value);
+ /// \brief
+ /// Gets an item in the collection.
+ ///
+ /// \param index
+ /// Input index of the item to retrieve.
+ ///
+ /// \return
+ /// Returns the item at the specified index
+ ///
__property NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* get_Item(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping* value);
/*
@@ -254,13 +337,13 @@
/// provider name.
///
/// \param connection
- /// Input the FDO connection.
+ /// Input connection.
/// \param schemaName
/// Input Feature Schema name.
///
/// \return
/// Returns the Schema Override set for the given Feature Schema and
- /// the FDO Provider for the given connection. NULL is return if the set was not
+ /// Provider for the given connection. NULL is return if the set was not
/// found.
///
NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMapping * GetItem(NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnection* connection, System::String* schemaName);
@@ -519,8 +602,10 @@
///
NAMESPACE_OSGEO_COMMON_XML::XmlReader* GetFromInternalStylesheet();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIActivateSpatialContext.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIActivateSpatialContext.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIActivateSpatialContext.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -23,7 +23,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
/// \brief
-/// The FdoIActivateSpatialContext interface defines the ActivateSpatialContext
+/// The IActivateSpatialContext interface defines the ActivateSpatialContext
/// command, which activates a specified spatial context. Input to the command
/// is the name of the context to activate.
public __gc __interface IActivateSpatialContext : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIActivateSpatialContextImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIActivateSpatialContextImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIActivateSpatialContextImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,10 +26,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
/// \brief
-/// The FdoIActivateSpatialContext interface defines the ActivateSpatialContext
+/// The IActivateSpatialContextImp class is a concrete implementation of IActivateSpatialContext.
+/// The IActivateSpatialContext interface defines the ActivateSpatialContext
/// command, which activates a specified spatial context. Input to the command
/// is the name of the context to activate.
-private __gc class IActivateSpatialContextImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::IActivateSpatialContext
+private __gc class IActivateSpatialContextImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::IActivateSpatialContext
{
public:
/// \brief
@@ -70,5 +72,3 @@
};
END_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
-
-
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgICreateSpatialContext.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgICreateSpatialContext.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgICreateSpatialContext.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,7 +24,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
/// \brief
-/// The FdoICreateSpatialContext interface defines the CreateSpatialContext
+/// The ICreateSpatialContext interface defines the CreateSpatialContext
/// command, which creates a new spatial context. Input to the command includes
/// the name, description, coordinate system, extent type, and extent for the
/// new context. Command execution will fail if the context already exists, or
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgICreateSpatialContextImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgICreateSpatialContextImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgICreateSpatialContextImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,7 +27,8 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
/// \brief
-/// The FdoICreateSpatialContext interface defines the CreateSpatialContext
+/// The ICreateSpatialContextImp class is a concrete implementation of ICreateSpatialContext.
+/// The ICreateSpatialContext interface defines the CreateSpatialContext
/// command, which creates a new spatial context. Input to the command includes
/// the name, description, coordinate system, extent type, and extent for the
/// new context. Command execution will fail if the context already exists, or
@@ -38,7 +39,8 @@
/// non-rectangular area is passed in and the provider supports only a
/// rectangular extent, the provider will compute the minimum box that
/// encloses the given geometry and use that for the extent value.
-private __gc class ICreateSpatialContextImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::ICreateSpatialContext
+private __gc class ICreateSpatialContextImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::ICreateSpatialContext
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIDestroySpatialContext.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIDestroySpatialContext.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIDestroySpatialContext.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -23,7 +23,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
/// \brief
-/// The FdoIDestroySpatialContext interface defines the DestroySpatialContext
+/// The IDestroySpatialContext interface defines the DestroySpatialContext
/// command, which destroys an existing spatial context. Input to the command is
/// the name of the context to destroy. Destroying a spatial context destroys
/// all data stored in that context.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIDestroySpatialContextImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIDestroySpatialContextImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIDestroySpatialContextImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,11 +26,13 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
/// \brief
-/// The FdoIDestroySpatialContext interface defines the DestroySpatialContext
+/// The IDestroySpatialContextImp class is a concrete implementation of IDestroySpatialContext.
+/// The IDestroySpatialContext interface defines the DestroySpatialContext
/// command, which destroys an existing spatial context. Input to the command is
/// the name of the context to destroy. Destroying a spatial context destroys
/// all data stored in that context.
-private __gc class IDestroySpatialContextImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::IDestroySpatialContext
+private __gc class IDestroySpatialContextImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::IDestroySpatialContext
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIGetSpatialContexts.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIGetSpatialContexts.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIGetSpatialContexts.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,7 +24,7 @@
public __gc __interface ISpatialContextReader;
/// \brief
-/// The FdoIGetSpatialContexts interface defines the GetSpatialContexts command,
+/// IGetSpatialContexts interface defines the GetSpatialContexts command,
/// which enumerates the existing spatial contexts.
public __gc __interface IGetSpatialContexts : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
{
@@ -53,7 +53,7 @@
__property System::Void set_ActiveOnly(System::Boolean value);
/// \brief
- /// Executes the GetSpatialContexts command returning an FdoISpatialContextReader.
+ /// Executes the GetSpatialContexts command returning an ISpatialContextReader.
///
/// \return
/// Returns nothing
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIGetSpatialContextsImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIGetSpatialContextsImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgIGetSpatialContextsImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,9 +27,11 @@
public __gc __interface ISpatialContextReader;
/// \brief
-/// The FdoIGetSpatialContexts interface defines the GetSpatialContexts command,
+/// The IGetSpatialContextsImp class is a concrete implementation of IGetSpatialContexts.
+/// The IGetSpatialContexts interface defines the GetSpatialContexts command,
/// which enumerates the existing spatial contexts.
-private __gc class IGetSpatialContextsImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::IGetSpatialContexts
+private __gc class IGetSpatialContextsImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::IGetSpatialContexts
{
public:
/// \brief
@@ -56,7 +58,7 @@
__property System::Void set_ActiveOnly(System::Boolean value);
/// \brief
- /// Executes the GetSpatialContexts command returning an FdoISpatialContextReader.
+ /// Executes the GetSpatialContexts command returning an ISpatialContextReader.
///
/// \return
/// Returns nothing
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgISpatialContextReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgISpatialContextReader.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgISpatialContextReader.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -23,10 +23,10 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
/// \brief
-/// The FdoISpatialContextReader interface provides forward-only, read-only
+/// ISpatialContextReader interface provides forward-only, read-only
/// functionality for enumerating spatial contexts. A reference to an
-/// FdoISpatialContextReader is returned from the GetSpatialContexts command.
-/// The initial position of the FdoISpatialContextReader interface is prior to the
+/// ISpatialContextReader is returned from the GetSpatialContexts command.
+/// The initial position of the ISpatialContextReader interface is prior to the
/// first item. Thus, you must call ReadNext to begin accessing any data.
public __gc __interface ISpatialContextReader : public System::IDisposable
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgISpatialContextReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgISpatialContextReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgISpatialContextReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,12 +27,14 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
/// \brief
-/// The FdoISpatialContextReader interface provides forward-only, read-only
+/// The ISpatialContextReaderImp class is a concrete implementation of ISpatialContextReader.
+/// The ISpatialContextReader interface provides forward-only, read-only
/// functionality for enumerating spatial contexts. A reference to an
-/// FdoISpatialContextReader is returned from the GetSpatialContexts command.
-/// The initial position of the FdoISpatialContextReader interface is prior to the
+/// ISpatialContextReader is returned from the GetSpatialContexts command.
+/// The initial position of the ISpatialContextReader interface is prior to the
/// first item. Thus, you must call ReadNext to begin accessing any data.
-private __gc class ISpatialContextReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::ISpatialContextReader
+private __gc class ISpatialContextReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::ISpatialContextReader
{
public:
/// \brief
@@ -136,8 +138,10 @@
///
System::Boolean ReadNext();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ISpatialContextReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgSpatialContextExtentType.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgSpatialContextExtentType.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/SpatialContext/mgSpatialContextExtentType.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -21,13 +21,13 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
/// \brief
-/// The FdoSpatialContextExtentType enumeration defines how the extent of
+/// The SpatialContextExtentType enumeration defines how the extent of
/// a context should be handled by the provider.
-/// <param name="FdoSpatialContextExtentType_Static">
+/// <param name="SpatialContextExtentType_Static">
/// The spatial extent of the context is static and must be specified
/// when the context is created.
/// </param>
-/// <param name="FdoSpatialContextExtentType_Dynamic">
+/// <param name="SpatialContextExtentType_Dynamic">
/// The spatial extent of the context is dynamic and changes as data is
/// added and removed from the context.
/// </param>
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgBaseUnit.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgBaseUnit.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgBaseUnit.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -23,15 +23,15 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE
/// \brief
-/// The FdoBaseUnit enumeration defines the well known base unit used to
+/// The BaseUnit enumeration defines the well known base unit used to
/// establish a measure unit.
-/// <param name="FdoBaseUnit_None">
+/// <param name="BaseUnit_None">
/// Input no base unit
/// </param>
-/// <param name="FdoBaseUnit_Meters">
+/// <param name="BaseUnit_Meters">
/// Input base unit meters
/// </param>
-/// <param name="FdoBaseUnit_Radians">
+/// <param name="BaseUnit_Radians">
/// Input base unit radians
/// </param>
public __value enum BaseUnit
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgICreateMeasureUnit.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgICreateMeasureUnit.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgICreateMeasureUnit.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -25,7 +25,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE
/// \brief
-/// The FdoICreateMeasureUnit interface defines the CreateMeasureUnit command,
+/// The ICreateMeasureUnit interface defines the CreateMeasureUnit command,
/// which creates or updates a measurement unit. Input to the command includes
/// the abbreviation, name, description, measure type, base unit, and scale
/// factor that defines the measure unit. The update existing flag indicates how
@@ -99,7 +99,7 @@
/// \brief
/// Gets the base units that define the measure unit to create or update
- /// as an FdoBaseUnit value.
+ /// as an BaseUnit value.
///
/// \return
/// Returns the base units
@@ -108,7 +108,7 @@
/// \brief
/// Sets the base units that define the measure unit to create or update
- /// as an FdoBaseUnit value.
+ /// as an BaseUnit value.
///
/// \param value
/// Input the base units
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgICreateMeasureUnitImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgICreateMeasureUnitImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgICreateMeasureUnitImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -28,7 +28,8 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE
/// \brief
-/// The FdoICreateMeasureUnit interface defines the CreateMeasureUnit command,
+/// The ICreateMeasureUnitImp class is a concrete implementation of ICreateMeasureUnit.
+/// The ICreateMeasureUnit interface defines the CreateMeasureUnit command,
/// which creates or updates a measurement unit. Input to the command includes
/// the abbreviation, name, description, measure type, base unit, and scale
/// factor that defines the measure unit. The update existing flag indicates how
@@ -36,7 +37,8 @@
/// false, and the specified measure unit already exists, command execution will
/// fail. If it is true, the command will either create a new measure unit or update an
/// existing one.
-private __gc class ICreateMeasureUnitImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE::ICreateMeasureUnit
+private __gc class ICreateMeasureUnitImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE::ICreateMeasureUnit
{
public:
/// \brief
@@ -102,7 +104,7 @@
/// \brief
/// Gets the base units that define the measure unit to create or update
- /// as an FdoBaseUnit value.
+ /// as an BaseUnit value.
///
/// \return
/// Returns the base units
@@ -111,7 +113,7 @@
/// \brief
/// Sets the base units that define the measure unit to create or update
- /// as an FdoBaseUnit value.
+ /// as an BaseUnit value.
///
/// \param value
/// Input the base units
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIDestroyMeasureUnit.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIDestroyMeasureUnit.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIDestroyMeasureUnit.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -23,7 +23,7 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE
/// \brief
-/// The FdoIDestroyMeasureUnit interface defines the DestroyMeasureUnit command,
+/// The IDestroyMeasureUnit interface defines the DestroyMeasureUnit command,
/// which deletes a measurement unit. Input to the command is simply the
/// abbreviation of the measure unit to be destroyed.
public __gc __interface IDestroyMeasureUnit : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIDestroyMeasureUnitImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIDestroyMeasureUnitImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIDestroyMeasureUnitImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,10 +26,12 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE
/// \brief
-/// The FdoIDestroyMeasureUnit interface defines the DestroyMeasureUnit command,
+/// The IDestroyMeasureUnitImp class is a concrete implementation of IDestroyMeasureUnit.
+/// The IDestroyMeasureUnit interface defines the DestroyMeasureUnit command,
/// which deletes a measurement unit. Input to the command is simply the
/// abbreviation of the measure unit to be destroyed.
-private __gc class IDestroyMeasureUnitImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE::IDestroyMeasureUnit
+private __gc class IDestroyMeasureUnitImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE::IDestroyMeasureUnit
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIGetMeasureUnits.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIGetMeasureUnits.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIGetMeasureUnits.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,13 +24,13 @@
public __gc __interface IMeasureUnitReader;
/// \brief
-/// The FdoIGetMeasureUnits interface defines the GetMeasureUnits command, which
+/// The IGetMeasureUnits interface defines the GetMeasureUnits command, which
/// enumerates the existing measurement units.
public __gc __interface IGetMeasureUnits : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
{
public:
/// \brief
- /// Executes the GetMeasureUnits command and returns an FdoIMeasureUnitReader.
+ /// Executes the GetMeasureUnits command and returns an IMeasureUnitReader.
///
/// \return
/// Returns the measure unit reader
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIGetMeasureUnitsImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIGetMeasureUnitsImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIGetMeasureUnitsImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,13 +27,15 @@
public __gc __interface IMeasureUnitReader;
/// \brief
-/// The FdoIGetMeasureUnits interface defines the GetMeasureUnits command, which
+/// The IGetMeasureUnitsImp class is a concrete implementation of IGetMeasureUnits.
+/// The IGetMeasureUnits interface defines the GetMeasureUnits command, which
/// enumerates the existing measurement units.
-private __gc class IGetMeasureUnitsImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE::IGetMeasureUnits
+private __gc class IGetMeasureUnitsImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE::IGetMeasureUnits
{
public:
/// \brief
- /// Executes the GetMeasureUnits command and returns an FdoIMeasureUnitReader.
+ /// Executes the GetMeasureUnits command and returns an IMeasureUnitReader.
///
/// \return
/// Returns the measure unit reader
@@ -41,6 +43,16 @@
NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE::IMeasureUnitReader* Execute();
public:
+ /// \brief
+ /// Constructs an IGetMeasureUnitsImp object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IGetMeasureUnitsImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp(unmanaged, autoDelete)
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIMeasureUnitReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIMeasureUnitReader.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIMeasureUnitReader.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -23,10 +23,10 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE
/// \brief
-/// The FdoIMeasureUnitReader interface provides forward-only, read-only
+/// The IMeasureUnitReader interface provides forward-only, read-only
/// functionality for enumerating measurement units. A reference to an
-/// FdoIMeasureUnitReader interface is returned from the GetMeasureUnits command.
-/// The initial position of the FdoIMeasureUnitReader is prior to the
+/// IMeasureUnitReader interface is returned from the GetMeasureUnits command.
+/// The initial position of the IMeasureUnitReader is prior to the
/// first item. Thus, you must call ReadNext to begin accessing any data.
public __gc __interface IMeasureUnitReader : public System::IDisposable
{
@@ -82,7 +82,7 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the FdoIMeasureUnitReader object, freeing any resources it may be holding.
+ /// Closes the IMeasureUnitReader object, freeing any resources it may be holding.
///
/// \return
/// Returns nothing
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIMeasureUnitReaderImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIMeasureUnitReaderImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/UnitOfMeasure/mgIMeasureUnitReaderImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -26,12 +26,14 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE
/// \brief
-/// The FdoIMeasureUnitReader interface provides forward-only, read-only
+/// The IMeasureUnitReaderImp class is a concrete implementation of IMeasureUnitReader.
+/// The IMeasureUnitReader interface provides forward-only, read-only
/// functionality for enumerating measurement units. A reference to an
-/// FdoIMeasureUnitReader interface is returned from the GetMeasureUnits command.
-/// The initial position of the FdoIMeasureUnitReader is prior to the
+/// IMeasureUnitReader interface is returned from the GetMeasureUnits command.
+/// The initial position of the IMeasureUnitReader is prior to the
/// first item. Thus, you must call ReadNext to begin accessing any data.
-private __gc class IMeasureUnitReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE::IMeasureUnitReader
+private __gc class IMeasureUnitReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE::IMeasureUnitReader
{
public:
/// \brief
@@ -85,15 +87,17 @@
System::Boolean ReadNext();
/// \brief
- /// Closes the FdoIMeasureUnitReader object, freeing any resources it may be holding.
+ /// Closes the IMeasureUnitReader object, freeing any resources it may be holding.
///
/// \return
/// Returns nothing
///
System::Void Close();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
IMeasureUnitReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgBatchParameterValueCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgBatchParameterValueCollection.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgBatchParameterValueCollection.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -29,9 +29,28 @@
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class BatchParameterValueCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// A Nested class defined to provide enumeration of Dictionary elements
+ ///
+ /// Enumerators can be used to read the data in the collection,
+ /// but they cannot be used to modify the underlying collection.
+ ///
+ /// An enumerator remains valid as long as the collection remains unchanged.
+ /// If changes are made to the collection, such as adding, modifying, or deleting
+ /// elements, the enumerator is irrecoverably invalidated and the next call to
+ /// MoveNext or Reset throws an InvalidOperationException. If the collection is
+ /// modified between MoveNext and Current, Current returns the element that it is
+ /// set to, even if the enumerator is already invalidated.
+ ///
+ /// The enumerator does not have exclusive access to the collection; therefore,
+ /// enumerating through a collection is intrinsically not a thread-safe procedure.
+ /// Even when a collection is synchronized, other threads can still modify the
+ /// collection, which causes the enumerator to throw an exception. To guarantee
+ /// thread safety during enumeration, you can either lock the collection during
+ /// the entire enumeration or catch the exceptions resulting from changes made
+ /// by other threads.
///
__gc class Enumerator : public System::Collections::IEnumerator
{
@@ -40,16 +59,48 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(BatchParameterValueCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
- __property System::Object* get_Current();
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
+ __property System::Object *get_Current();
- System::Boolean MoveNext();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
+ System::Boolean MoveNext();
- System::Void Reset();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
+ System::Void Reset();
};
public private:
@@ -61,54 +112,56 @@
inline FdoBatchParameterValueCollection* GetImpObj();
private:
- // System::Collections::ICollection interfaces
- System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
-
+ // System::Collections::ICollection interface properties
__property System::Object* System::Collections::ICollection::get_SyncRoot();
-
__property System::Boolean System::Collections::ICollection::get_IsSynchronized();
- // System::Collections::IList interfaces
+ // System::Collections::ICollection interface methods
+ System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+
+ // System::Collections::IList interface properties
__property System::Boolean System::Collections::IList::get_IsFixedSize();
-
__property System::Boolean System::Collections::IList::get_IsReadOnly();
+ __property Object* System::Collections::IList::get_Item(System::Int32 index);
+ __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
- System::Int32 System::Collections::IList::Add(Object* value);
-
+ // System::Collections::IList interface methods
+ System::Int32 System::Collections::IList::Add(Object* value);
System::Boolean System::Collections::IList::Contains(Object* value);
-
System::Int32 System::Collections::IList::IndexOf(Object* value);
-
System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
-
System::Void System::Collections::IList::Remove(Object* value);
- __property Object* System::Collections::IList::get_Item(System::Int32 index);
+/// \endcond
- __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
-
public:
/// \brief
- /// Constructs a new empty string collection
+ /// Constructs a new empty string collection
///
/// \return
- /// Returns StringCollection
+ /// Returns StringCollection
///
///
BatchParameterValueCollection();
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
+ /// \return
+ /// Returns the number of items in the collection.
+ ///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
+ /// \return
+ /// Returns a collection enumerator.
+ ///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection from this collection.
+ /// Removes the index-th ParameterValueCollection from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -116,63 +169,63 @@
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
/// \brief
- /// Adds a NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection object into the collection.
+ /// Adds a ParameterValueCollection object into the collection.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection object to add.
+ /// Input the ParameterValueCollection object to add.
///
/// \return
- /// Returns the position into which the new element was inserted.
+ /// Returns the position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value);
/// \brief
- /// Determines the index of a specific NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection object.
+ /// Determines the index of a specific ParameterValueCollection object.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection object to locate in the collection.
+ /// Input the ParameterValueCollection object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value);
/// \brief
- /// Inserts a NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection object into the collection at the specified position.
+ /// Inserts a ParameterValueCollection object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection object to insert.
+ /// Input the ParameterValueCollection object to insert.
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value);
/// \brief
- /// Removes the first occurrence of a specific NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection object.
+ /// Removes the first occurrence of a specific ParameterValueCollection object.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection object to remove from the collection.
+ /// Input the ParameterValueCollection object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value);
/// \brief
- /// Determines whether the collection contains a specific NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection object.
+ /// Determines whether the collection contains a specific ParameterValueCollection object.
///
/// \param value
- /// Input The NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection object to search in the collection.
+ /// Input The ParameterValueCollection object to search in the collection.
///
/// \return
- /// Returns true if the value is found in the collection; otherwise, false.
+ /// Returns true if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -182,21 +235,54 @@
System::Void CopyTo(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* array[],System::Int32 size);
/// \brief
- /// Gets or sets a NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection to retrieve or set (System::Int32).
+ /// The index of the item in the collection. The index is 0 based.
///
+ /// \return
+ /// Returns an instance of a the collected item.
+ /// Throws an instance of Exception if the index is out of range or an error occurs.
+ ///
__property NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* get_RealTypeItem(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value);
+ /// \brief
+ /// Gets an item in the collection.
+ ///
+ /// \param index
+ /// Input index of the item to retrieve.
+ ///
+ /// \return
+ /// Returns the item at the specified index
+ ///
__property NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* get_Item(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValueCollection* value);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_COMMANDS
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgICommand.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgICommand.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgICommand.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,7 +27,7 @@
public __gc class ParameterValueCollection;
/// \brief
-/// The FdoICommand interface defines behavior common to all commands in FDO. In
+/// The ICommand interface defines behavior common to all commands in FDO. In
/// order to be executed, commands must have an association to a connection.
/// Commands can also be optionally associated with a transaction if the
/// connection supports transactions. The parameter values collection allows
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgICommandImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgICommandImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgICommandImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -31,12 +31,14 @@
public __gc class ParameterValueCollection;
/// \brief
-/// The ICommand interface defines behavior common to all commands in FDO. In
+/// The ICommandImp class is a concrete instantiation of interface ICommand.
+/// ICommandImp defines behavior common to all commands in FDO. In
/// order to be executed, commands must have an association to a connection.
/// Commands can also be optionally associated with a transaction if the
/// connection supports transactions. The parameter values collection allows
/// values to be specified for commands that support expressions and/or filters.
-public __gc class ICommandImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
+public __gc class ICommandImp : public NAMESPACE_OSGEO_RUNTIME::Disposable,
+ public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
{
public:
/// \brief
@@ -123,8 +125,10 @@
///
System::Void Cancel();
+/// \cond DOXYGEN-IGNORE
protected:
- System::Void ReleaseUnmanagedObject();
+ System::Void ReleaseUnmanagedObject();
+/// \endcond
public protected:
ICommandImp(System::IntPtr unmanaged, System::Boolean autoDelete);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgIFeatureCommandImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgIFeatureCommandImp.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgIFeatureCommandImp.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -34,15 +34,16 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS
/// \brief
-/// The IFeatureCommand interface defines the behavior common
-/// to all commands that operate on feature instances. The features to
-/// be operated on are identified by their class and a filter. If the feature
-/// provider supports inheritance in the schema capabilities, then the command
+/// The IFeatureCommandImp class is a concrete implementation of IFeatureCommand.
+/// IFeatureCommandImp defines the behavior common to all commands that operate on feature instances.
+/// The features to be operated on are identified by their class and a filter.
+/// If the feature provider supports inheritance in the schema capabilities, then the command
/// will operate on instances of that class and any derived classes.
/// In addition, feature commands can operate on related features if one or
/// more relation directives are specified. Each relation directive specifies
/// the relation to follow and how many levels of depth to follow it.
-private __gc class IFeatureCommandImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommand
+private __gc class IFeatureCommandImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp,
+ public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommand
{
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgIdentifierCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgIdentifierCollection.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgIdentifierCollection.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -27,13 +27,32 @@
BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS
/// \brief
-/// The IdentifierCollection class represents a collection of FdoIdentifier objects.
+/// The IdentifierCollection class represents a collection of FDO Identifier objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class IdentifierCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// A Nested class defined to provide enumeration of Dictionary elements
+ ///
+ /// Enumerators can be used to read the data in the collection,
+ /// but they cannot be used to modify the underlying collection.
+ ///
+ /// An enumerator remains valid as long as the collection remains unchanged.
+ /// If changes are made to the collection, such as adding, modifying, or deleting
+ /// elements, the enumerator is irrecoverably invalidated and the next call to
+ /// MoveNext or Reset throws an InvalidOperationException. If the collection is
+ /// modified between MoveNext and Current, Current returns the element that it is
+ /// set to, even if the enumerator is already invalidated.
+ ///
+ /// The enumerator does not have exclusive access to the collection; therefore,
+ /// enumerating through a collection is intrinsically not a thread-safe procedure.
+ /// Even when a collection is synchronized, other threads can still modify the
+ /// collection, which causes the enumerator to throw an exception. To guarantee
+ /// thread safety during enumeration, you can either lock the collection during
+ /// the entire enumeration or catch the exceptions resulting from changes made
+ /// by other threads.
///
__gc class Enumerator : public System::Collections::IEnumerator
{
@@ -42,16 +61,48 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(IdentifierCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
- __property System::Object* get_Current();
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
+ __property System::Object *get_Current();
- System::Boolean MoveNext();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
+ System::Boolean MoveNext();
- System::Void Reset();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
+ System::Void Reset();
};
public private:
@@ -63,54 +114,51 @@
inline FdoIdentifierCollection* GetImpObj();
private:
- /// System::Collections::ICollection interfaces
- System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+ // System::Collections::ICollection interface properties
+ __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
- __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ // System::Collections::ICollection interface methods
+ System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
- __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+ // System::Collections::IList interface properties
+ __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ __property System::Boolean System::Collections::IList::get_IsReadOnly();
+ __property Object* System::Collections::IList::get_Item(System::Int32 index);
+ __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
- // System::Collections::IList interfaces
- __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ // System::Collections::IList interface methods
+ System::Int32 System::Collections::IList::Add(Object* value);
+ System::Boolean System::Collections::IList::Contains(Object* value);
+ System::Int32 System::Collections::IList::IndexOf(Object* value);
+ System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
+ System::Void System::Collections::IList::Remove(Object* value);
+/// \endcond
- __property System::Boolean System::Collections::IList::get_IsReadOnly();
-
- System::Int32 System::Collections::IList::Add(Object* value);
-
- System::Boolean System::Collections::IList::Contains(Object* value);
-
- System::Int32 System::Collections::IList::IndexOf(Object* value);
-
- System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
-
- System::Void System::Collections::IList::Remove(Object* value);
-
- __property Object* System::Collections::IList::get_Item(System::Int32 index);
-
- __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
-
public:
/// \brief
- /// Constructs a new empty string collection
+ /// Constructs a new empty string collection
///
- /// \return
- /// Returns StringCollection
- ///
- ///
IdentifierCollection();
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
+ /// \return
+ /// Returns the number of items in the collection.
+ ///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
+ /// \return
+ /// Returns a collection enumerator.
+ ///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier from this collection.
+ /// Removes the index-th Identifier from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -118,63 +166,63 @@
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
/// \brief
- /// Adds a NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier object into the collection.
+ /// Adds a Identifier object into the collection.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier object to add.
+ /// Input the Identifier object to add.
///
/// \return
- /// Returns the position into which the new element was inserted.
+ /// Returns the position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* value);
/// \brief
- /// Determines the index of a specific NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier object.
+ /// Determines the index of a specific Identifier object.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier object to locate in the collection.
+ /// Input the Identifier object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* value);
/// \brief
- /// Inserts a NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier object into the collection at the specified position.
+ /// Inserts a Identifier object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier object to insert.
+ /// Input the Identifier object to insert.
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* value);
/// \brief
- /// Removes the first occurrence of a specific NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier object.
+ /// Removes the first occurrence of a specific Identifier object.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier object to remove from the collection.
+ /// Input the Identifier object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* value);
/// \brief
- /// Determines whether the collection contains a specific NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier object.
+ /// Determines whether the collection contains a specific Identifier object.
///
/// \param value
- /// Input The NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier object to search in the collection.
+ /// Input The Identifier object to search in the collection.
///
/// \return
- /// Returns true if the value is found in the collection; otherwise, false.
+ /// Returns true if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -185,17 +233,44 @@
/// \brief
- /// Gets or sets a NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier in the collection.
+ /// Gets or sets a Identifier in the collection.
///
/// \param index
- /// Input index of the NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier to retrieve or set (System::Int32).
+ /// Input index of the Identifier to retrieve or set (System::Int32).
///
__property NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* get_RealTypeItem(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* value);
+ /// \brief
+ /// Gets an item in the collection.
+ ///
+ /// \param index
+ /// Input index of the item to retrieve.
+ ///
+ /// \return
+ /// Returns the item at the specified index
+ ///
__property NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* get_Item(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* value);
@@ -236,8 +311,10 @@
///
NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* GetItem(System::Int32 index);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_COMMANDS
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgParameterValue.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgParameterValue.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgParameterValue.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -42,7 +42,7 @@
/// Constructs an instance of an ParameterValue using the specified arguments.
///
/// \param name
- /// Input name
+ /// Input the name of the parameter value
///
ParameterValue(System::String* name);
@@ -50,9 +50,9 @@
/// Constructs an instance of an ParameterValue using the specified arguments.
///
/// \param name
- /// Input name
+ /// Input the name of the parameter value
/// \param value
- /// Input literal value
+ /// Input the literal parameter value
///
ParameterValue(System::String* name, NAMESPACE_OSGEO_FDO_EXPRESSION::LiteralValue* value);
@@ -60,7 +60,7 @@
/// Gets the parameter name the value should bind to as a string.
///
/// \return
- /// Returns parameter name
+ /// Returns the parameter name
///
__property System::String* get_Name();
@@ -68,7 +68,7 @@
/// Sets the parameter name the value should bind to as a string.
///
/// \param value
- /// Input parameter name
+ /// Input the parameter name
///
/// \return
/// Returns nothing
@@ -87,7 +87,7 @@
/// Sets the value to bind to the parameter as an LiteralValue.
///
/// \param value
- /// Input literal value
+ /// Input the literal value
///
/// \return
/// Returns nothing
@@ -98,15 +98,17 @@
/// Sets the value to bind to the parameter as a string.
///
/// \param value
- /// Input string
+ /// Input the string value to bind to the parameter
///
/// \return
/// Returns nothing
///
__property System::Void set_Value(System::String* value);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
ParameterValue(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgParameterValueCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgParameterValueCollection.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgParameterValueCollection.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,13 +24,32 @@
public __gc class ParameterValue;
/// \brief
-/// The ParameterValueCollection class represents a collection of Identifier objects.
+/// The ParameterValueCollection class represents a collection of ParameterValue objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class ParameterValueCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// A Nested class defined to provide enumeration of Dictionary elements
+ ///
+ /// Enumerators can be used to read the data in the collection,
+ /// but they cannot be used to modify the underlying collection.
+ ///
+ /// An enumerator remains valid as long as the collection remains unchanged.
+ /// If changes are made to the collection, such as adding, modifying, or deleting
+ /// elements, the enumerator is irrecoverably invalidated and the next call to
+ /// MoveNext or Reset throws an InvalidOperationException. If the collection is
+ /// modified between MoveNext and Current, Current returns the element that it is
+ /// set to, even if the enumerator is already invalidated.
+ ///
+ /// The enumerator does not have exclusive access to the collection; therefore,
+ /// enumerating through a collection is intrinsically not a thread-safe procedure.
+ /// Even when a collection is synchronized, other threads can still modify the
+ /// collection, which causes the enumerator to throw an exception. To guarantee
+ /// thread safety during enumeration, you can either lock the collection during
+ /// the entire enumeration or catch the exceptions resulting from changes made
+ /// by other threads.
///
__gc class Enumerator : public System::Collections::IEnumerator
{
@@ -39,16 +58,48 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(ParameterValueCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
- __property System::Object* get_Current();
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
+ __property System::Object *get_Current();
- System::Boolean MoveNext();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
+ System::Boolean MoveNext();
- System::Void Reset();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
+ System::Void Reset();
};
public private:
@@ -60,54 +111,56 @@
inline FdoParameterValueCollection* GetImpObj();
private:
- /// System::Collections::ICollection interfaces
- System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+ // System::Collections::ICollection interface properties
+ __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
- __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ // System::Collections::ICollection interface methods
+ System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
- __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+ // System::Collections::IList interface properties
+ __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ __property System::Boolean System::Collections::IList::get_IsReadOnly();
+ __property Object* System::Collections::IList::get_Item(System::Int32 index);
+ __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
- // System::Collections::IList interfaces
- __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ // System::Collections::IList interface methods
+ System::Int32 System::Collections::IList::Add(Object* value);
+ System::Boolean System::Collections::IList::Contains(Object* value);
+ System::Int32 System::Collections::IList::IndexOf(Object* value);
+ System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
+ System::Void System::Collections::IList::Remove(Object* value);
- __property System::Boolean System::Collections::IList::get_IsReadOnly();
+/// \endcond
- System::Int32 System::Collections::IList::Add(Object* value);
-
- System::Boolean System::Collections::IList::Contains(Object* value);
-
- System::Int32 System::Collections::IList::IndexOf(Object* value);
-
- System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
-
- System::Void System::Collections::IList::Remove(Object* value);
-
- __property Object* System::Collections::IList::get_Item(System::Int32 index);
-
- __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
-
public:
/// \brief
- /// Constructs a new empty string collection
+ /// Constructs a new empty string collection
///
/// \return
- /// Returns StringCollection
+ /// Returns StringCollection
///
///
ParameterValueCollection();
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
+ /// \return
+ /// Returns the number of items in the collection.
+ ///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
+ /// \return
+ /// Returns a collection enumerator.
+ ///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue from this collection.
+ /// Removes the index-th ParameterValue from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -115,63 +168,63 @@
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
/// \brief
- /// Adds a NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue object into the collection.
+ /// Adds a ParameterValue object into the collection.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue object to add.
+ /// Input the ParameterValue object to add.
///
/// \return
- /// Returns the position into which the new element was inserted.
+ /// Returns the position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue* value);
/// \brief
- /// Determines the index of a specific NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue object.
+ /// Determines the index of a specific ParameterValue object.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue object to locate in the collection.
+ /// Input the ParameterValue object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue* value);
/// \brief
- /// Inserts a NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue object into the collection at the specified position.
+ /// Inserts a ParameterValue object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue object to insert.
+ /// Input the ParameterValue object to insert.
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue* value);
/// \brief
- /// Removes the first occurrence of a specific NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue object.
+ /// Removes the first occurrence of a specific ParameterValue object.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue object to remove from the collection.
+ /// Input the ParameterValue object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue* value);
/// \brief
- /// Determines whether the collection contains a specific NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue object.
+ /// Determines whether the collection contains a specific ParameterValue object.
///
/// \param value
- /// Input The NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue object to search in the collection.
+ /// Input the ParameterValue object to search in the collection.
///
/// \return
- /// Returns true if the value is found in the collection; otherwise, false.
+ /// Returns true if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -182,17 +235,48 @@
/// \brief
- /// Gets or sets a NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue to retrieve or set (System::Int32).
+ /// The index of the item in the collection. The index is 0 based.
///
+ /// \return
+ /// Returns an instance of a the collected item.
+ /// Throws an instance of Exception if the index is out of range or an error occurs.
+ ///
__property NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue* get_RealTypeItem(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue* value);
+ /// \brief
+ /// Gets an item in the collection.
+ ///
+ /// \param index
+ /// Input index of the item to retrieve.
+ ///
+ /// \return
+ /// Returns the item at the specified index
+ ///
__property NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue* get_Item(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue* value);
/// \brief
@@ -216,7 +300,7 @@
/// Input the item name
///
/// \return
- /// Returns FdoIdentifier
+ /// Returns Identifier
///
NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue* FindItem(System::String* name);
@@ -232,8 +316,10 @@
///
NAMESPACE_OSGEO_FDO_COMMANDS::ParameterValue* GetItem(System::Int32 index);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_COMMANDS
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgPropertyValue.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgPropertyValue.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgPropertyValue.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -49,7 +49,7 @@
/// \param name
/// Input property name as identifier
/// \param value
- /// Input value of property
+ /// Input the value of property as an expression
///
PropertyValue(NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* name, NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression* value);
@@ -59,7 +59,7 @@
/// \param name
/// Input property name as a string
/// \param value
- /// Input value of property
+ /// Input the value of property as an expression
///
/// \return
/// Returns PropertyValue
@@ -70,7 +70,7 @@
/// Gets the property name as an identifier.
///
/// \return
- /// Returns identifier
+ /// Returns the PropertyValue Identifier
///
__property NAMESPACE_OSGEO_FDO_EXPRESSION::Identifier* get_Name();
@@ -78,7 +78,7 @@
/// Sets the property name as an identifier.
///
/// \param value
- /// Input identifier
+ /// Input the PropertyValue Identifier
///
/// \return
/// Returns nothing
@@ -89,7 +89,7 @@
/// Sets the property name as a string.
///
/// \param value
- /// Input string
+ /// Input property name as a string
///
/// \return
/// Returns nothing
@@ -100,7 +100,7 @@
/// Gets the value of the property as an ValueExpression.
///
/// \return
- /// Returns ValueExpression
+ /// Returns the Property value as a ValueExpression
///
__property NAMESPACE_OSGEO_FDO_EXPRESSION::ValueExpression* get_Value();
@@ -108,7 +108,7 @@
/// Sets the value of the property as an ValueExpression.
///
/// \param value
- /// Input value
+ /// Input the Property value as a ValueExpression
///
/// \return
/// Returns nothing
@@ -120,7 +120,7 @@
/// will be parsed to produce the required ValueExpression.
///
/// \param value
- /// Input value
+ /// Input the Property value as a String
///
/// \return
/// Returns nothing
@@ -143,12 +143,14 @@
/// Gets the value of the property as an Stream Reader.
///
/// \return
- /// Returns IStreamReader
+ /// Returns the value of the propery as an IStreamReader
///
__property NAMESPACE_OSGEO_COMMON::IStreamReader* get_StreamReader();
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public private:
PropertyValue(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgPropertyValueCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgPropertyValueCollection.h 2007-02-02 01:03:17 UTC (rev 709)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Commands/mgPropertyValueCollection.h 2007-02-02 01:09:37 UTC (rev 710)
@@ -24,13 +24,32 @@
public __gc class PropertyValue;
/// \brief
-/// The PropertyValueCollection class represents a collection of FdoIdentifier objects.
+/// The PropertyValueCollection class represents a collection of PropertyValue objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __sealed __gc class PropertyValueCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
+/// \cond DOXYGEN-IGNORE
private:
/// \brief
- /// nested class defined to provide Enumerator.
+ /// A Nested class defined to provide enumeration of Dictionary elements
+ ///
+ /// Enumerators can be used to read the data in the collection,
+ /// but they cannot be used to modify the underlying collection.
+ ///
+ /// An enumerator remains valid as long as the collection remains unchanged.
+ /// If changes are made to the collection, such as adding, modifying, or deleting
+ /// elements, the enumerator is irrecoverably invalidated and the next call to
+ /// MoveNext or Reset throws an InvalidOperationException. If the collection is
+ /// modified between MoveNext and Current, Current returns the element that it is
+ /// set to, even if the enumerator is already invalidated.
+ ///
+ /// The enumerator does not have exclusive access to the collection; therefore,
+ /// enumerating through a collection is intrinsically not a thread-safe procedure.
+ /// Even when a collection is synchronized, other threads can still modify the
+ /// collection, which causes the enumerator to throw an exception. To guarantee
+ /// thread safety during enumeration, you can either lock the collection during
+ /// the entire enumeration or catch the exceptions resulting from changes made
+ /// by other threads.
///
__gc class Enumerator : public System::Collections::IEnumerator
{
@@ -39,16 +58,48 @@
System::Int32 m_nIdx;
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param elements
+ /// Input The collection to enumerate.
+ ///
Enumerator(PropertyValueCollection* elements) : m_pCol(elements), m_nIdx(-1)
{
}
- __property System::Object* get_Current();
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
+ __property System::Object *get_Current();
- System::Boolean MoveNext();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
+ System::Boolean MoveNext();
- System::Void Reset();
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
+ System::Void Reset();
};
public private:
@@ -60,54 +111,52 @@
inline FdoPropertyValueCollection* GetImpObj();
private:
- /// System::Collections::ICollection interfaces
- System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+ // System::Collections::ICollection interface properties
+ __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
- __property System::Object* System::Collections::ICollection::get_SyncRoot();
+ // System::Collections::ICollection interface methods
+ System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
- __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+ // System::Collections::IList interface properties
+ __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ __property System::Boolean System::Collections::IList::get_IsReadOnly();
+ __property Object* System::Collections::IList::get_Item(System::Int32 index);
+ __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
- // System::Collections::IList interfaces
- __property System::Boolean System::Collections::IList::get_IsFixedSize();
+ // System::Collections::IList interface methods
+ System::Int32 System::Collections::IList::Add(Object* value);
+ System::Boolean System::Collections::IList::Contains(Object* value);
+ System::Int32 System::Collections::IList::IndexOf(Object* value);
+ System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
+ System::Void System::Collections::IList::Remove(Object* value);
- __property System::Boolean System::Collections::IList::get_IsReadOnly();
+/// \endcond
- System::Int32 System::Collections::IList::Add(Object* value);
-
- System::Boolean System::Collections::IList::Contains(Object* value);
-
- System::Int32 System::Collections::IList::IndexOf(Object* value);
-
- System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
-
- System::Void System::Collections::IList::Remove(Object* value);
-
- __property Object* System::Collections::IList::get_Item(System::Int32 index);
-
- __property System::Void System::Collections::IList::set_Item(System::Int32 index, Object* value);
-
public:
/// \brief
- /// Constructs a new empty string collection
+ /// Constructs a new empty PropertyValue collection
///
- /// \return
- /// Returns StringCollection
- ///
- ///
PropertyValueCollection();
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
+ /// \return
+ /// Returns the number of items in the collection.
+ ///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
+ /// \return
+ /// Returns a collection enumerator.
+ ///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue from this collection.
+ /// Removes the index-th PropertyValue from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -115,63 +164,63 @@
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
/// \brief
- /// Adds a NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue object into the collection.
+ /// Adds a PropertyValue object into the collection.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue object to add.
+ /// Input the PropertyValue object to add.
///
/// \return
- /// Returns the position into which the new element was inserted.
+ /// Returns the position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* value);
/// \brief
- /// Determines the index of a specific NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue object.
+ /// Determines the index of a specific PropertyValue object.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue object to locate in the collection.
+ /// Input the PropertyValue object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* value);
/// \brief
- /// Inserts a NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue object into the collection at the specified position.
+ /// Inserts a PropertyValue object into the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue object to insert.
+ /// Input the PropertyValue object to insert.
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* value);
/// \brief
- /// Removes the first occurrence of a specific NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue object.
+ /// Removes the first occurrence of a specific PropertyValue object.
///
/// \param value
- /// Input the NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue object to remove from the collection.
+ /// Input the PropertyValue object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* value);
/// \brief
- /// Determines whether the collection contains a specific NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue object.
+ /// Determines whether the collection contains a specific PropertyValue object.
///
/// \param value
- /// Input The NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue object to search in the collection.
+ /// Input the PropertyValue object to search in the collection.
///
/// \return
- /// Returns true if the value is found in the collection; otherwise, false.
+ /// Returns true if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -180,19 +229,49 @@
///
System::Void CopyTo(NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* array[],System::Int32 size);
-
/// \brief
- /// Gets or sets a NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue in the collection.
+ /// Gets the item in the collection at the specified index.
///
/// \param index
- /// Input index of the NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue to retrieve or set (System::Int32).
+ /// The index of the item in the collection. The index is 0 based.
///
+ /// \return
+ /// Returns an instance of a the collected item.
+ /// Throws an instance of Exception if the index is out of range or an error occurs.
+ ///
__property NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* get_RealTypeItem(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* value);
+ /// \brief
+ /// Gets an item in the collection.
+ ///
+ /// \param index
+ /// Input index of the item to retrieve.
+ ///
+ /// \return
+ /// Returns the item at the specified index
+ ///
__property NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* get_Item(System::Int32 index);
+ /// \brief
+ /// Sets the value of the item at the specified index
+ ///
+ /// \param index
+ /// Input index of the item to set.
+ ///
+ /// \param value
+ /// Input the value of the item
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* value);
/// \brief
@@ -232,8 +311,10 @@
///
NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* GetItem(System::Int32 index);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_COMMANDS
More information about the fdo-commits
mailing list