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

FdoXmlSpatialContextWriter Class Reference

#include <SpatialContextWriter.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoXmlSpatialContextWriter:

[legend]
List of all members.

Detailed Description

FdoXmlSpatialContextWriter writes Spatial Contexts to an XML document. This is done by calling the various setter functions to set the spatial context attributes and then calling WriteSpatialContext() to write the spatial context using the current attributes.

Definition at line 35 of file SpatialContextWriter.h.


Public Member Functions

FDO_API FdoStringGetCoordinateSystem ()
 Gets the name of the coordinate system of the context to create.
FDO_API FdoStringGetCoordinateSystemWkt ()
 Gets the coordinate system of the context to create as a string in OpenGIS SRS WKT format.
FDO_API FdoStringGetDescription ()
 Gets the description of the context to create as a string.
FDO_API FdoByteArrayGetExtent ()
 Gets the extent of the context to create as a byte array in FGF format. If the extent type is dynamic, any value specified via this function is ignored.
FDO_API FdoSpatialContextExtentType GetExtentType ()
 Gets the desired extent type of the context to create, either static or dynamic.
FDO_API FdoStringGetName ()
 Gets the name of the context to create as a string.
FDO_API const double GetXYTolerance ()
 Gets the tolerance value to use for X/Y ordinates. 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.
FDO_API const double GetZTolerance ()
 Gets the tolerance value to use for Z ordinates. 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.
FDO_API void SetCoordinateSystem (FdoString *value)
 Gets the name of the coordinate system of the context to create.
FDO_API void SetCoordinateSystemWkt (FdoString *value)
 Sets the coordinate system of the context to create as a string in OpenGIS SRS WKT format.
FDO_API void SetDescription (FdoString *value)
 Sets the description of the context to create as a string.
FDO_API void SetExtent (FdoByteArray *value)
 Sets the extent of the context to create as a byte array in FGF format. If the extent type is dynamic this is optional and any value specified is ignored.
FDO_API void SetExtentType (FdoSpatialContextExtentType value)
 Sets the desired extent type of the context to create, either static or dynamic.
FDO_API void SetName (FdoString *value)
 Sets the name of the context to create as a string.
FDO_API void SetXYTolerance (const double value)
 Sets the tolerance value to use for X/Y ordinates. 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.
FDO_API void SetZTolerance (const double value)
 Sets the tolerance value to use for Z ordinates. 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.
FDO_API void WriteSpatialContext ()
 Writes the current Spatial Context to the XML document.

Static Public Member Functions

FDO_API FdoXmlSpatialContextWriterCreate (FdoXmlWriter *writer, FdoXmlSpatialContextFlags *flags=NULL)
 creates a Spatial Context Writer.

Protected Member Functions

virtual FDO_API void Dispose ()
 FdoXmlSpatialContextWriter (FdoXmlWriter *writer, FdoXmlSpatialContextFlags *flags=NULL)
 FdoXmlSpatialContextWriter ()
 default constructor to keep linux from complaining.
virtual ~FdoXmlSpatialContextWriter ()

Constructor & Destructor Documentation

FdoXmlSpatialContextWriter::FdoXmlSpatialContextWriter  )  [inline, protected]
 

default constructor to keep linux from complaining.

Definition at line 236 of file SpatialContextWriter.h.

FdoXmlSpatialContextWriter::FdoXmlSpatialContextWriter FdoXmlWriter writer,
FdoXmlSpatialContextFlags flags = NULL
[protected]
 

virtual FdoXmlSpatialContextWriter::~FdoXmlSpatialContextWriter  )  [inline, protected, virtual]
 

Definition at line 241 of file SpatialContextWriter.h.

References FDO_SAFE_RELEASE.


Member Function Documentation

FDO_API FdoXmlSpatialContextWriter* FdoXmlSpatialContextWriter::Create FdoXmlWriter writer,
FdoXmlSpatialContextFlags flags = NULL
[static]
 

creates a Spatial Context Writer.

Parameters:
writer Input XML document writer. Specifies the XML document that the Spatial Contexts will be written to.
flags Input options for controlling the deserializing of the Spatial Contexts. If NULL then the default flags are used.
Returns:
Returns FdoXmlSpatialContextWriter

virtual FDO_API void FdoXmlSpatialContextWriter::Dispose  )  [protected, virtual]
 

Closes the FdoXmlSpatialContextWriter object, freeing any resources it may be holding.

Implements FdoIDisposable.

FDO_API FdoString* FdoXmlSpatialContextWriter::GetCoordinateSystem  ) 
 

Gets the name of the coordinate system of the context to create.

Returns:
Returns the coordinate system name

FDO_API FdoString* FdoXmlSpatialContextWriter::GetCoordinateSystemWkt  ) 
 

Gets the coordinate system of the context to create as a string in OpenGIS SRS WKT format.

Returns:
Returns the coordinate system

FDO_API FdoString* FdoXmlSpatialContextWriter::GetDescription  ) 
 

Gets the description of the context to create as a string.

Returns:
Returns the description of the spatial context

FDO_API FdoByteArray* FdoXmlSpatialContextWriter::GetExtent  ) 
 

Gets the extent of the context to create as a byte array in FGF format. If the extent type is dynamic, any value specified via this function is ignored.

Returns:
Returns the extent of the spatial context

FDO_API FdoSpatialContextExtentType FdoXmlSpatialContextWriter::GetExtentType  ) 
 

Gets the desired extent type of the context to create, either static or dynamic.

Returns:
Returns the extent type

FDO_API FdoString* FdoXmlSpatialContextWriter::GetName  ) 
 

Gets the name of the context to create as a string.

Returns:
Returns the name of the spatial context

FDO_API const double FdoXmlSpatialContextWriter::GetXYTolerance  ) 
 

Gets the tolerance value to use for X/Y ordinates. 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

FDO_API const double FdoXmlSpatialContextWriter::GetZTolerance  ) 
 

Gets the tolerance value to use for Z ordinates. 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

FDO_API void FdoXmlSpatialContextWriter::SetCoordinateSystem FdoString value  ) 
 

Gets the name of the coordinate system of the context to create.

Parameters:
value Input the coordinate system name
Returns:
Returns nothing

FDO_API void FdoXmlSpatialContextWriter::SetCoordinateSystemWkt FdoString value  ) 
 

Sets the coordinate system of the context to create as a string in OpenGIS SRS WKT format.

Parameters:
value Input the coordinate system
Returns:
Returns nothing

FDO_API void FdoXmlSpatialContextWriter::SetDescription FdoString value  ) 
 

Sets the description of the context to create as a string.

Parameters:
value Input the description of the spatial context
Returns:
Returns nothing

FDO_API void FdoXmlSpatialContextWriter::SetExtent FdoByteArray value  ) 
 

Sets the extent of the context to create as a byte array in FGF format. If the extent type is dynamic this is optional and any value specified is ignored.

Parameters:
value Input the extent of the spatial context
Returns:
Returns nothing

FDO_API void FdoXmlSpatialContextWriter::SetExtentType FdoSpatialContextExtentType  value  ) 
 

Sets the desired extent type of the context to create, either static or dynamic.

Parameters:
value Input the extent type
Returns:
Returns nothing

FDO_API void FdoXmlSpatialContextWriter::SetName FdoString value  ) 
 

Sets the name of the context to create as a string.

Parameters:
value Input the name of the spatial context
Returns:
Returns nothing

FDO_API void FdoXmlSpatialContextWriter::SetXYTolerance const double  value  ) 
 

Sets the tolerance value to use for X/Y ordinates. 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.

Parameters:
value Input the tolerance
Returns:
Returns nothing

FDO_API void FdoXmlSpatialContextWriter::SetZTolerance const double  value  ) 
 

Sets the tolerance value to use for Z ordinates. 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.

Parameters:
value Input the tolerance
Returns:
Returns nothing

FDO_API void FdoXmlSpatialContextWriter::WriteSpatialContext  ) 
 

Writes the current Spatial Context to the XML document.


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