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::Xml::XmlSpatialContextReader Class Reference

Inherits OSGeo::FDO::Common::Xml::XmlSaxHandler.

Inheritance diagram for OSGeo::FDO::Xml::XmlSpatialContextReader:

[legend]
List of all members.

Detailed Description

XmlSpatialContextReader reads Spatial Contexts from an XML document. Unlike other XML Readers, the reading is done procedurally, rather than through events. XmlSpatialContextReader implements ISpatialContextReader to provide the functions for retrieving the spatial contexts that were read.


Public Member Functions

System::String * GetCoordinateSystem ()
 Gets the name of the coordinate system of the spatial context currently being read. If the result is a null or empty string, the coordinate system is unknown to the spatial context.
System::String * GetCoordinateSystemWkt ()
 Gets the coordinate system in OpenGIS SRS WKT format of the spatial context currently being read. If the result is an empty string, the coordinate system WKT description is not available.
System::String * GetDescription ()
 Gets the description of the spatial context currently being read.
System::Byte GetExtent ()[]
 Gets the extent of the spatial context currently being read as a byte array in FGF format.
OSGeo::FDO::Commands::SpatialContext::SpatialContextExtentType GetExtentType ()
 Gets the extent type of the spatial context currently being read.
System::String * GetName ()
 ISpatialContextReader implementation Gets the name of the spatial context currently being read.
OSGeo::FDO::Common::Xml::XmlReaderGetXmlReader ()
 Gets the Xml document reader that was passed to this object.
System::Double GetXYTolerance ()
 Gets the tolerance value for XY ordinates of the spatial context currently being read. Tolerances are used in some geometric tests, mostly for equality between coordinates. This occurs frequently in spatial queries, especially with "on boundary" or "just touching" conditions. It is also an objective amount that can be used when formulating step distances for parametric curve interpolation.
System::Double GetZTolerance ()
 Gets the tolerance value for Z ordinates of the spatial context currently being read. Tolerances are used in some geometric tests, mostly for equality between coordinates. This occurs a frequently in spatial queries, especially with "on boundary" or "just touching" conditions. It is also an objective amount that can be used when formulating step distances for parametric curve interpolation.
System::Boolean IsActive ()
 Returns true if the spatial context currently being read is the active spatial context.
System::Boolean ReadNext ()
 Advances the reader to the next item. The default position of the reader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.
 XmlSpatialContextReader (OSGeo::FDO::Common::Xml::XmlReader *reader, OSGeo::FDO::Xml::XmlSpatialContextFlags *flags)
 creates a Spatial Context Reader.
 XmlSpatialContextReader (OSGeo::FDO::Common::Xml::XmlReader *reader)
 creates a Spatial Context Reader.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Xml::XmlSpatialContextReader::XmlSpatialContextReader OSGeo::FDO::Common::Xml::XmlReader reader  ) 
 

creates a Spatial Context Reader.

Parameters:
reader Input XML document reader. Specifies the XML document that the Spatial Contexts will be read from.

OSGeo::FDO::Xml::XmlSpatialContextReader::XmlSpatialContextReader OSGeo::FDO::Common::Xml::XmlReader reader,
OSGeo::FDO::Xml::XmlSpatialContextFlags flags
 

creates a Spatial Context Reader.

Parameters:
reader Input XML document reader. Specifies the XML document that the Spatial Contexts will be read from.
flags Input options for controlling the deserializing of the Spatial Contexts. If NULL then the default flags are used.

Member Function Documentation

System::String* OSGeo::FDO::Xml::XmlSpatialContextReader::GetCoordinateSystem  ) 
 

Gets the name of the coordinate system of the spatial context currently being read. If the result is a null or empty string, the coordinate system is unknown to the spatial context.

Returns:
Returns the coordinate system name of the spatial context.

System::String* OSGeo::FDO::Xml::XmlSpatialContextReader::GetCoordinateSystemWkt  ) 
 

Gets the coordinate system in OpenGIS SRS WKT format of the spatial context currently being read. If the result is an empty string, the coordinate system WKT description is not available.

Returns:
Returns the coordinate system description in WKT of of the spatial context.

System::String* OSGeo::FDO::Xml::XmlSpatialContextReader::GetDescription  ) 
 

Gets the description of the spatial context currently being read.

Returns:
Returns the description of the spatial context.

System::Byte OSGeo::FDO::Xml::XmlSpatialContextReader::GetExtent  ) 
 

Gets the extent of the spatial context currently being read as a byte array in FGF format.

Returns:
Returns the extent as a byte array in FGF format.

OSGeo ::FDO ::Commands ::SpatialContext ::SpatialContextExtentType OSGeo::FDO::Xml::XmlSpatialContextReader::GetExtentType  ) 
 

Gets the extent type of the spatial context currently being read.

Returns:
Returns the extent type.

System::String* OSGeo::FDO::Xml::XmlSpatialContextReader::GetName  ) 
 

ISpatialContextReader implementation Gets the name of the spatial context currently being read.

Returns:
Returns the name of the spatial context.

OSGeo ::FDO ::Common ::Xml ::XmlReader* OSGeo::FDO::Xml::XmlSpatialContextReader::GetXmlReader  ) 
 

Gets the Xml document reader that was passed to this object.

Returns:
Returns the XML document reader.

System::Double OSGeo::FDO::Xml::XmlSpatialContextReader::GetXYTolerance  ) 
 

Gets the tolerance value for XY ordinates of the spatial context currently being read. Tolerances are used in some geometric tests, mostly for equality between coordinates. This occurs frequently in spatial queries, especially with "on boundary" or "just touching" conditions. It is also an objective amount that can be used when formulating step distances for parametric curve interpolation.

Returns:
Returns the tolerance

System::Double OSGeo::FDO::Xml::XmlSpatialContextReader::GetZTolerance  ) 
 

Gets the tolerance value for Z ordinates of the spatial context currently being read. Tolerances are used in some geometric tests, mostly for equality between coordinates. This occurs a frequently in spatial queries, especially with "on boundary" or "just touching" conditions. It is also an objective amount that can be used when formulating step distances for parametric curve interpolation.

Returns:
Returns the tolerance

System::Boolean OSGeo::FDO::Xml::XmlSpatialContextReader::IsActive  ) 
 

Returns true if the spatial context currently being read is the active spatial context.

Returns:
Returns true if the current spatial context is the active one.

System::Boolean OSGeo::FDO::Xml::XmlSpatialContextReader::ReadNext  ) 
 

Advances the reader to the next item. The default position of the reader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Returns:
Returns true if there is a next item.

System::Void OSGeo::FDO::Xml::XmlSpatialContextReader::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Common::Xml::XmlSaxHandler.


Comments or suggestions? Send us feedback.