---
title: "SystemSettings"
product: "LumiScan VGR"
component: "lumiscan-vgr"
version: "1.8.4"
display_version: "1.8.4.6"
latest_version: true
language: "en"
url: "https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/system-settings.html"
---

# SystemSettings – LumiScan VGR

(no description)

## Member Functions

- **`void exportAll(bool val)`:** == Member Variables

- **`enableHeartbeat`:** `bool`, default: `{true}` *JSON Type*: (optional) bool Enable the PLC heartbeat.

- **`enableAutomaticSetup`:** `bool`, default: `{false}` *JSON Type*: (optional) bool Enable program automatic setup at start This is old behavior of VGR that connect automatically

- **`enableFullScreen`:** `bool`, default: `{false}` If enable, the VGR will start in full screen mode. *JSON Type*: (optional) bool

- **`enableExternalAdminModeControl`:** `bool`, default: `{false}` If enable, PLC can enable/disable the Admin mode by switch value of 'IN_EnableAdminMode'. *Note*: This will disable password protection for the admin mode

[[-2]] `exportHdf5`:: `bool`, default: `{false}` *JSON Type*: (optional) bool Indicates if a camera frame has to be saved to the disk. The output folder is specified by saveFilePath.

[[-3]] `exportCenterView`:: `bool`, default: `{false}` *JSON Type*: (optional) bool Indicates if a camera center view has to be saved to the disk. The output folder is specified by saveFilePath.

[[-4]] `exportPcl`:: `bool`, default: `{false}` *JSON Type*: (optional) bool Indicates if a camera point cloud has to be saved to the disk. The output folder is specified by saveFilePath.

[[-5]] `pointcloudFiletype`:: `POINTCLOUD_FILETYPE`, default: `\{POINTCLOUD_FILETYPE::PLY\}` *JSON Type*: (optional) POINTCLOUD_FILETYPE Indicates what file format is to be used for storing and loading point cloud files

[[-6]] `saveFilePath`:: `std::filesystem::path`, default: `\{"data"\}` *JSON Type*: (optional) string Path where all generated output data will be stored.

[[-7]] `numRecordingsToKeep`:: `std::optional< int >`, default: `{100}` *JSON Type*: (optional) int +*Requirement*: Must be larger or equal to zero Number of recordings to keep in the saveFilePath folder. Keep all files if nothing is specified.

[[-8]] `loadFilePath`:: `std::filesystem::path` *JSON Type*: (optional) string Path to image and point cloud data which shall be used when sim-ulating the camera. Must be a path without filename extension. Both a centerimage (.png) and a point cloud (.ply) with the same base name must exist inorder to be load correctly.

[[-9]] `extraDatasets`:: `std::unordered_map< std::string, std::filesystem::path >`, default: `\{\}` path to simulation datasets key: dataset name, value: path to dataset *Note*: : dataset name cannot exist in both loadFilePath and extraDatasets

[[-10]] `verboseGenICamLog`:: `bool`, default: `{false}`

- **`saveFilePath`:** `std::filesystem::path`, default: `\{"data"\}` *JSON Type*: string Path where all generated output data will be stored.

- **`exportObjectDetectionText`:** `bool`, default: `{false}` *JSON Type*: bool Indicates if the 2D object detection result has to be saved to the disk as txt file. The output folder is specified by saveFilePath.

- **`exportObjectDetectionImage`:** `bool`, default: `{false}` *JSON Type*: bool Indicates if the 2D object detection result has to be saved to the disk as png file. The output folder is specified by saveFilePath.