SBS::SWConnector Class Reference

SWConnector manages all SW Tics calls and exposes the calls to .NET. More...

List of all members.

Public Member Functions

__property String * get_aceName ()
 Get the currently stored Ace name.
__property void set_aceName (String *aceName)
 Set the currently stored Ace name.
__property String * get_displayScaleName ()
 Get the currently stored Display Scale name.
__property void set_displayScaleName (String *displayName)
 Set the currently stored Display Scale name.
__property String * get_drawingApplicationName ()
 Get the currently stored Drawing Application name.
__property void set_drawingApplicationName (String *drawingApplicationName)
 Set the currently stored Drawing Application name.
__property String * get_hostName ()
 Get the currently attached Host Name.
__property String * get_serviceName ()
 Get the currently attached Service Name.
 SWConnector ()
 Constructor to create a new SWConnector.
System::Int32 isConnected ()
 Checks if self is currently connected to SW.
AcptResult Connect (String *hostName, String *serviceName)
 Connects to the indicated SW TICS Service.
AcptResult Disconnect ()
 Disconnects from the current TICS Service.
DatabaseGetDatabase (System::String *dbName)
 Gets the named database.
DatabaseGetDatabases ()[]
 Gets an array of all available databases.
System::UInt32 GetNUniverses (String *dbName)
 Gets the number of defined universes for the named database.
World * GetWorld (System::String *dbName, System::UInt32 universeId, System::UInt32 worldId)
 Gets the world from the named database.
World * GetWorld (String *dbName, String *collName, String *gisKey)
 Gets the world from the named database which is owned by the indicated record.
World * GetWorlds (System::String *dbName, System::UInt32 universeId)[]
 Gets an array of worlds from the named database for the indicated universe.
CollectionGetCollection (System::String *dbName, System::String *collName)
 Gets the named collection from the indicated database.
CollectionGetCollections (System::String *dbName)[]
 Gets an array of Collections from the named database.
BoundingBoxGetCollectionBounds (String *dbName, String *collName, String *geomName, RetrievalContext *rc)
 Gets the Bounds for the named collection in the indicated database.
FieldDescriptorGetFieldDescriptor (System::String *dbName, System::String *collName, System::String *fieldName)
 Gets the Field Descriptor for the named field in the indicated collection and database.
FieldDescriptorGetFieldDescriptor (FieldDescriptor *fields[], String *fieldName)
 Helper method to return the fieldDescriptor with the given fieldName.
FieldDescriptorGetFieldDescriptors (System::String *dbName, String *collName)[]
 Gets all Field Descriptors for the indicated collection and database.
FieldDescriptorGetFieldDescriptors (String *dbName, String *collName, String *type)[]
 Gets all Field Descriptors for the indicated collection and database.
Enumerator * GetEnumerator (String *dbName, String *enumName)
 Gets the named Enumerator in the indicated database.
Record * GetARecord (String *dbname, String *collName)
 Gets the first record in the indicated database and collection.
Record * GetARecord (String *dbname, String *collName, RetrievalContext *rc)
 Gets the first record in the indicated database and collection using a retrieval context.
Record * GetRecord (String *dbname, String *collName, String *gisKey)
 Gets a record with the required key in the indicated database and collection.
Record * GetRecord (String *dbname, String *collName, String *gisKey, RetrievalContext *rc)
 Gets a record with the required key in the indicated database and collection and uses a RetrievalContext to control what is returned.
Record * GetRecord (String *dbname, Geometry *geom)
 Gets a record which owns the passed geometry in the indicated database.
Record * GetRecord (String *dbname, Geometry *geom, RetrievalContext *rc)
 Gets a record which owns the passed geometry in the indicated database and uses a RetrievalContext.
System::Int32 SetupGetRecords (String *dbname, String *collName)
 Sets up a Record retrieval stream for the indicated database and collection.
System::Int32 SetupGetRecords (String *dbname, String *collName, RetrievalContext *rc)
 Sets up a Record retrieval stream for the indicated database and collection using a RetrievalContext.
Record * GetRecords ()[]
 Gets the next chunk of Records primed with a SetupGetRecords() call.
System::Int32 SetupGetJoinRecords (String *dbname, String *collName, String *gisKey, String *joinName, RetrievalContext *rc)
 Sets up a Record retrieval stream for joined records.
Record * GetJoinRecords ()[]
 Gets the next chunk of Records primed with a SetupGetJoinRecords() call.
IEnumerator * GetRecordEnumerator (String *dbname, String *collName)
 Defines a RecordEnumerator able to iterate records from a named database and collection.
String * ConvertFieldNames (FieldDescriptor *fields[])[]
 Helper method to convert an array of FieldDescriptors to Field names.
AlternativeGetAlternative (System::String *dbName)
 Gets the current alternative in the named database.
AlternativeGotoAlternative (System::String *dbName, System::String *altName)
 Goto the indicated alternative in the named database.
System::Int32 CreateAlternative (System::String *dbName, System::String *altName)
 Create the indicated alternative in the named database The alternative name may only be specified in relative terms and must not already exist as a child of the current alternative level.
System::Int32 DeleteAlternative (System::String *dbName, System::String *altName)
 Delete the indicated alternative in the named database The alternative name may only be specified in relative terms and must exist as a child of the current alternative level.
String * GetAceNames ()[]
 Gets all Ace names for the current server.
String * GetDisplayScaleNames (String *aceName)[]
 Gets all Display Scale names for the indicated Ace.
String * GetDrawingApplicationNames (String *aceName)[]
 Gets all Drawing Application names for the indicated Ace.
Geometry * GetGeometry (String *dbname, System::UInt32 geomId[], RetrievalContext *rc)
 Gets a geometry with the passed geomId in the indicated database and uses a RetrievalContext.
System::Int32 SetupGetGeometry (String *dbname, String *geomSpec, RetrievalContext *rc)
 Sets up a Geometry retrieval stream for the indicated database and geomSpec using a RetrievalContext.
Geometry * GetGeometry ()[]
 Executes a retrieval of geometry based on a previous SetupGetGeometry() call.
Geometry * GetClosestGeometry (String *dbname, System::UInt32 maxCount, RetrievalContext *rc)[]
 Gets an array of geometry closest to the location identified by the passed RetrievalContext.
System::Int32 InsertRecord (Record *rec, CoordinateSystem *cs, String **gisKey)
 Inserts the passed record and returns the gisKey for the inserted record.
System::Int32 UpdateRecord (Record *rec, CoordinateSystem *cs)
 Updates the passed record.
System::Int32 DeleteRecord (Record *rec)
 Deletes the passed record.
System::Int32 DeleteRecord (String *dbname, String *collName, String *gisKey)
 Deletes the record with key gisKey in collection collName and Database dbname.
StyleGetStyle (String *dbname, String *drawingApplication, String *rwoType, String *appType, String *styleType, String *scale, System::Int32 subCode)
 Returns a Style record describing the reqiured geometry symbology.
SBS::Error * GetLastError ()
 Retrieve the last error or Null if no error has been recorded.
String * RunUserProc (String *procName, String *args)[]
 Runs a user defined procedure and returns the results for processing.


Detailed Description

SWConnector manages all SW Tics calls and exposes the calls to .NET.

The class is used as the root for creating connections and passing requests to Smallworld


Member Function Documentation

AcptResult SBS::SWConnector::Connect String *  hostName,
String *  serviceName
 

Connects to the indicated SW TICS Service.

Parameters:
hostName - Host machine name running the sw_connector TICS server
serviceName - Name of the service running on the server
Returns:
0 (TICS_OK) if ok otherwise a TICS error code

String* SBS::SWConnector::ConvertFieldNames FieldDescriptor fields[]  ) 
 

Helper method to convert an array of FieldDescriptors to Field names.

Returns:
An array of Field names

System::Int32 SBS::SWConnector::CreateAlternative System::String *  dbName,
System::String *  altName
 

Create the indicated alternative in the named database The alternative name may only be specified in relative terms and must not already exist as a child of the current alternative level.

Parameters:
dbName - The name of the required database
altName - The name of the alternative to create
Returns:
1 for OK or 0 for Error. If 0 then the last error can be retrieved with getLastError()

System::Int32 SBS::SWConnector::DeleteAlternative System::String *  dbName,
System::String *  altName
 

Delete the indicated alternative in the named database The alternative name may only be specified in relative terms and must exist as a child of the current alternative level.

Parameters:
dbName - The name of the required database
altName - The name of the alternative to delete
Returns:
1 for OK or 0 for Error. If 0 then the last error can be retrieved with getLastError()

System::Int32 SBS::SWConnector::DeleteRecord String *  dbname,
String *  collName,
String *  gisKey
 

Deletes the record with key gisKey in collection collName and Database dbname.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
gisKey - The key for the required record
Returns:
0 for OK. If non Zero then the last error can be retrieved with getLastError()

System::Int32 SBS::SWConnector::DeleteRecord Record *  rec  ) 
 

Deletes the passed record.

Parameters:
rec - The Record to be updated
Returns:
0 for OK. If non Zero then the last error can be retrieved with getLastError()

AcptResult SBS::SWConnector::Disconnect  ) 
 

Disconnects from the current TICS Service.

Returns:
0 (TICS_OK)

String* SBS::SWConnector::GetAceNames  ) 
 

Gets all Ace names for the current server.

Returns:
An array of Ace names or Null. If Null then the last error can be retrieved with getLastError()

Alternative* SBS::SWConnector::GetAlternative System::String *  dbName  ) 
 

Gets the current alternative in the named database.

Parameters:
dbName - The name of the required database
Returns:
The Alternative or Null. If Null then the last error can be retrieved with getLastError()

Record* SBS::SWConnector::GetARecord String *  dbname,
String *  collName,
RetrievalContext rc
 

Gets the first record in the indicated database and collection using a retrieval context.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
rc - The RetrievalContext controlling how the record is returned
Parameters from RetrievalContext used for this call:

  • cs - Coordinate System controlling returned geometry coordinate information
  • fieldNames - The names of all fields to be returned
Returns:
The first Record or Null. If Null then the last error can be retrieved with getLastError()

Record* SBS::SWConnector::GetARecord String *  dbname,
String *  collName
 

Gets the first record in the indicated database and collection.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
Returns:
The first Record or Null. If Null then the last error can be retrieved with getLastError()

Geometry* SBS::SWConnector::GetClosestGeometry String *  dbname,
System::UInt32  maxCount,
RetrievalContext rc
 

Gets an array of geometry closest to the location identified by the passed RetrievalContext.

Parameters:
dbName - The name of the required database
rc - The RetrievalContext controlling how the geometry is returned
Parameters from RetrievalContext used for this call:

  • cs - Coordinate System controlling returned geometry coordinate information
  • fieldDesciptors - The fieldDescriptors for all geometry required
  • bb - The bounds for which records are to be retrieved
  • world - The world all geometry should be retrieved from
Returns:
The Geometry or Null. If Null then the last error can be retrieved with getLastError()

Collection* SBS::SWConnector::GetCollection System::String *  dbName,
System::String *  collName
 

Gets the named collection from the indicated database.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
Returns:
The required Collection or Null. If Null then the last error can be retrieved with getLastError()

BoundingBox* SBS::SWConnector::GetCollectionBounds String *  dbName,
String *  collName,
String *  geomName,
RetrievalContext rc
 

Gets the Bounds for the named collection in the indicated database.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
rc - A RetrievalContext object indicating how the bounds are to be returned
Returns:
The required Bounding Box or Null. If Null then the last error can be retrieved with getLastError()

Collection* SBS::SWConnector::GetCollections System::String *  dbName  ) 
 

Gets an array of Collections from the named database.

Parameters:
dbName - The name of the required database
Returns:
An array of Collections or Null. If Null then the last error can be retrieved with getLastError()

Database* SBS::SWConnector::GetDatabase System::String *  dbName  ) 
 

Gets the named database.

Parameters:
dbName - the name of the required database
Returns:
The required Database or Null. If Null then the last error can be retrieved with getLastError()

Database* SBS::SWConnector::GetDatabases  ) 
 

Gets an array of all available databases.

Returns:
An array of available Databases or Null. If Null then the last error can be retrieved with getLastError()

String* SBS::SWConnector::GetDisplayScaleNames String *  aceName  ) 
 

Gets all Display Scale names for the indicated Ace.

Parameters:
aceName - The name of the ace
Returns:
An array of Display Scale names or Null. If Null then the last error can be retrieved with getLastError()

String* SBS::SWConnector::GetDrawingApplicationNames String *  aceName  ) 
 

Gets all Drawing Application names for the indicated Ace.

Parameters:
aceName - The name of the ace
Returns:
An array of Drawing Application names or Null. If Null then the last error can be retrieved with getLastError()

Enumerator* SBS::SWConnector::GetEnumerator String *  dbName,
String *  enumName
 

Gets the named Enumerator in the indicated database.

Parameters:
dbName - The name of the required database
enumName - The name of the required enumerator
Returns:
The required Enumerator or Null. If Null then the last error can be retrieved with getLastError()

FieldDescriptor* SBS::SWConnector::GetFieldDescriptor FieldDescriptor fields[],
String *  fieldName
 

Helper method to return the fieldDescriptor with the given fieldName.

The passed field descriptor array should already be populated. This method is purely a lookup convenience

Returns:
The named fieldDescriptor

FieldDescriptor* SBS::SWConnector::GetFieldDescriptor System::String *  dbName,
System::String *  collName,
System::String *  fieldName
 

Gets the Field Descriptor for the named field in the indicated collection and database.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
fieldName - The name of the required field
Returns:
The required Field Descriptor or Null. If Null then the last error can be retrieved with getLastError()

FieldDescriptor* SBS::SWConnector::GetFieldDescriptors String *  dbName,
String *  collName,
String *  type
 

Gets all Field Descriptors for the indicated collection and database.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
type - The type of fields to be returned
Type is a string containing keywords which are parsed to determine the fields to return

Valid keywords are:

  • all - Default return all fields
  • physical - Return physical fields
  • geometry - Return geometry fields
  • logical - Return logical fields
  • join - Return join fields
  • key - Return key fields
  • visible - Return only visible fields
Geometry Subtypes:
  • text - Return text geometry
  • point - Return point geometry
  • chain - Return chain geometry
  • area - Return area geometry
Field types can be concatenated into the string i.e. visible physical geometry will return all visible physical or geometry fields. The type keywords are all or'd to define the set of field descriptors to be returned. The only exceptions to this are the visible and geometry subtypes which are or'd.

Returns:
An array of Field Descriptors or Null. If Null then the last error can be retrieved with getLastError()

FieldDescriptor* SBS::SWConnector::GetFieldDescriptors System::String *  dbName,
String *  collName
 

Gets all Field Descriptors for the indicated collection and database.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
Returns:
An array of Field Descriptors or Null. If Null then the last error can be retrieved with getLastError()

Geometry* SBS::SWConnector::GetGeometry  ) 
 

Executes a retrieval of geometry based on a previous SetupGetGeometry() call.

Returns:
Geometry Array or Null. If Null then the last error can be retrieved with getLastError()

Geometry* SBS::SWConnector::GetGeometry String *  dbname,
System::UInt32  geomId[],
RetrievalContext rc
 

Gets a geometry with the passed geomId in the indicated database and uses a RetrievalContext.

Parameters:
dbName - The name of the required database
geomId - The geometry key for the required geometry
rc - The RetrievalContext controlling how the geometry is returned
Parameters from RetrievalContext used for this call:

  • cs - Coordinate System controlling returned geometry coordinate information
Returns:
The Geometry or Null. If Null then the last error can be retrieved with getLastError()

Record* SBS::SWConnector::GetJoinRecords  ) 
 

Gets the next chunk of Records primed with a SetupGetJoinRecords() call.

Returns:
An array of Records or Null. If Null then the last error can be retrieved with getLastError() If the array of Records is empty then no more records exist

SBS::Error* SBS::SWConnector::GetLastError  ) 
 

Retrieve the last error or Null if no error has been recorded.

Errors are recorded and stored for each SWConnector call, if an error occurs during a call the error is cached and can be immediately retrieved using this method. If another successful call is made then this clears the error cache and the previous error is lost.

Returns:
Style record or Null. If Null then the last error can be retrieved with getLastError()

System::UInt32 SBS::SWConnector::GetNUniverses String *  dbName  ) 
 

Gets the number of defined universes for the named database.

Parameters:
dbName - The name of the required database
Returns:
The number of universes. If 0 then the last error can be retrieved with getLastError()

Record* SBS::SWConnector::GetRecord String *  dbname,
Geometry *  geom,
RetrievalContext rc
 

Gets a record which owns the passed geometry in the indicated database and uses a RetrievalContext.

Parameters:
dbName - The name of the required database
geom - The geometry of the record to be returned
rc - The RetrievalContext controlling how the record is returned
Parameters from RetrievalContext used for this call:

  • cs - Coordinate System controlling returned geometry coordinate information
  • fieldNames - The names of all fields to be returned
Returns:
The Record or Null. If Null then the last error can be retrieved with getLastError()

Record* SBS::SWConnector::GetRecord String *  dbname,
Geometry *  geom
 

Gets a record which owns the passed geometry in the indicated database.

Parameters:
dbName - The name of the required database
geom - The geometry of the record to be returned
Returns:
The Record or Null. If Null then the last error can be retrieved with getLastError()

Record* SBS::SWConnector::GetRecord String *  dbname,
String *  collName,
String *  gisKey,
RetrievalContext rc
 

Gets a record with the required key in the indicated database and collection and uses a RetrievalContext to control what is returned.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
gisKey - The key for the required record
rc - The RetrievalContext controlling how the record is returned
The gisKey field is always stored as a String and is actually all key values concatenated together with a delimiter between them, delimiters can be any of !^@?|~

For dataless rwo records the key is the gis_id value for the record delimited by the : character

Parameters from RetrievalContext used for this call:

  • cs - Coordinate System controlling returned geometry coordinate information
  • fieldNames - The names of all fields to be returned
Returns:
The Record or Null. If Null then the last error can be retrieved with getLastError()

Record* SBS::SWConnector::GetRecord String *  dbname,
String *  collName,
String *  gisKey
 

Gets a record with the required key in the indicated database and collection.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
gisKey - The key for the required record
The gisKey field is always stored as a String and is actually all key values concatenated together with a delimiter between them, delimiters can be any of !^@?|~

For dataless rwo records the key is the gis_id value for the record delimited by the : character

Returns:
The Record or Null. If Null then the last error can be retrieved with getLastError()

IEnumerator* SBS::SWConnector::GetRecordEnumerator String *  dbname,
String *  collName
 

Defines a RecordEnumerator able to iterate records from a named database and collection.

Returns:
A RecordEnumerator or Null. If Null then the last error can be retrieved with getLastError()

Record* SBS::SWConnector::GetRecords  ) 
 

Gets the next chunk of Records primed with a SetupGetRecords() call.

Returns:
An array of Records or Null. If Null then the last error can be retrieved with getLastError() If the array of Records is empty then no more records exist

Style* SBS::SWConnector::GetStyle String *  dbname,
String *  drawingApplication,
String *  rwoType,
String *  appType,
String *  styleType,
String *  scale,
System::Int32  subCode
 

Returns a Style record describing the reqiured geometry symbology.

Parameters:
dbName - The name of the required database
drawingApplication - The name of the required drawing application (style family)
rwoType - The rwo type for the required style
appType - The app type for the required style
styleType - The style type for the required style
scale - The view scale for the required style
subCode - The style subcode
Returns:
Style record or Null. If Null then the last error can be retrieved with getLastError()

World* SBS::SWConnector::GetWorld String *  dbName,
String *  collName,
String *  gisKey
 

Gets the world from the named database which is owned by the indicated record.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
gisKey - The key for the required record
See GetRecord() for more details on gisKey usage Note: It is valid for this call to return Null as the indicated record may not legally own a world or it may be undefined.

Returns:
The required world or Null. If Null then the last error can be retrieved with getLastError()

World* SBS::SWConnector::GetWorld System::String *  dbName,
System::UInt32  universeId,
System::UInt32  worldId
 

Gets the world from the named database.

Parameters:
dbName - The name of the required database
universeId - The universe id
worldId - The world id
Returns:
The required world or Null. If Null then the last error can be retrieved with getLastError()

World* SBS::SWConnector::GetWorlds System::String *  dbName,
System::UInt32  universeId
 

Gets an array of worlds from the named database for the indicated universe.

Parameters:
dbName - The name of the required database
universeId - The universe id
Returns:
An array of worlds or Null. If Null then the last error can be retrieved with getLastError()

Alternative* SBS::SWConnector::GotoAlternative System::String *  dbName,
System::String *  altName
 

Goto the indicated alternative in the named database.

Parameters:
dbName - The name of the required database
altName - The name of the required alternative
Goes to the Alternative which must exist in the database

Returns:
The Alternative or Null. If Null then the last error can be retrieved with getLastError()

System::Int32 SBS::SWConnector::InsertRecord Record *  rec,
CoordinateSystem cs,
String **  gisKey
 

Inserts the passed record and returns the gisKey for the inserted record.

Parameters:
rec - The Record to be inserted
cs - The coordinate system describing all geometry projections
gisKey - Storage for the inserted records gisKey value
Returns:
0 for OK. If non Zero then the last error can be retrieved with getLastError()

System::Int32 SBS::SWConnector::isConnected  ) 
 

Checks if self is currently connected to SW.

Returns:
One if connected, Zero if not, Negative One if the License fails.

String* SBS::SWConnector::RunUserProc String *  procName,
String *  args
 

Runs a user defined procedure and returns the results for processing.

Parameters:
procName - The name of the procedure in SW to be run
args - Arguments to the procedure
All arguments and results from this call are processed as Strings so will need to be treated appropriately in the SW and Client applications Arguments are passed in as an Array but results are returned as a single string. If multiple results are required then these are typically embedded comma delimited within the result string

Returns:
Results or Null. If Null then the last error can be retrieved with getLastError()

System::Int32 SBS::SWConnector::SetupGetGeometry String *  dbname,
String *  geomSpec,
RetrievalContext rc
 

Sets up a Geometry retrieval stream for the indicated database and geomSpec using a RetrievalContext.

Parameters:
dbName - The name of the required database
geomSpec - The geometry specification
rc - The RetrievalContext controlling how the geometry are returned
SetupGetGeometry defines a spatial scanner on the server for which geometry can be retrieved in chunks using GetGeometry().

GeomSpec indicates the geom_spec used for a SW geometry_scanner. Valid values are general, chain, area, point, text See gis_ds_view.geometry_scanner() for an exhaustive list of options

Parameters from RetrievalContext used for this call:

  • cs - Coordinate System controlling returned geometry coordinate information
  • fieldDesciptors - The fieldDescriptors for all geometry required
  • bb - The bounds for which records are to be retrieved
  • world - The world all geometry should be retrieved from
Returns:
1 for OK or Null. If Null then the last error can be retrieved with getLastError()

System::Int32 SBS::SWConnector::SetupGetJoinRecords String *  dbname,
String *  collName,
String *  gisKey,
String *  joinName,
RetrievalContext rc
 

Sets up a Record retrieval stream for joined records.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
gisKey - The name of the required collection
joinName - The name of the join field to follow
rc - The RetrievalContext controlling how the records are returned
SetupGetJoinRecords defines a record stream on the server for which records can be retrieved in chunks using GetJoinRecords().

Parameters from RetrievalContext used for this call:

  • cs - Coordinate System controlling returned geometry coordinate
Returns:
The number of records to be returned or Null. If Null then the last error can be retrieved with getLastError()

System::Int32 SBS::SWConnector::SetupGetRecords String *  dbname,
String *  collName,
RetrievalContext rc
 

Sets up a Record retrieval stream for the indicated database and collection using a RetrievalContext.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
rc - The RetrievalContext controlling how the record is returned
SetupGetRecords defines a record stream on the server for which records can be retrieved in chunks using GetRecords().

Parameters from RetrievalContext used for this call:

  • cs - Coordinate System controlling returned geometry coordinate information
  • fieldNames - The names of all fields to be returned
  • bb - The bounds for which records are to be retrieved
  • world - The world all geometry should be retrieved from
  • geomName - The geometry name used for world and bounds checking
  • predicate - A SW predicate used to filter the returned records
  • sql - A SQL style where clause used to filter the returned records
Returns:
The number of records to be returned or Null. If Null then the last error can be retrieved with getLastError()

System::Int32 SBS::SWConnector::SetupGetRecords String *  dbname,
String *  collName
 

Sets up a Record retrieval stream for the indicated database and collection.

Parameters:
dbName - The name of the required database
collName - The name of the required collection
See SetupGetRecords() with RetrievalContext for more details

Returns:
The number of records to be returned or Null. If Null then the last error can be retrieved with getLastError()

System::Int32 SBS::SWConnector::UpdateRecord Record *  rec,
CoordinateSystem cs
 

Updates the passed record.

Parameters:
rec - The Record to be updated
cs - The coordinate system describing all geometry projections
Returns:
0 for OK. If non Zero then the last error can be retrieved with getLastError()


The documentation for this class was generated from the following file:
Generated on Fri May 19 07:08:24 2006 for SWConnector by  doxygen 1.4.6-NO