CartoTypeCore::FindParam Class Reference

#include <cartotype_find_param.h>

Public Member Functions
	FindParam (const FindNearbyParam &aFindNearbyParam)

Public Attributes
size_t	MaxObjectCount = SIZE_MAX
Geometry	Clip
Geometry	Location
String	Layers
String	Attributes
String	Text
CartoTypeCore::StringMatchMethod	StringMatchMethod = StringMatchMethod::Exact
String	Condition
bool	Merge = false
double	TimeOut = 0.5

Detailed Description

Parameters for the general find function.

Constructor & Destructor Documentation

FindParam()

CartoTypeCore::FindParam::FindParam

(

const FindNearbyParam &

aFindNearbyParam

)

Creates find parameters from find-nearby parameters.

Member Data Documentation

Attributes

String CartoTypeCore::FindParam::Attributes

Attributes is used in text searching (if Text is non-null). If Attributes is empty, search all attributes, otherwise Attributes is a list of attributes separated by spaces or commas; use "$" to indicate the label (the unnamed attribute).

Clip

Geometry CartoTypeCore::FindParam::Clip

The clip path; no clipping is done if Clip is empty.

Condition

String CartoTypeCore::FindParam::Condition

Condition, if not empty, is a style sheet condition (e.g., "sub_type==2") which must be fulfilled by all the objects.

Layers

String CartoTypeCore::FindParam::Layers

A list of layer names separated by spaces or commas. If it is empty all layers are searched. Layer names may contain the wild cards * and ?.

Location

Geometry CartoTypeCore::FindParam::Location

The current location. If it is non-empty, objects in or near this region are preferred.

MaxObjectCount

size_t CartoTypeCore::FindParam::MaxObjectCount = SIZE_MAX

The maximum number of objects to return; default = SIZE_MAX.

Merge

bool CartoTypeCore::FindParam::Merge = false

If Merge is true adjoining objects with the same name and attributes may be merged into a single object. The default value is false.

StringMatchMethod

CartoTypeCore::StringMatchMethod CartoTypeCore::FindParam::StringMatchMethod = StringMatchMethod::Exact

The string matching method used for text searching; default = Exact.

Text

String CartoTypeCore::FindParam::Text

Text, if not empty, restricts the search to objects containing a string in one of their string attributes.

TimeOut

double CartoTypeCore::FindParam::TimeOut = 0.5

The maximum time in seconds allowed for a find operation. Find operations are not guaranteed to return in this time or less, but will attempt to do so. A timeout of zero or less means there is no timeout.

---

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

• cartotype_find_param.h
• cartotype_framework.cpp