SBS::RetrievalContext Class Reference

Class to support Database Retrieval Context Definition. More...

List of all members.

Public Member Functions
__property String *	get_geomName ()
	Get the property geomName which holds the internal name for a required Geometry.
__property void	set_geomName (String *geomName)
	Set the property geomName.
__property BoundingBox *	get_bb ()
	Get the property bb which holds a BoundingBox indicating the extent for which data is required.
__property void	set_bb (BoundingBox *val)
	Set the property bb.
__property World *	get_world ()
	Get the property world which indicates the World for search or retrieval context.
__property void	set_world (World *val)
	Set the property world.
__property CoordinateSystem *	get_cs ()
	Get the property cs which holds a CoordinateSystem.
__property void	set_cs (CoordinateSystem *val)
	Set the property cs.
__property String *	get_fieldNames ()[]
	Get the property fieldNames which holds a list of field names which should be retrieved.
__property void	set_fieldNames (String *val[])
	Set the property fieldNames.
__property FieldDescriptor *	get_fieldDescriptors ()[]
	Get the property fieldDescriptors which holds a list of FieldDescriptors.
__property void	set_fieldDescriptors (FieldDescriptor *val[])
	Set the property fieldDescriptors.

---

Detailed Description

Class to support Database Retrieval Context Definition.

This is a sprawling class that initially looked like a good idea to minimise traffic and make it easier for callers to pass supporting information in support of other calls. However since then the number of calls using this has grown and in many cases only a limited number of RetrievalContext elements are appropriate for each call type. So expect this to change in the future to make it clearer to use and understand

---

Member Function Documentation

__property BoundingBox* SBS::RetrievalContext::get_bb (   )  [inline]

Get the property bb which holds a BoundingBox indicating the extent for which data is required. bb is used in conjunction with geomName to specify that retrieved data should have the indicated geometry interacting with the passed BoundingBox bb

__property CoordinateSystem* SBS::RetrievalContext::get_cs (   )  [inline]

Get the property cs which holds a CoordinateSystem. cs is used with the bb property to specify the CoordinateSystem for passed BoundingBox definition and also indicates the CoordinateSystem in which all returned Geometry should be delivered

__property FieldDescriptor* SBS::RetrievalContext::get_fieldDescriptors (   )  [inline]

Get the property fieldDescriptors which holds a list of FieldDescriptors. fieldDescriptors holds all FieldDescriptor objects which should be retrieved with Geometry scanner type calls i.e. SetupGetGeometry()

__property String* SBS::RetrievalContext::get_fieldNames (   )  [inline]

Get the property fieldNames which holds a list of field names which should be retrieved. fieldNames is only used for getRecord() type calls and indicates the specific list of fields for the requried record that should be returned. In all cases the default if fieldNames is empty is to return all visible and key fields for the record

__property String* SBS::RetrievalContext::get_geomName (   )  [inline]

Get the property geomName which holds the internal name for a required Geometry. geomName is used for calls where a specific geometry retrieval context is appropriate i.e. a setupGetRecords() call where only records with a specific geometry in a given bounds is required

__property World* SBS::RetrievalContext::get_world (   )  [inline]

Get the property world which indicates the World for search or retrieval context. world is used to control search bounds for geometry type scanners and indicate which geometry should be returned

---

The documentation for this class was generated from the following file:

• C:/projects/SWConnector/unshipped/SWConnector/SWConnector/RetrievalContext.h

---