FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoIDisposable Class Reference

#include <IDisposable.h>

Inherited by FdoArgumentDefinition, FdoClassCapabilities, FdoCollection< OBJ, EXC >, FdoCollection< ClassRef, FdoException >, FdoCollection< ElementMap, FdoException >, FdoCollection< FdoArgumentDefinition, FdoConnectionException >, FdoCollection< FdoClassDefinition, FdoSchemaException >, FdoCollection< FdoDataPropertyDefinition, FdoSchemaException >, FdoCollection< FdoDataValue, FdoExpressionException >, FdoCollection< FdoDictionaryElement, FdoException >, FdoCollection< FdoException, FdoException >, FdoCollection< FdoExpression, FdoExpressionException >, FdoCollection< FdoFeatureClass, FdoSchemaException >, FdoCollection< FdoFeatureSchema, FdoSchemaException >, FdoCollection< FdoFunctionDefinition, FdoConnectionException >, FdoCollection< FdoICurvePolygon, FdoException >, FdoCollection< FdoICurveSegmentAbstract, FdoException >, FdoCollection< FdoICurveString, FdoException >, FdoCollection< FdoIdentifier, FdoCommandException >, FdoCollection< FdoIDirectPosition, FdoException >, FdoCollection< FdoIDisposable, FdoException >, FdoCollection< FdoIGeometry, FdoException >, FdoCollection< FdoILinearRing, FdoException >, FdoCollection< FdoILineString, FdoException >, FdoCollection< FdoIoBufferStream, FdoException >, FdoCollection< FdoIPoint, FdoException >, FdoCollection< FdoIPolygon, FdoException >, FdoCollection< FdoIRing, FdoException >, FdoCollection< FdoParameterValue, FdoCommandException >, FdoCollection< FdoParameterValueCollection, FdoCommandException >, FdoCollection< FdoPhysicalSchemaMapping, FdoCommandException >, FdoCollection< FdoPropertyDefinition, FdoSchemaException >, FdoCollection< FdoPropertyValue, FdoCommandException >, FdoCollection< FdoSignatureDefinition, FdoConnectionException >, FdoCollection< FdoStringElement, FdoException >, FdoCollection< FdoUniqueConstraint, FdoSchemaException >, FdoCollection< FdoValueExpression, FdoFilterException >, FdoCollection< FdoVectorElement, FdoException >, FdoCollection< FdoXmlAttribute, FdoXmlException >, FdoCollection< FdoXmlClassMapping, FdoCommandException >, FdoCollection< FdoXmlElementMapping, FdoCommandException >, FdoCollection< OBJ, FdoCommandException >, FdoCollection< OBJ, FdoSchemaException >, FdoCollection< PrefixMapping, FdoXmlException >, FdoCollection< StackElement, FdoXmlException >, FdoCollection< StringsRef, FdoException >, FdoCollection< UniqueConstraintRef, FdoException >, FdoDisposable [virtual], FdoException, FdoExpression, FdoFilter, FdoFunctionDefinition, FdoGeometryFactoryAbstract, FdoGeometryStreamFactory, FdoGeometryStreamReader, FdoGeometryStreamWriter, FdoICommand, FdoICommandCapabilities, FdoIConnection, FdoIConnectionCapabilities, FdoIConnectionInfo, FdoICurveSegmentAbstract, FdoIDataStoreReader, FdoIDirectPosition, FdoIEnvelope, FdoIExpressionCapabilities, FdoIExpressionProcessor, FdoIFilterCapabilities, FdoIFilterProcessor, FdoIGeometry, FdoIGeometryCapabilities, FdoILockConflictReader, FdoILockedObjectReader, FdoILockOwnersReader, FdoILongTransactionCheckpointReader, FdoILongTransactionConflictDirectiveEnumerator, FdoILongTransactionPrivilegeReader, FdoILongTransactionReader, FdoILongTransactionSetReader, FdoIMeasureUnitReader, FdoIPropertyDictionary, FdoIRaster, FdoIRasterCapabilities, FdoIRasterPropertyDictionary, FdoIReader, FdoIRingAbstract, FdoISchemaCapabilities, FdoISpatialContextReader, FdoISQLDataReader, FdoIStreamReader, FdoITopologyCapabilities, FdoITransaction, FdoParameterValue, FdoPhysicalElementMapping, FdoPropertyValue, FdoPropertyValueConstraint, FdoProvider, FdoProviderCollection, FdoProviderNameTokens, FdoRasterDataModel, FdoReadOnlyCollection< OBJ, BASE, EXC >, FdoReadOnlyCollection< FdoArgumentDefinition, FdoArgumentDefinitionCollection, FdoConnectionException >, FdoReadOnlyCollection< FdoDataPropertyDefinition, FdoIDisposableCollection, FdoSchemaException >, FdoReadOnlyCollection< FdoPropertyDefinition, FdoIDisposableCollection, FdoSchemaException >, FdoReadOnlyNamedCollection< OBJ, BASECOLLECTION >, FdoReadOnlyUnnamedCollection< OBJ, BASE, EXC >, FdoReadOnlyUnnamedCollection< FdoSignatureDefinition, FdoSignatureDefinitionCollection, FdoSchemaException >, FdoRestrictedNamedCollection< BASEOBJ, SUBOBJ, BASECOLLECTION >, FdoSchemaAttributeDictionary, FdoSchemaElement, FdoSchemaMergeContext::ClassRef, FdoSchemaMergeContext::ElementMap, FdoSchemaMergeContext::StringsRef, FdoSemaphore, FdoSignatureDefinition, FdoUniqueConstraint, FdoXmlFeaturePropertyReader, FdoXmlFeaturePropertyWriter, FdoXmlFeatureWriter, FdoXmlFlags, FdoXmlSpatialContextWriter, IConnectionManager, and IProviderRegistry.

Inheritance diagram for FdoIDisposable:

[legend]
List of all members.

Detailed Description

FdoIDisposable is the base interface for all classes that implement this standard interface for reference counting and object destruction.

Definition at line 29 of file IDisposable.h.


Public Member Functions

virtual FDO_API_COMMON FdoInt32 AddRef ()
 Increase the reference count.
virtual FDO_API_COMMON FdoInt32 GetRefCount ()
 Retrieves the reference count.
virtual FDO_API_COMMON FdoInt32 Release ()
 Decrease the reference count.

Protected Member Functions

virtual FDO_API_COMMON void Dispose ()=0
 Dispose this object.
FDO_API_COMMON FdoIDisposable ()
 Create an instance of the IDisposable object.
virtual FDO_API_COMMON ~FdoIDisposable ()
 Default destructor for this class.

Constructor & Destructor Documentation

FDO_API_COMMON FdoIDisposable::FdoIDisposable  )  [inline, protected]
 

Create an instance of the IDisposable object.

Returns:
Returns nothing

Definition at line 38 of file IDisposable.h.

References FDO_API_COMMON.

virtual FDO_API_COMMON FdoIDisposable::~FdoIDisposable  )  [inline, protected, virtual]
 

Default destructor for this class.

Returns:
Returns nothing

Definition at line 46 of file IDisposable.h.

References FDO_API_COMMON.


Member Function Documentation

virtual FDO_API_COMMON FdoInt32 FdoIDisposable::AddRef  )  [inline, virtual]
 

Increase the reference count.

Returns:
Returns the new reference count (value for debugging use only).

Reimplemented in FdoStack< OBJ, EXC >, and FdoStack< StackElement, FdoXmlException >.

Definition at line 63 of file IDisposable.h.

References FDO_API_COMMON, and FdoInt32.

Referenced by FdoStack< StackElement, FdoXmlException >::AddRef(), and FdoPtr< FdoIoTextReader >::CopyTo().

virtual FDO_API_COMMON void FdoIDisposable::Dispose  )  [protected, pure virtual]
 

Dispose this object.

Returns:
Returns nothing

Implemented in FdoDictionary, FdoDisposable, FdoException, FdoIoByteStreamReader, FdoSemaphore, FdoStringCollection, FdoVector, FdoXmlAttributeCollection, FdoXmlReader, FdoXmlException, FdoClientServiceException, FdoConnectionManager, FdoProvider, FdoProviderCollection, FdoProviderNameTokens, FdoProviderRegistry, FdoBatchParameterValueCollection, FdoCommandException, FdoIdentifierCollection, FdoParameterValue, FdoParameterValueCollection, FdoPropertyValue, FdoPropertyValueCollection, FdoPhysicalSchemaMappingCollection, FdoISpatialContextReader, FdoSpatialContextMismatchException, FdoArgumentDefinition, FdoArgumentDefinitionCollection, FdoFunctionDefinition, FdoFunctionDefinitionCollection, FdoReadOnlyArgumentDefinitionCollection, FdoSignatureDefinition, FdoSignatureDefinitionCollection, FdoReadOnlySignatureDefinitionCollection, FdoConnectionException, FdoBinaryExpression, FdoBLOBValue, FdoBooleanValue, FdoByteValue, FdoCLOBValue, FdoComputedIdentifier, FdoDataValueCollection, FdoDateTimeValue, FdoDecimalValue, FdoDoubleValue, FdoExpressionCollection, FdoExpressionException, FdoFunction, FdoGeometryValue, FdoIdentifier, FdoInt16Value, FdoInt32Value, FdoInt64Value, FdoParameter, FdoSingleValue, FdoStringValue, FdoUnaryExpression, FdoBinaryLogicalOperator, FdoComparisonCondition, FdoDistanceCondition, FdoFilterException, FdoInCondition, FdoNullCondition, FdoSpatialCondition, FdoUnaryLogicalOperator, FdoValueExpressionCollection, FdoIDisposableCollection, FdoRasterDataModel, FdoAssociationPropertyDefinition, FdoAutogenerationException, FdoClass, FdoClassCapabilities, FdoClassCollection, FdoDataPropertyDefinition, FdoDataPropertyDefinitionCollection, FdoFeatureClass, FdoFeatureClassCollection, FdoFeatureSchema, FdoFeatureSchemaCollection, FdoGeometricPropertyDefinition, FdoNetworkClass, FdoNetworkLayerClass, FdoNetworkLinkFeatureClass, FdoNetworkNodeFeatureClass, FdoObjectPropertyDefinition, FdoPropertyDefinitionCollection, FdoPropertyValueConstraintList, FdoPropertyValueConstraintRange, FdoRasterPropertyDefinition, FdoReadOnlyDataPropertyDefinitionCollection, FdoReadOnlyPropertyDefinitionCollection, FdoSchemaAttributeDictionary, FdoSchemaException, FdoTopoFeaturePropertyDefinition, FdoTopoGeometryPropertyDefinition, FdoTopology, FdoUniqueConstraint, FdoUniqueConstraintCollection, FdoXmlClassMapping, FdoXmlClassMappingCollection, FdoXmlElementMapping, FdoXmlElementMappingCollection, FdoXmlFeaturePropertyWriter, FdoXmlFeatureWriter, FdoXmlFlags, FdoXmlSchemaMapping, FdoXmlSpatialContextReader, FdoXmlSpatialContextWriter, FdoDirectPositionImpl, FdoEnvelopeImpl, FdoFgfGeometryFactory, FdoCurvePolygonCollection, FdoCurveSegmentCollection, FdoCurveStringCollection, FdoDirectPositionCollection, FdoGeometryCollection, FdoLinearRingCollection, FdoLineStringCollection, FdoPointCollection, FdoPolygonCollection, and FdoRingCollection.

virtual FDO_API_COMMON FdoInt32 FdoIDisposable::GetRefCount  )  [inline, virtual]
 

Retrieves the reference count.

Returns:
Returns the existing reference count value.

Definition at line 79 of file IDisposable.h.

References FDO_API_COMMON, and FdoInt32.

virtual FDO_API_COMMON FdoInt32 FdoIDisposable::Release  )  [inline, virtual]
 

Decrease the reference count.

Returns:
Returns the new reference count (value for debugging use only).

Reimplemented in FdoStack< OBJ, EXC >, and FdoStack< StackElement, FdoXmlException >.

Definition at line 71 of file IDisposable.h.

References FDO_API_COMMON, and FdoInt32.

Referenced by FdoSchemaCollection< FdoDataPropertyDefinition >::Add(), FdoPtr< FdoIoTextReader >::Attach(), FdoSchemaCollection< FdoDataPropertyDefinition >::Insert(), FdoStack< StackElement, FdoXmlException >::Release(), FdoPtr< FdoIoTextReader >::Release(), and FdoSchemaCollection< FdoDataPropertyDefinition >::SetItem().


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.