#include <cartotype_framework.h>

Public Attributes
String	MapFileName

String	StyleSheetFileName

std::string	StyleSheetText

String	FontFileName

int32_t	ViewWidth = 256

int32_t	ViewHeight = 256

std::string	EncryptionKey

int32_t	FileBufferSizeInBytes = 0

int32_t	MaxFileBufferCount = 0

int32_t	TextIndexLevels = 0

std::shared_ptr< FrameworkEngine >	SharedEngine

std::shared_ptr< FrameworkMapDataSet >	SharedMapDataSet

Detailed Description

Parameters for creating a framework. The only parameter that is mandatory is MapFileName.

If both StyleSheetFileName and StyleSheetText are empty maps cannot be drawn but geocoding (finding addresses and creating addresses from points) can be performed.

Member Data Documentation

◆ EncryptionKey

std::string CartoTypeCore::Framework::Param::EncryptionKey

If not empty, an encryption key to be used when loading the first map.

◆ FileBufferSizeInBytes

int32_t CartoTypeCore::Framework::Param::FileBufferSizeInBytes = 0

The file buffer size in bytes. If it is less than four the default value is used.

◆ FontFileName

String CartoTypeCore::Framework::Param::FontFileName

The first font file. If this is empty, a small built-in font is loaded containing the Roman script only.

◆ MapFileName

String CartoTypeCore::Framework::Param::MapFileName

The map. Must not be empty.

◆ MaxFileBufferCount

int32_t CartoTypeCore::Framework::Param::MaxFileBufferCount = 0

The maximum number of file buffers. If it is zero or less the default value is used.

◆ SharedEngine

std::shared_ptr<FrameworkEngine> CartoTypeCore::Framework::Param::SharedEngine

If non-null, the framework will use this shared engine and not MapFileName or FontFileName.

◆ SharedMapDataSet

std::shared_ptr<FrameworkMapDataSet> CartoTypeCore::Framework::Param::SharedMapDataSet

If non-null, the framework will use this shared dataset and not MapFileName or FontFileName.

◆ StyleSheetFileName

String CartoTypeCore::Framework::Param::StyleSheetFileName

The style sheet file name. If this string is empty, the style sheet must be supplied in StyleSheetText.

◆ StyleSheetText

std::string CartoTypeCore::Framework::Param::StyleSheetText

The style sheet text; used if StyleSheetFileName is empty.

◆ TextIndexLevels

int32_t CartoTypeCore::Framework::Param::TextIndexLevels = 0

The number of levels of the text index to load into memory. Use values from 2 to 5 to make text searches faster, at the cost of using more RAM. The value 0 causes the default number of levels (3) to be loaded, allowing fast text searching without using too much RAM. The value -1 disables text index loading.

◆ ViewHeight

int32_t CartoTypeCore::Framework::Param::ViewHeight = 256

The height of the initial map in pixels. Must be greater than zero.

◆ ViewWidth

int32_t CartoTypeCore::Framework::Param::ViewWidth = 256

The width of the initial map in pixels. Must be greater than zero.

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

cartotype_framework.h

Public Attributes