PointScannerOptions.h

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
Licensee a limited, non-exclusive, non-transferable, royalty-free license
(without the right to sublicense) to use the API solely for the purpose of
Licensee's internal development efforts to develop applications for which
the API was provided.
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Hardware
File: PointScannerOptions
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/INIInterface.h>
#include <NDEVR/PasswordString.h>
 
namespace NDEVR
{
    class POINT_SCANNER_API PointScannerOptions : public INIInterface
    {
    public:
        Resource<String> remote_connections;        
        Resource<fltp08> light_brightness;      
        Resource<fltp04> fast_speed;            
        Resource<fltp04> slow_speed;            
        Resource<fltp04> acceleration_bias_limit_movement;
        Resource<fltp04> acceleration_bias_limit_scan_ready;
        Resource<fltp04> acceleration_bias_limit_scanning;
        Resource<fltp04> acceleration_bias_limit_calibrating;
        Resource<uint02> gyro_bias_time;
        Resource<fltp04> gyro_proximity;
        Resource<String> custom_deployment_length;
        Resource<uint02> passes_per_sweep;
        Resource<Angle<sint04>> max_calibration_angle_change;
        Resource<Angle<sint04>> max_scan_angle_change;
        Resource<Angle<sint04>> scan_angle_tolerance;
        Resource<Angle<sint04>> max_drift_per_minute;
        Resource<Angle<fltp08>> smart_angle_scan_increment;
        //A weak password designed to allow advanced maintenance menus.
        Resource<PasswordString> maintenance_password;
        //Used to decode PasswordString for maintenance_password across sessions.
        static constexpr StringView maintenance_password_encode = "point_scanner_maintenance";
        Resource<String> last_successful_connection;
 
        Resource<bool> allow_camera_during_scan;
        Resource<bool> allow_camera_draping;
        Resource<bool> auto_orient_camera;
        Resource<bool> auto_record_camera;
        Resource<bool> auto_swap_cameras;
        Resource<bool> ignore_camera_connection;
 
        Resource<bool> allow_fixed_deployment;
        Resource<bool> allow_rodded_deployment;
        // This controls whether the circle scan calibration technique is used to determine probe bias. 
        // True: The scan will perform a two circle scans and then correct the probe drift at the same time that it corrects the scan itself. 
        // False: the probe drift rate is unknown.
        Resource<bool> perform_calibrated_scan;
 
        // This controls whether or not the scanner receives orientation correction during the scan.
        // True: every point sent from the scanner will have an orientation correction along with it.
        // False: the scanner will not adjust its orientation at all during the scan.Drift incurred will be the same as drift
        bool live_update_orientation = true;
 
 
 
        // This controls the algorithm used to adjust for orientation and drift during the scan. 
        // True: the probe will send out raw data directly from the gyro unit which will then be corrected software-end
        // False: the drift will be calculated on the firmware side and the probe will incur drift. 
        bool use_raw_data_scan = true;
 
        // This controls the algorithm used to adjust for orientation and drift during deployment. 
        // True: the probe will send out raw data directly from the gyro unit which will then be corrected software-end
        // False: the drift will be calculated on the firmware side and the probe will incur drift. 
        bool use_raw_data_deployment = false;
 
        bool auto_reset_digidriver = true;
 
        bool use_last_reading_average = true;
 
        Resource<bool> smart_angle_scan;
        Resource<bool> constant_range_updates;
    public:
        PointScannerOptions();
        bool isMaintenancePasswordValid() const;
        void getINI(INIFactory& factory) final override;
        void resetToDefaults();
        static PointScannerOptions& defaultOptions();
    };
}