FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Commands::Feature::IFeatureReaderImp Class Reference

Inherits OSGeo::FDO::Commands::Feature::IReaderImp, and OSGeo::FDO::Commands::Feature::OSGeo::FDO::Commands::Feature::IFeatureReader.

Inheritance diagram for OSGeo::FDO::Commands::Feature::IFeatureReaderImp:

[legend]
List of all members.

Detailed Description

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.


Public Member Functions

OSGeo::FDO::Schema::ClassDefinitionGetClassDefinition ()
 Gets the definition of the object currently being read. If the user has requested only a subset of the class properties, the class definition reflects what the user has asked, rather than the full class definition.
System::Int32 GetDepth ()
 Gets a value indicating the depth of nesting for the current reader. The depth value increases each time GetFeatureObject is called and a new reader is returned. The outermost reader has a depth of 0.
OSGeo::FDO::Commands::Feature::IFeatureReaderGetFeatureObject (System::String *propertyName)
 Gets a reference to an IFeatureReader to read the data contained in the object or object collection property. If the property is not an object property, an exception is thrown.
System::Byte GetGeometry (System::String *propertyName)[]
 Gets the geometry value of the specified property as a byte array in FGF format. Because no conversion is performed, the property must be of Geometric type; otherwise, an exception is thrown. This method is a language-specific performance optimization that returns a pointer to the array data, rather than to an object that encapsulates the array. The array's memory area is only guaranteed to be valid until a call to ReadNext() or Close(), or the disposal of this reader object.

Member Function Documentation

OSGeo ::FDO ::Schema ::ClassDefinition* OSGeo::FDO::Commands::Feature::IFeatureReaderImp::GetClassDefinition  ) 
 

Gets the definition of the object currently being read. If the user has requested only a subset of the class properties, the class definition reflects what the user has asked, rather than the full class definition.

Returns:
Returns the class definition object.

System::Int32 OSGeo::FDO::Commands::Feature::IFeatureReaderImp::GetDepth  ) 
 

Gets a value indicating the depth of nesting for the current reader. The depth value increases each time GetFeatureObject is called and a new reader is returned. The outermost reader has a depth of 0.

Returns:
Returns the feature reader depth

OSGeo ::FDO ::Commands ::Feature ::IFeatureReader* OSGeo::FDO::Commands::Feature::IFeatureReaderImp::GetFeatureObject System::String *  propertyName  ) 
 

Gets a reference to an IFeatureReader to read the data contained in the object or object collection property. If the property is not an object property, an exception is thrown.

Parameters:
propertyName Input the property name.
Returns:
Returns the nested feature reader

System::Byte OSGeo::FDO::Commands::Feature::IFeatureReaderImp::GetGeometry System::String *  propertyName  ) 
 

Gets the geometry value of the specified property as a byte array in FGF format. Because no conversion is performed, the property must be of Geometric type; otherwise, an exception is thrown. This method is a language-specific performance optimization that returns a pointer to the array data, rather than to an object that encapsulates the array. The array's memory area is only guaranteed to be valid until a call to ReadNext() or Close(), or the disposal of this reader object.

Parameters:
propertyName Input the property name.
Returns:
Returns a pointer to the byte array in FGF format.

Reimplemented from OSGeo::FDO::Commands::Feature::IReaderImp.


Comments or suggestions? Send us feedback.