Interface IFeatureClass
- Namespace
- ESRI.ArcGIS.Geodatabase
- Assembly
- ESRI.Server.Geodatabase.dll
Provides access to members that control the behavior and properties of a feature class.
[Guid("D4803EE6-79F4-11D0-97FC-0080C7F79481")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IFeatureClass : IObjectClass, IClass
Remarks
Feature classes can be created using the IFeatureWorkspace.CreateFeatureClass and IFeatureDataset.CreateFeatureClass methods.
Properties
AliasName
string AliasName { get; }
Property Value
AreaField
The geometry area field.
IField AreaField { get; }
Property Value
Remarks
This read-only property returns the name of the field which records the area of each feature. Only feature classes that have a ShapeType of esriGeometryPolygon have an Area field.
A null pointer will be returned if:
- the feature class does not have a shape type of esriGeometryPolygon
- the underlying database does not maintain an area field
- the feature class is a shapefile or CAD data
CLSID
UID CLSID { get; }
Property Value
EXTCLSID
UID EXTCLSID { get; }
Property Value
Extension
object Extension { get; }
Property Value
ExtensionProperties
IPropertySet ExtensionProperties { get; }
Property Value
FeatureClassID
The unique ID for the Feature Class.
int FeatureClassID { get; }
Property Value
Remarks
This read-only property will return the unique identifier for this feature class. All feature classes inside Geodatabases have a unique ID. Coverage and Shapefile feature classes do not, so IFeatureClass::FeatureClassID will always return -1 for Coverage and Shapefile feature classes. Since IFeatureClass inherits from IObjectClass, you can also get the feature class ID from IObjectClass:: ObjectClassID.
FeatureDataset
The feature dataset that contains the feature class.
IFeatureDataset FeatureDataset { get; }
Property Value
Remarks
This read-only property returns the IFeatureDataset interface on the feature dataset that this feature class is a memeber of. If the feature class is a stand alone feature class (it does not have a feature dataset), then this function will return a null pointer. A coverage feature class will return the IFeatureDataset interface to the coverage itself. Shapefiles will always return a null pointer.
FeatureType
The type of features in this feature class.
esriFeatureType FeatureType { get; }
Property Value
Remarks
This read-only property returns the feature type for the feature class as an esriFeatureType value. This property can be used to determine if a feature class is of a particular type, in order for the feature class to added to a network or topology, or possibly to skip over the feature class in an enumerator.
Fields
IFields Fields { get; }
Property Value
HasOID
bool HasOID { get; }
Property Value
Indexes
IIndexes Indexes { get; }
Property Value
LengthField
The geometry length field.
IField LengthField { get; }
Property Value
Remarks
This read-only property returns the name of the field which records the length of each feature. Only feature classes that have a ShapeType of esriGeometryPolygon or esriGeometryPolyLine have a Length field. For Line features, this field records the length of the polyline. For polygon features, this field records the perimeter of the polygon.
A null pointer will be returned if:
- the feature class does not have a shape type of esriGeometryPolygon or esriGeometryPolyLine
- the underlying database does not maintain an area field
- the feature class is a shapefile or CAD data
OIDFieldName
string OIDFieldName { get; }
Property Value
ObjectClassID
int ObjectClassID { get; }
Property Value
RelationshipClasses[esriRelRole]
IEnumRelationshipClass RelationshipClasses[esriRelRole Role] { get; }
Parameters
RoleesriRelRole
Property Value
ShapeFieldName
The name of the default sShape field.
string ShapeFieldName { get; }
Property Value
Remarks
This read-only property returns the name of the geometry field for the feature class.
ShapeType
The type of the default Shape for the features in this feature class.
esriGeometryType ShapeType { get; }
Property Value
Remarks
Methods
AddField(IField)
void AddField(IField Field)
Parameters
FieldIField
AddIndex(IIndex)
void AddIndex(IIndex Index)
Parameters
IndexIIndex
CreateFeature()
Create a new feature, with a system assigned object ID and null property values.
IFeature CreateFeature()
Returns
Remarks
CreateFeature will create a new feature for the feature class. The new feature is by default assigned a unique object ID (OID). All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null. Use the IFeature::Store method to actually store this new feature in the database. When working with a versioned feature class, CreateFeature should only be called within an edit session. You can start an edit session by calling IWorkspaceEdit::StartEditing. All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.
After calling CreateFeature, the default subtype value is not automatically set nor are default values initialized. For features without a subtype that have defined default values, calling IRowSubtypes::InitDefaultValues will initialize the default values. Use IRowSubtypes::SubtypeCode to set the subtype value for features with subtypes before calling IRowSubtypes::InitDefaultValues to initialize the default values for the particular subtype.
Calling the CreateFeature method on a feature class (via the IFeatureClass interface on the feature class) has the same effect as calling the CreateRow method on the FeatureClass (via the ITable interface on the feature class) except that the IFeatureClass methods return IFeature interfaces on the returned row object.
If multiple features with common attributes are being sequentially created, the CreateFeatureBuffer method, IFeatureCursor.InsertFeature method and IFeatureBuffer interface should be used for better performance.
The basic process to create a new feature is:
1) Create the feature
2) Create the geometry for the feature
3) Store the geometry in the feature
4) Store the feature
CreateFeatureBuffer()
Create a feature buffer that can be used with an insert cursor.
IFeatureBuffer CreateFeatureBuffer()
Returns
Remarks
The CreateFeatureBuffer method creates a feature buffer and returns the IFeatureBuffer interface. This can be used to create new features in the feature class with an insert cursor. Like creating a feature with IFeatureClass::CreateFeature, the field values for the new feature must be initialized to some value before it can be stored in the database. All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.
Calling the CreateFeatureBuffer method in IFeatureClass has the same effect as calling the CreateRowBuffer interface in ITable except that the IFeatureClass methods return an IFeatureBuffer interface on the created row buffer.
DeleteField(IField)
void DeleteField(IField Field)
Parameters
FieldIField
DeleteIndex(IIndex)
void DeleteIndex(IIndex Index)
Parameters
IndexIIndex
FeatureCount(IQueryFilter)
The number of features selected by the specified query.
long FeatureCount(IQueryFilter QueryFilter)
Parameters
QueryFilterIQueryFilter
Returns
Remarks
FeatureCount returns the number of features that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is supplied for the IQueryFilter, then FeatureCount returns the total number of features in the feature class.
FindField(string)
int FindField(string Name)
Parameters
Namestring
Returns
GetFeature(long)
Get the feature with the specified object ID.
IFeature GetFeature(long OID)
Parameters
OIDlong
Returns
Remarks
GetFeature will return a feature from the feature class with the parameter-specified Object ID (OID). This method is typically used to find a particular feature with a known Object ID. A cursor should be used to iterate through all features in a feature class.
Calling the GetFeature method on a feature class (via the IFeatureClass interface on the feature class) has the same effect as calling the GetRow method on the feature class (via the ITable interface) except that the return value is an IFeature reference, rather than IRow.
GetFeatures(object, bool)
Get a cursor of Rows given a set of object ids.
IFeatureCursor GetFeatures(object fids, bool Recycling)
Parameters
Returns
Remarks
GetFeatures will return an IFeatureCursor which contains the features from the feature class with the parameter-specified Object IDs (OID). This method can be used to loop through a particular set of features with known Object IDs.
Calling the GetFeatures method from the IFeatureClass interface has the same effect as calling the GetRows method from the ITable interface except that the return value is an IFeatureCursor reference, rather than an ICursor reference.
The fids parameter should be provided with an integer array. If the array contains an invalid Object ID, no error will occur, and no feature will be retrieved for the value.
This method should not be called from .NET or Java applications. Instead, call IGeoDatabaseBridge.GetFeatures.
Insert(bool)
Returns a cursor that can be used to insert new features.
IFeatureCursor Insert(bool useBuffering)
Parameters
useBufferingbool
Returns
Remarks
Insert creates an insert cursor on the feature class which can be used to insert new features into it.
Insert cursors can be used on instances of feature subclasses (such as network features) with guaranteed polymorphic behavior. Insert cursors can be used either inside or outside of an edit session. If used inside an edit session, the changes are not committed to the base table until the edit session is saved. Network feature classes, Topology feature classes, feature classes that participate in composite relationships or other relationships with messaging may only be updated within an edit session. If you attempt to use an insert cursor on one of these classes outside of an edit session, it will fail. In addition, inserts of features that participate in a Topology or Geometric Network must be bracketed within an edit operation.
If the insert cursor is created outside of an edit operation and new features are inserted within an edit operation, the changes are commited to the base tables. The additions to the base table cannot be undone. For this reason, insert cursors should typically be scoped to edit operations.
When using an insert cursor with simple features, IFeature.Store will not be called when a feature is inserted. If a class extension, editor extension or other custom implementation relies on the messages propagated from the Store method, this could cause a problem. The IObjectClassInfo interface can be implemented by a class extension to force a Store call when an insert cursor is used. Alternately, requiring Store calls can be specified across a workspace by setting the IWorkspaceEditControl.SetStoreEventsRequired property to true.
If the insert cursor is used to insert complex features (such as network features), the cursor will revert to using IFeature.Store.
When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.
Search(IQueryFilter, bool)
Returns an object cursor that can be used to fetch feature objects selected by the specified query.
IFeatureCursor Search(IQueryFilter filter, bool Recycling)
Parameters
filterIQueryFilterRecyclingbool
Returns
Remarks
Search will return an IFeatureCursor with all of the features that satisfy the attribute and/or spatial constraints as specified by an IQueryFilter reference. If a null value is passed to the filter parameter, the feature cursor will return all of the features from the feature class.
The recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single feature object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a feature object returned by a recycling cursor across multiple calls to NextFeature on the cursor. Features returned by a recycling cursor should not be modified. Non-recycling cursors return a separate feature object on each fetch. The features returned by a non-recycling cursor may be modified and stored with polymorphic behavior.
The Geodatabase guarantees "unique instance semantics" on non-recycling feature objects fetched during an edit session. In other words, if the feature retrieved by a search cursor has already been instantiated and is being referenced by the calling application, then a reference to the existing feature object is returned.
Non-recycling feature cursors returned from the Search method *MUST* be used when copying features from the cursor into an insert cursor of another class. This is because a recycling cursor reuses the same geometry and under some circumstances all of the features inserted into the insert cursor may have the same geometry. Using a non-recycling cursor ensures that each geometry is unique.
Existing rows can be edited with either a search cursor or an update cursor. When using a search cursor, NextRow is called, returning a reference to a row. The row is edited, and IRow.Store is called. When using an update cursor, NextRow is called, the row is edited, and ICursor.UpdateRow is called with the row as a parameter. It is important to remember, when using an update cursor, do not call the Store method.
|
|
ArcMap |
Engine - Simple |
Engine - Complex |
|
Inside edit sessions |
Search Cursor |
Search Cursor |
Search Cursor |
|
Outside edit sessions |
Search Cursor |
Update Cursor |
Search Cursor |
When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.
Select(IQueryFilter, esriSelectionType, esriSelectionOption, IWorkspace)
Returns a selection That contains the object ids selected by the specified query.
ISelectionSet Select(IQueryFilter QueryFilter, esriSelectionType selType, esriSelectionOption selOption, IWorkspace selectionContainer)
Parameters
QueryFilterIQueryFilterselTypeesriSelectionTypeselOptionesriSelectionOptionselectionContainerIWorkspace
Returns
Remarks
Select will return an ISelectionSet with all of the features that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is given as the IQueryFilter, then the selection will have all of the features from the feature class.
Calling the Select method in IFeatureClass has the same effect as calling the corresponding method in ITable.
The selType parameter determines the type of selection set that will be created: an ID set, a snapshot, or a hybrid. See the ISelectionSet interface for a comparison of the three types.
When calling Select the selectionContainer parameter is no longer required. A null value should be passed as this parameter.
Update(IQueryFilter, bool)
Returns a cursor that can be used to update features selected by the specified query.
IFeatureCursor Update(IQueryFilter filter, bool Recycling)
Parameters
filterIQueryFilterRecyclingbool
Returns
Remarks
Update opens an update cursor on the features specified by an attribute and/or spatial query as specified by the filter parameter. If a number of features selected by a particular query are to be updated and each feature is to be updated to a separate value then the update cursor is faster than doing an individual feature level update for each feature. The update is performed on the current 'cursor position'.
Update cursors can be used on instances of Feature subclasses (such as network features), with guaranteed polymorphic behavior. Update cursors can be used either inside or outside of an edit session. If used inside an edit session, the changes are not committed to the base table until the edit session is saved. Network feature classes, Topology feature classes, feature classes that participate in composite relationships or other relationships with messaging may only be updated within an edit session. If you attempt to use an update cursor on one of these classes outside of an edit session, it will fail. In addition, edits to features that participate in a Topology or Geometric Network must be bracketed within an edit operation.
When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.