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 Namespace Reference


Classes

class  OSGeo::FDO::Commands::SpatialContext::IActivateSpatialContextImp
 The IActivateSpatialContextImp class is a concrete implementation of IActivateSpatialContext. The IActivateSpatialContext interface defines the ActivateSpatialContext command, which activates a specified spatial context. Input to the command is the name of the context to activate. More...
class  OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContextImp
 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. More...

class  OSGeo::FDO::Commands::SpatialContext::IDestroySpatialContextImp
 The IDestroySpatialContextImp class is a concrete implementation of IDestroySpatialContext. The IDestroySpatialContext interface defines the DestroySpatialContext command, which destroys an existing spatial context. Input to the command is the name of the context to destroy. Destroying a spatial context destroys all data stored in that context. More...
class  OSGeo::FDO::Commands::SpatialContext::IGetSpatialContextsImp
 The IGetSpatialContextsImp class is a concrete implementation of IGetSpatialContexts. The IGetSpatialContexts interface defines the GetSpatialContexts command, which enumerates the existing spatial contexts. More...
class  OSGeo::FDO::Commands::SpatialContext::ISpatialContextReaderImp
 The ISpatialContextReaderImp class is a concrete implementation of ISpatialContextReader. The ISpatialContextReader interface provides forward-only, read-only functionality for enumerating spatial contexts. A reference to an ISpatialContextReader is returned from the GetSpatialContexts command. The initial position of the ISpatialContextReader interface is prior to the first item. Thus, you must call ReadNext to begin accessing any data. More...
interface  OSGeo::FDO::Commands::SpatialContext::OSGeo::FDO::Commands::SpatialContext::IActivateSpatialContext
 The IActivateSpatialContext interface defines the ActivateSpatialContext command, which activates a specified spatial context. Input to the command is the name of the context to activate. More...
interface  OSGeo::FDO::Commands::SpatialContext::OSGeo::FDO::Commands::SpatialContext::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. More...

interface  OSGeo::FDO::Commands::SpatialContext::OSGeo::FDO::Commands::SpatialContext::IDestroySpatialContext
 The IDestroySpatialContext interface defines the DestroySpatialContext command, which destroys an existing spatial context. Input to the command is the name of the context to destroy. Destroying a spatial context destroys all data stored in that context. More...
interface  OSGeo::FDO::Commands::SpatialContext::OSGeo::FDO::Commands::SpatialContext::IGetSpatialContexts
 IGetSpatialContexts interface defines the GetSpatialContexts command, which enumerates the existing spatial contexts. More...
interface  OSGeo::FDO::Commands::SpatialContext::OSGeo::FDO::Commands::SpatialContext::ISpatialContextReader
 ISpatialContextReader interface provides forward-only, read-only functionality for enumerating spatial contexts. A reference to an ISpatialContextReader is returned from the GetSpatialContexts command. The initial position of the ISpatialContextReader interface is prior to the first item. Thus, you must call ReadNext to begin accessing any data. More...

Enumerations

enum  SpatialContextExtentType {
  SpatialContextExtentType_Static = FdoSpatialContextExtentType_Static,
  SpatialContextExtentType_Dynamic = FdoSpatialContextExtentType_Dynamic
}
 The SpatialContextExtentType enumeration defines how the extent of a context should be handled by the provider. More...

Functions

System::Void Execute ()
 Executes the ActivateSpatialContext command. An exception is thrown if the spatial context does not exist.
__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::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.
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 name of 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::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.
__property System::Void set_ActiveOnly (System::Boolean value)
 Sets a Boolean flag that indicates if the GetSpatialContexts command will return only the active spatial context or all spatial contexts. The default value of this flag is false, return all spatial contexts.
__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 activate 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.

Variables

public __gc __interface IActivateSpatialContext
public __gc __interface ICreateSpatialContext
public __gc __interface IDestroySpatialContext
public __gc __interface IGetSpatialContexts
public __gc __interface ISpatialContextReader

Enumeration Type Documentation

enum SpatialContextExtentType
 

The SpatialContextExtentType enumeration defines how the extent of a context should be handled by the provider.

Enumeration values:
SpatialContextExtentType_Static  The spatial extent of the context is static and must be specified when the context is created.
SpatialContextExtentType_Dynamic  The spatial extent of the context is dynamic and changes as data is added and removed from the context.

Function Documentation

System::Void Execute  ) 
 

Executes the ActivateSpatialContext command. An exception is thrown if the spatial context does not exist.

Returns:
Returns nothing

__property System::String* 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* 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* get_Description  ) 
 

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

Returns:
Returns the description of the spatial context

__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.

Returns:
Returns the extent of the spatial context

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

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

Returns:
Returns the extent type

__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.

Returns:
Returns true if command should update existing contexts

__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.

Returns:
Returns the tolerance

__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.

Returns:
Returns the tolerance

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.

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

System::String* GetCoordinateSystemWkt  ) 
 

Gets the name of 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* GetDescription  ) 
 

Gets the description of the spatial context currently being read.

Returns:
Returns the description of the spatial context.

System::Byte 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 GetExtentType  ) 
 

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

Returns:
Returns the extent type.

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.

Returns:
Returns the tolerance

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.

Returns:
Returns the tolerance

System::Boolean 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 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.

__property System::Void set_ActiveOnly System::Boolean  value  ) 
 

Sets a Boolean flag that indicates if the GetSpatialContexts command will return only the active spatial context or all spatial contexts. The default value of this flag is false, return all spatial contexts.

Parameters:
value Input the Boolean flag
Returns:
Returns nothing

__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.

Parameters:
value Input the coordinate system
Returns:
Returns nothing

__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.

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

__property System::Void 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 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 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 set_Name System::String *  value  ) 
 

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

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

__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.

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

__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.

Parameters:
value Input the tolerance
Returns:
Returns nothing

__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.

Parameters:
value Input the tolerance
Returns:
Returns nothing

Variable Documentation

public __gc __interface OSGeo::FDO::Commands::SpatialContext::IActivateSpatialContext
 

public __gc __interface OSGeo::FDO::Commands::SpatialContext::ICreateSpatialContext
 

public __gc __interface OSGeo::FDO::Commands::SpatialContext::IDestroySpatialContext
 

public __gc __interface OSGeo::FDO::Commands::SpatialContext::IGetSpatialContexts
 

public __gc __interface OSGeo::FDO::Commands::SpatialContext::ISpatialContextReader
 


Comments or suggestions? Send us feedback.