#include <cartotype_map_data.h>
Public Member Functions | |
| CT_IMPORT TResult | Search (const TMapDataParam &aParam) |
| virtual TResult | OnSearch ()=0 |
| virtual bool | CreateCondition () |
| virtual CMapObject * | Next (TResult &aError, CMapObject *aOldMapObject=NULL)=0 |
| virtual const CMapDataLayer * | Layer () const =0 |
| const TMapDataParam & | Param () const |
| const CMapDataCondition * | Condition () const |
| int32 | HighestFirstAttributeValue () const |
Detailed Description
The context of a search in a map database. In effect, an iterator that supplies all the map objects for a certain layer, in a certain rectangle, and optionally satisfying a certain condition.
Member Function Documentation
| const CMapDataCondition* CartoType::CMapDataContext::Condition | ( | ) | const [inline] |
Return the conditions for the current search if any.
| virtual bool CartoType::CMapDataContext::CreateCondition | ( | ) | [inline, virtual] |
Return true if the framework should create the condition object iCondition, which restricts the search. If false, iCondition is created by the derived class.
| int32 CartoType::CMapDataContext::HighestFirstAttributeValue | ( | ) | const [inline] |
Return the highest desired value (according to the conditions in iCondition if any) for the first attribute of an object.
| virtual const CMapDataLayer* CartoType::CMapDataContext::Layer | ( | ) | const [pure virtual] |
Return the layer object for the current search; this gives the actual layer's name and attributes. Return NULL if no search has yet been started.
Implemented in CartoType::CShpMapDataContext, CartoType::CType1MapDataContext, and CartoType::CCloudMadeMapDataContext.
| virtual CMapObject* CartoType::CMapDataContext::Next | ( | TResult & | aError, |
| CMapObject * | aOldMapObject = NULL |
||
| ) | [pure virtual] |
Return the next object from the current search, optionally re-using aOldMapObject if it is supplied, or deleting it if it is not needed. The returned object must eventually be deleted by the caller. Return KErrorNotFound if there are no objects matching the search parameters. Return KErrorEndOfData if there are no more objects.
Implemented in CartoType::CShpMapDataContext, CartoType::CType1MapDataContext, and CartoType::CCloudMadeMapDataContext.
| virtual TResult CartoType::CMapDataContext::OnSearch | ( | ) | [pure virtual] |
Start a search using the parameters iParam. This function must be overridden by derived classes to set up the parameters for the search. It must either ensure that Layer returns a non-null value, or return an error.
Implemented in CartoType::CShpMapDataContext, CartoType::CType1MapDataContext, and CartoType::CCloudMadeMapDataContext.
| const TMapDataParam& CartoType::CMapDataContext::Param | ( | ) | const [inline] |
Return the parameters for the current search.
| CT_EXPORT TResult CMapDataContext::Search | ( | const TMapDataParam & | aParam | ) |
Start a search using the parameters in aParam.
The documentation for this class was generated from the following files:
- cartotype_map_data.h
- cartotype_map_data.cpp
