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

FdoICreateSpatialContext Class Reference

#include <ICreateSpatialContext.h>

Inherits FdoICommand.

Inheritance diagram for FdoICreateSpatialContext:

[legend]
List of all members.

Detailed Description

The FdoICreateSpatialContext interface defines the CreateSpatialContext command, which creates a new spatial context. Input to the command includes the name, description, coordinate system, extent type, and extent for the new context. Command execution will fail if the context already exists, or if the coordinate system or extent type is not supported by the provider.

Note:
The geographic extent of a coordinate system should generally be defined as an envelope (or bounding box). However, any geometry type that falls into the surface geometric types can be used (e.g., polygons). If a non-rectangular area is passed in and the provider supports only a rectangular extent, the provider will compute the minimum box that encloses the given geometry and use that for the extent value.

Definition at line 45 of file ICreateSpatialContext.h.


Public Member Functions

virtual FDO_API void Execute ()=0
 Executes the CreateSpatialContext command. An exception is thrown if the spatial context already exists, or if the coordinate system or extent type is not supported by the provider.
virtual FDO_API FdoStringGetCoordinateSystem ()=0
 Gets the coordinate system name as a string.
virtual FDO_API FdoStringGetCoordinateSystemWkt ()=0
 Gets the coordinate system definition in OGC SRS WKT format for the spatial context currently being created. If the result is an empty string, the coordinate system WKT description has not been set.
virtual FDO_API FdoStringGetDescription ()=0
 Gets the description of the context to create as a string.
virtual FDO_API FdoByteArrayGetExtent ()=0
 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.
virtual FDO_API FdoSpatialContextExtentType GetExtentType ()=0
 Gets the desired extent type of the context to create, either static or dynamic.
virtual FDO_API FdoStringGetName ()=0
 Gets the name of the context to create as a string.
virtual FDO_API const bool GetUpdateExisting ()=0
 Gets a Boolean flag that indicates how the CreateSpatialContext command should behave if the spatial context already exists. If update existing is true and a spatial context with the specified name already exists then it will be updated. If update existing is false and a spatial context with the specified name already exists, command execution will fail.
virtual FDO_API const double GetXYTolerance ()=0
 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.
virtual FDO_API const double GetZTolerance ()=0
 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.
virtual FDO_API void SetCoordinateSystem (FdoString *value)=0
 Sets the coordinate system name as a string.
virtual FDO_API void SetCoordinateSystemWkt (FdoString *value)=0
 Sets the coordinate system definition in OGC SRS WKT format for the spatial context currently being created.
virtual FDO_API void SetDescription (FdoString *value)=0
 Sets the description of the context to create as a string.
virtual FDO_API void SetExtent (FdoByteArray *value)=0
 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.
virtual FDO_API void SetExtentType (FdoSpatialContextExtentType value)=0
 Sets the desired extent type of the context to create, either static or dynamic.
virtual FDO_API void SetName (FdoString *value)=0
 Sets the name of the context to create as a string.
virtual FDO_API void SetUpdateExisting (const bool value)=0
 Sets a Boolean flag that indicates how the CreateSpatialContext command should behave if the spatial context already exists. If update existing is true and a spatial context with the specified name already exists then it will be updated. If update existing is false and a spatial context with the specified name already exists, command execution will fail.
virtual FDO_API void SetXYTolerance (const double value)=0
 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.
virtual FDO_API void SetZTolerance (const double value)=0
 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.

Friends

class FdoIConnection

Member Function Documentation

virtual FDO_API void FdoICreateSpatialContext::Execute  )  [pure virtual]
 

Executes the CreateSpatialContext command. An exception is thrown if the spatial context already exists, or if the coordinate system or extent type is not supported by the provider.

Returns:
Returns nothing

virtual FDO_API FdoString* FdoICreateSpatialContext::GetCoordinateSystem  )  [pure virtual]
 

Gets the coordinate system name as a string.

Returns:
Returns the coordinate system

virtual FDO_API FdoString* FdoICreateSpatialContext::GetCoordinateSystemWkt  )  [pure virtual]
 

Gets the coordinate system definition in OGC SRS WKT format for the spatial context currently being created. If the result is an empty string, the coordinate system WKT description has not been set.

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

virtual FDO_API FdoString* FdoICreateSpatialContext::GetDescription  )  [pure virtual]
 

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

Returns:
Returns the description of the spatial context

virtual FDO_API FdoByteArray* FdoICreateSpatialContext::GetExtent  )  [pure virtual]
 

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

virtual FDO_API FdoSpatialContextExtentType FdoICreateSpatialContext::GetExtentType  )  [pure virtual]
 

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

Returns:
Returns the extent type

virtual FDO_API FdoString* FdoICreateSpatialContext::GetName  )  [pure virtual]
 

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

Returns:
Returns the name of the spatial context

virtual FDO_API const bool FdoICreateSpatialContext::GetUpdateExisting  )  [pure virtual]
 

Gets a Boolean flag that indicates how the CreateSpatialContext command should behave if the spatial context already exists. If update existing is true and a spatial context with the specified name already exists then it will be updated. If update existing is false and a spatial context with the specified name already exists, command execution will fail.

Returns:
Returns true if command should update existing contexts

virtual FDO_API const double FdoICreateSpatialContext::GetXYTolerance  )  [pure virtual]
 

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

virtual FDO_API const double FdoICreateSpatialContext::GetZTolerance  )  [pure virtual]
 

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

virtual FDO_API void FdoICreateSpatialContext::SetCoordinateSystem FdoString value  )  [pure virtual]
 

Sets the coordinate system name as a string.

Parameters:
value Input the coordinate system
Returns:
Returns nothing

virtual FDO_API void FdoICreateSpatialContext::SetCoordinateSystemWkt FdoString value  )  [pure virtual]
 

Sets the coordinate system definition in OGC SRS WKT format for the spatial context currently being created.

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

virtual FDO_API void FdoICreateSpatialContext::SetDescription FdoString value  )  [pure virtual]
 

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

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

virtual FDO_API void FdoICreateSpatialContext::SetExtent FdoByteArray value  )  [pure virtual]
 

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

virtual FDO_API void FdoICreateSpatialContext::SetExtentType FdoSpatialContextExtentType  value  )  [pure virtual]
 

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

Parameters:
value Input the extent type
Returns:
Returns nothing

virtual FDO_API void FdoICreateSpatialContext::SetName FdoString value  )  [pure virtual]
 

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

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

virtual FDO_API void FdoICreateSpatialContext::SetUpdateExisting const bool  value  )  [pure virtual]
 

Sets a Boolean flag that indicates how the CreateSpatialContext command should behave if the spatial context already exists. If update existing is true and a spatial context with the specified name already exists then it will be updated. If update existing is false and a spatial context with the specified name already exists, command execution will fail.

Parameters:
value Input true if existing contexts should be updated
Returns:
Returns nothing

virtual FDO_API void FdoICreateSpatialContext::SetXYTolerance const double  value  )  [pure virtual]
 

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

virtual FDO_API void FdoICreateSpatialContext::SetZTolerance const double  value  )  [pure virtual]
 

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

Friends And Related Function Documentation

friend class FdoIConnection [friend]
 

Reimplemented from FdoICommand.

Definition at line 47 of file ICreateSpatialContext.h.


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