CartoType C++ API 7.8.2, 2022-03-25
for Windows, Linux, Qt and other platforms supporting C++ development
Public Attributes | List of all members
CartoType::CFramework::TParam Class Reference

#include <cartotype_framework.h>

Public Attributes

CString iMapFileName
 
CString iStyleSheetFileName
 
std::string iStyleSheetText
 
CString iFontFileName
 
int32_t iViewWidth = 256
 
int32_t iViewHeight = 256
 
std::string iEncryptionKey
 
int32_t iFileBufferSizeInBytes = 0
 
int32_t iMaxFileBufferCount = 0
 
int32_t iTextIndexLevels = 0
 
std::shared_ptr< CFrameworkEngineiSharedEngine
 
std::shared_ptr< CFrameworkMapDataSetiSharedMapDataSet
 
bool iMapsOverlap = true
 

Detailed Description

Parameters for creating a framework when more detailed control is needed. For example, file buffer size and the maximum number of buffers can be set.

Member Data Documentation

◆ iEncryptionKey

std::string CartoType::CFramework::TParam::iEncryptionKey

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

◆ iFileBufferSizeInBytes

int32_t CartoType::CFramework::TParam::iFileBufferSizeInBytes = 0

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

◆ iFontFileName

CString CartoType::CFramework::TParam::iFontFileName

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

◆ iMapFileName

CString CartoType::CFramework::TParam::iMapFileName

The first map. Must not be empty.

◆ iMapsOverlap

bool CartoType::CFramework::TParam::iMapsOverlap = true

If true, maps are allowed to overlap. If false, maps are clipped so that they do not overlap maps previously loaded.

◆ iMaxFileBufferCount

int32_t CartoType::CFramework::TParam::iMaxFileBufferCount = 0

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

◆ iSharedEngine

std::shared_ptr<CFrameworkEngine> CartoType::CFramework::TParam::iSharedEngine

If non-null, use this shared engine and do not use iMapFileName or iFontFileName.

◆ iSharedMapDataSet

std::shared_ptr<CFrameworkMapDataSet> CartoType::CFramework::TParam::iSharedMapDataSet

If non-null, use this shared dataset and do not use iMapFileName or iFontFileName.

◆ iStyleSheetFileName

CString CartoType::CFramework::TParam::iStyleSheetFileName

The first style sheet. If this string is empty, the style sheet must be supplied in iStyleSheetText.

◆ iStyleSheetText

std::string CartoType::CFramework::TParam::iStyleSheetText

The style sheet text; used if iStyleSheetFileName is empty.

◆ iTextIndexLevels

int32_t CartoType::CFramework::TParam::iTextIndexLevels = 0

The number of levels of the text index to load into RAM. Use values from 2 to 5 to make text searches faster, at the cost of using much more RAM. The value 0 causes the default number of levels to be loaded, which is 1. The value -1 disables text index loading.

◆ iViewHeight

int32_t CartoType::CFramework::TParam::iViewHeight = 256

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

◆ iViewWidth

int32_t CartoType::CFramework::TParam::iViewWidth = 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: