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::SpatialContext::ICreateSpatialContextImp Class Reference

Inherits OSGeo::FDO::Commands::ICommandImp, and OSGeo::FDO::Commands::SpatialContext::OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContext.

Inheritance diagram for OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp:

[legend]
List of all members.

Detailed Description

The ICreateSpatialContextImp class is a concrete implementation of ICreateSpatialContext. The ICreateSpatialContext 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.


Public Member Functions

System::Void Execute ()
 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.
__property System::String * get_CoordinateSystem ()
 Gets the coordinate system of the context to create as a string in OpenGIS SRS WKT format.
__property System::String * get_CoordinateSystemWkt ()
 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.
__property System::String * get_Description ()
 Gets the description of the context to create as a string.
__property System::Byte get_Extent ()[]
 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.
__property OSGeo::FDO::Commands::SpatialContext::SpatialContextExtentType get_ExtentType ()
 Gets the desired extent type of the context to create, either static or dynamic.
__property System::String * get_Name ()
 Gets the name of the context to create as a string.
__property System::Boolean get_UpdateExisting ()
 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.
__property System::Double get_XYTolerance ()
 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.
__property System::Double get_ZTolerance ()
 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.
__property System::Void set_CoordinateSystem (System::String *value)
 Sets the coordinate system of the context to create as a string in OpenGIS SRS WKT format.
__property System::Void set_CoordinateSystemWkt (System::String *value)
 Sets the coordinate system definition in OGC SRS WKT format for the spatial context currently being created.
__property System::Void set_Description (System::String *value)
 Sets the description of the context to create as a string.
__property System::Void set_Extent (System::Byte buffer[])
 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.
__property System::Void set_ExtentType (OSGeo::FDO::Commands::SpatialContext::SpatialContextExtentType value)
 Sets the desired extent type of the context to create, either static or dynamic.
__property System::Void set_Name (System::String *value)
 Sets the name of the context to create as a string.
__property System::Void set_UpdateExisting (System::Boolean value)
 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.
__property System::Void set_XYTolerance (System::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.
__property System::Void set_ZTolerance (System::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.

Member Function Documentation

System::Void OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::Execute  ) 
 

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

__property System::String* OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::get_CoordinateSystem  ) 
 

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

Returns:
Returns the coordinate system

__property System::String* OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::get_CoordinateSystemWkt  ) 
 

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.

__property System::String* OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::get_Description  ) 
 

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

Returns:
Returns the description of the spatial context

__property System::Byte OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::get_Extent  ) 
 

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

__property OSGeo ::FDO ::Commands ::SpatialContext ::SpatialContextExtentType OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::get_ExtentType  ) 
 

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

Returns:
Returns the extent type

__property System::String* OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::get_Name  ) 
 

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

Returns:
Returns the name of the spatial context

__property System::Boolean OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::get_UpdateExisting  ) 
 

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

__property System::Double OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::get_XYTolerance  ) 
 

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

__property System::Double OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::get_ZTolerance  ) 
 

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

__property System::Void OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::set_CoordinateSystem System::String *  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

__property System::Void OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::set_CoordinateSystemWkt System::String *  value  ) 
 

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

__property System::Void OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::set_Description System::String *  value  ) 
 

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

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

__property System::Void OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::set_Extent System::Byte  buffer[]  ) 
 

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:
buffer Input the extent of the spatial context
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::set_ExtentType OSGeo::FDO::Commands::SpatialContext::SpatialContextExtentType  value  ) 
 

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

Parameters:
value Input the extent type
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::set_Name System::String *  value  ) 
 

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

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

__property System::Void OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::set_UpdateExisting System::Boolean  value  ) 
 

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

__property System::Void OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::set_XYTolerance System::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

__property System::Void OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp::set_ZTolerance System::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

Comments or suggestions? Send us feedback.