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

FdoXmlSpatialContextFlags Class Reference

#include <SpatialContextFlags.h>

Inherits FdoXmlFlags.

Inheritance diagram for FdoXmlSpatialContextFlags:

[legend]
List of all members.

Detailed Description

FdoXmlSpatialContextFlags extends FdoXmlFlags to specify flags specific to Spatial Contexts.

Definition at line 31 of file SpatialContextFlags.h.


Public Types

enum  ConflictOption {
  ConflictOption_Add,
  ConflictOption_Update,
  ConflictOption_Skip
}
 The FdoXmlSpatialContextFlags::ConflictOption specifies how to handle Spatial Contexts that are already in the DataStore, when Deserializing:. More...

Public Member Functions

FDO_API ConflictOption GetConflictOption () const
 Get the current option for handling Spatial Contexts already in the connection.
FDO_API FdoBoolean GetIncludeDefault () const
 Gets the default Spatial Context inclusion flag.
FDO_API void SetConflictOption (ConflictOption conflictOption)
 Sets the current option for handling Spatial Contexts already in the connection.
FDO_API void SetIncludeDefault (FdoBoolean includeDefault)
 Sets the default Spatial Context inclusion flag.

Static Public Member Functions

FDO_API FdoXmlSpatialContextFlagsCreate (FdoString *url=L"fdo.osgeo.org/schemas/feature", ErrorLevel errorLevel=ErrorLevel_Normal, FdoBoolean nameAdjust=true, ConflictOption conflictOption=ConflictOption_Add, FdoBoolean includeDefault=false)
 Constructs an FdoXmlSpatialContextFlags object.

Protected Member Functions

FDO_API FdoXmlSpatialContextFlags (FdoString *url, ErrorLevel errorLevel, FdoBoolean nameAdjust, ConflictOption conflictOption, FdoBoolean includeDefault)
 FdoXmlSpatialContextFlags ()
 default constructor to keep linux from complaining
virtual FDO_API ~FdoXmlSpatialContextFlags ()

Member Enumeration Documentation

enum FdoXmlSpatialContextFlags::ConflictOption
 

The FdoXmlSpatialContextFlags::ConflictOption specifies how to handle Spatial Contexts that are already in the DataStore, when Deserializing:.

Enumeration values:
ConflictOption_Add  is thrown.

if the Spatial Context already exists, throw an exception.

ConflictOption_Update  Update the spatial context if it already exists and add it if it doesn't exist.
ConflictOption_Skip  Add new spatial contexts and silently skip spatial contexts already in the DataStore.

Definition at line 38 of file SpatialContextFlags.h.


Constructor & Destructor Documentation

FdoXmlSpatialContextFlags::FdoXmlSpatialContextFlags  )  [inline, protected]
 

default constructor to keep linux from complaining

Definition at line 122 of file SpatialContextFlags.h.

FDO_API FdoXmlSpatialContextFlags::FdoXmlSpatialContextFlags FdoString url,
ErrorLevel  errorLevel,
FdoBoolean  nameAdjust,
ConflictOption  conflictOption,
FdoBoolean  includeDefault
[protected]
 

virtual FDO_API FdoXmlSpatialContextFlags::~FdoXmlSpatialContextFlags  )  [protected, virtual]
 


Member Function Documentation

FDO_API FdoXmlSpatialContextFlags* FdoXmlSpatialContextFlags::Create FdoString url = L"fdo.osgeo.org/schemas/feature",
ErrorLevel  errorLevel = ErrorLevel_Normal,
FdoBoolean  nameAdjust = true,
ConflictOption  conflictOption = ConflictOption_Add,
FdoBoolean  includeDefault = false
[static]
 

Constructs an FdoXmlSpatialContextFlags object.

Parameters:
url Base URL for generating well-known references to GML coordinate systems and transformations
errorLevel Input The error level for reading spatial contexts. Controls how strict the error reporting is.
nameAdjust Input true: apply name adjustment to all elements. false: apply name adjustment only to elements with fdo:nameAdjust="true"
conflictOption Input option for Deserializing Spatial Contexts. Specified how Spatial Contexts, already in the FDO connection, are handled.
includeDefault Input true: When Serializing Spatial Contexts, serialize all contexts including the default. false: skip the default Spatial Context.
Returns:
Returns FdoXmlSpatialContextFlags

FDO_API ConflictOption FdoXmlSpatialContextFlags::GetConflictOption  )  const
 

Get the current option for handling Spatial Contexts already in the connection.

Returns:
Returns the current conflict option.

FDO_API FdoBoolean FdoXmlSpatialContextFlags::GetIncludeDefault  )  const
 

Gets the default Spatial Context inclusion flag.

Returns:
Returns the default Spatial Context inclusion flag.

FDO_API void FdoXmlSpatialContextFlags::SetConflictOption ConflictOption  conflictOption  ) 
 

Sets the current option for handling Spatial Contexts already in the connection.

Parameters:
conflictOption Input option for Deserializing Spatial Contexts. Specified how Spatial Contexts, already in the FDO connection, are handled.

FDO_API void FdoXmlSpatialContextFlags::SetIncludeDefault FdoBoolean  includeDefault  ) 
 

Sets the default Spatial Context inclusion flag.

Parameters:
includeDefault Input true: When Serializing Spatial Contexts, serialize all contexts including the default. false: skip the default Spatial Context.

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