CartoType .NET API 7.8.2, 2022-03-25
for development in C#, Visual Basic and other .NET languages
Public Member Functions | Public Attributes | List of all members
CartoType::FindParam Class Reference

Parameters for the general Find function. More...

#include <CartoTypeWrapper.h>

Public Member Functions

 FindParam (FindNearbyParam^ aFindNearbyParam)
 Creates a FindParam object from find-nearby parameters.
 

Public Attributes

int m_max_object_count = 0x7FFFFFFF
 The maximum number of objects to return; default = INT32_MAX.
 
Geometrym_clip = nullptr
 The clip path; no clipping is done if m_clip is null or empty.
 
Geometrym_location
 The current location. If it is non-empty, objects in or near this region are preferred. It may be a single point.
 
String ^ m_layers = nullptr
 A list of layer names separated by spaces or commas. If it is null or empty all layers are searched. Layer names may contain the wild cards * and ?.
 
String ^ m_attributes = nullptr
 Attributes used in text searching (if m_text is not empty). If m_attributes is empty, search all attributes, otherwise m_attributes is a list of attributes separated by spaces or commas; use "$" to indicate the label (the unnamed attribute).
 
String ^ m_text = nullptr
 The text to search for. Unless null or empty, restricts the search to objects containing m_text in one of their string attributes.
 
StringMatchMethod m_string_match_method = StringMatchMethod::Exact
 The string matching method used for text searching; default = StringMatchExact.
 
String ^ m_condition
 Unless null or empty, a style sheet condition (e.g., "Type==2") which must be fulfilled by all the objects.
 
bool m_merge = true
 If m_merge is true (the default), adjoining objects with the same name and attributes may be merged into a single object.
 
double m_timeout = 0.5
 

Detailed Description

Parameters for the general Find function.

Member Data Documentation

◆ m_timeout

double CartoType::FindParam::m_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.


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