CSettings.hpp

Go to the documentation of this file.

// INDENTING (emacs/vi): -*- mode:c++; tab-width:2; c-basic-offset:2; intent-tabs-mode:nil; -*- ex: set tabstop=2 expandtab:
 
/*
 * Qt Virtual Chart Table (QVCT)
 * Copyright (C) 2012 Cedric Dufour <http://cedric.dufour.name>
 * Author: Cedric Dufour <http://cedric.dufour.name>
 *
 * The Qt Virtual Chart Table (QVCT) is free software:
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation, Version 3.
 *
 * The Qt Virtual Chart Table (QVCT) is distributed in the hope
 * that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * See the GNU General Public License for more details.
 */
 
#ifndef QVCT_CSETTINGS_HPP
#define QVCT_CSETTINGS_HPP
 
// QT
#include <QColor>
#include <QDomDocument> // QtXml module
#include <QObject>
#include <QString>
#include <QXmlStreamWriter>
 
// QVCT
#include "units/CUnitBearing.hpp"
#include "units/CUnitDate.hpp"
#include "units/CUnitDistance.hpp"
#include "units/CUnitElevation.hpp"
#include "units/CUnitPosition.hpp"
#include "units/CUnitSpeed.hpp"
#include "units/CUnitSpeedVertical.hpp"
#include "units/CUnitTime.hpp"
#include "units/CUnitTimeDelta.hpp"
#include "units/CUnitTimeZone.hpp"
 
 
//  NOTE: I'd rather use a dedicated class and appropriate fields/methods,
//        along with interoperable, well-structured and hand-editable
//        XML persistency, than rely on QSettings.
class CSettings: public QObject
{
  Q_OBJECT
 
  //------------------------------------------------------------------------------
  // FIELDS
  //------------------------------------------------------------------------------
 
private:
 
  QString qsPathWorkingDirectory;
 
  //  NOTE: Symbols are images used for chart points illustration
  QString qsPathSymbolsDirectory;
 
 
  CUnitDate::EUnit eUnitDate;
 
  CUnitTime::EUnit eUnitTime;
 
  CUnitTimeDelta::EUnit eUnitTimeDelta;
 
  CUnitTimeZone::EUnit eUnitTimeZone;
 
  CUnitPosition::EUnit eUnitPosition;
 
  CUnitBearing::EUnit eUnitBearing;
 
  CUnitDistance::EUnit eUnitDistance;
 
  CUnitSpeed::EUnit eUnitSpeed;
 
  CUnitElevation::EUnit eUnitElevation;
 
  CUnitSpeedVertical::EUnit eUnitSpeedVertical;
 
 
  int iPrecisionTime;
 
  int iPrecisionTimeDelta;
 
  int iPrecisionPosition;
 
  int iPrecisionBearing;
 
  int iPrecisionDistance;
 
  int iPrecisionSpeed;
 
  int iPrecisionElevation;
 
  int iPrecisionSpeedVertical;
 
  double fdMinValuePosition;
  double fdMinValueBearing;
  double fdMinValueSpeed;
  double fdMinValueSpeedVertical;
 
  double fdMaxErrorPosition;
  double fdMaxErrorElevation;
  double fdMaxErrorTime;
  double fdMaxErrorBearing;
  double fdMaxErrorSpeed;
  double fdMaxErrorSpeedVertical;
 
  double fdMaxAgePosition;
  double fdMaxAgeElevation;
  double fdMaxAgeTime;
  double fdMaxAgeBearing;
  double fdMaxAgeSpeed;
  double fdMaxAgeSpeedVertical;
 
 
  QColor qColorPointer;
 
  QColor qColorLandmark;
 
  QColor qColorRoute;
 
  QColor qColorTrack;
 
  QColor qColorVessel;
 
  QColor qColorSelected;
 
 
  QString qsMainWindowGeometry;
 
  QString qsMainWindowState;
 
 
  int iScreenDpi;
 
  bool bScreenGestures;
 
  int iRateRefresh;
 
  int iRateRedraw;
 
  int iChartOpacity;
 
  bool bVisibleSymbols;
 
  bool bPrintHighRes;
 
 
  //------------------------------------------------------------------------------
  // CONSTRUCTORS / DESTRUCTOR
  //------------------------------------------------------------------------------
 
public:
  CSettings();
  virtual ~CSettings() {};
 
 
  //------------------------------------------------------------------------------
  // METHODS
  //------------------------------------------------------------------------------
 
  //
  // SLOTS
  //
private slots:
  void slotPathWorkingDirectory( const QString& _rqsPathWorkingDirectory );
  void slotPathSymbolsDirectory( const QString& _rqsPathSymbolsDirectory );
 
  void slotUnitDate( const QString& _rqsSymbol );
  void slotUnitTime( const QString& _rqsSymbol );
  void slotUnitTimeDelta( const QString& _rqsSymbol );
  void slotUnitTimeZone( const QString& _rqsSymbol );
  void slotUnitPosition( const QString& _rqsSymbol );
  void slotUnitBearing( const QString& _rqsSymbol );
  void slotUnitDistance( const QString& _rqsSymbol );
  void slotUnitSpeed( const QString& _rqsSymbol );
  void slotUnitElevation( const QString& _rqsSymbol );
  void slotUnitSpeedVertical( const QString& _rqsSymbol );
 
  void slotPrecisionTime( int _iPrecision ) { iPrecisionTime = _iPrecision; };
  void slotPrecisionTimeDelta( int _iPrecision ) { iPrecisionTimeDelta = _iPrecision; };
  void slotPrecisionPosition( int _iPrecision ) { iPrecisionPosition = _iPrecision; };
  void slotPrecisionBearing( int _iPrecision ) { iPrecisionBearing = _iPrecision; };
  void slotPrecisionDistance( int _iPrecision ) { iPrecisionDistance = _iPrecision; };
  void slotPrecisionSpeed( int _iPrecision ) { iPrecisionSpeed = _iPrecision; };
  void slotPrecisionElevation( int _iPrecision ) { iPrecisionElevation = _iPrecision; };
  void slotPrecisionSpeedVertical( int _iPrecision ) { iPrecisionSpeedVertical = _iPrecision; };
 
  void slotMinValuePosition( const QString& _rqsMinValue );
  void slotMinValueBearing( const QString& _rqsMinValue );
  void slotMinValueSpeed( const QString& _rqsMinValue );
  void slotMinValueSpeedVertical( const QString& _rqsMinValue );
 
  void slotMaxErrorPosition( const QString& _rqsMaxError );
  void slotMaxErrorElevation( const QString& _rqsMaxError );
  void slotMaxErrorTime( const QString& _rqsMaxError );
  void slotMaxErrorBearing( const QString& _rqsMaxError );
  void slotMaxErrorSpeed( const QString& _rqsMaxError );
  void slotMaxErrorSpeedVertical( const QString& _rqsMaxError );
 
  void slotMaxAgePosition( const QString& _rqsMaxAge );
  void slotMaxAgeElevation( const QString& _rqsMaxAge );
  void slotMaxAgeTime( const QString& _rqsMaxAge );
  void slotMaxAgeBearing( const QString& _rqsMaxAge );
  void slotMaxAgeSpeed( const QString& _rqsMaxAge );
  void slotMaxAgeSpeedVertical( const QString& _rqsMaxAge );
 
  void slotScreenDpi( int _iScreenDpi );
  void slotScreenGestures( int _iScreenGestures );
  void slotRateRefresh( int _iRateRefresh );
  void slotRateRedraw( int _iRateRedraw );
  void slotChartOpacity( int _iChartOpacity );
  void slotVisibleSymbols( int _iVisibleSymbols );
  void slotPrintHighRes( int _iPrintHighRes );
 
  //
  // SETTERS
  //
public:
  void setPathWorkingDirectory( const QString& _rqsPathWorkingDirectory ) { qsPathWorkingDirectory = _rqsPathWorkingDirectory; };
 
  void setMainWindowGeometry( const QString& _rqsMainWindowGeometry ) { qsMainWindowGeometry = _rqsMainWindowGeometry; };
  void setMainWindowState( const QString& _rqsMainWindowState ) { qsMainWindowState = _rqsMainWindowState; };
 
  //
  // GETTERS
  //
public:
  QString getPathWorkingDirectory() { return qsPathWorkingDirectory; };
  QString getPathSymbolsDirectory() { return qsPathSymbolsDirectory; };
 
  CUnitDate::EUnit getUnitDate() { return eUnitDate; };
  CUnitTime::EUnit getUnitTime() { return eUnitTime; };
  CUnitTimeDelta::EUnit getUnitTimeDelta() { return eUnitTimeDelta; };
  CUnitTimeZone::EUnit getUnitTimeZone() { return eUnitTimeZone; };
  CUnitPosition::EUnit getUnitPosition() { return eUnitPosition; };
  CUnitBearing::EUnit getUnitBearing() { return eUnitBearing; };
  CUnitDistance::EUnit getUnitDistance() { return eUnitDistance; };
  CUnitSpeed::EUnit getUnitSpeed() { return eUnitSpeed; };
  CUnitElevation::EUnit getUnitElevation() { return eUnitElevation; };
  CUnitSpeedVertical::EUnit getUnitSpeedVertical() { return eUnitSpeedVertical; };
 
  int getPrecisionTime() { return iPrecisionTime; };
  int getPrecisionTimeDelta() { return iPrecisionTimeDelta; };
  int getPrecisionPosition() { return iPrecisionPosition; };
  int getPrecisionBearing() { return iPrecisionBearing; };
  int getPrecisionDistance() { return iPrecisionDistance; };
  int getPrecisionSpeed() { return iPrecisionSpeed; };
  int getPrecisionElevation() { return iPrecisionElevation; };
  int getPrecisionSpeedVertical() { return iPrecisionSpeedVertical; };
 
  double getMinValuePosition() { return fdMinValuePosition; };
  double getMinValueBearing() { return fdMinValueBearing; };
  double getMinValueSpeed() { return fdMinValueSpeed; };
  double getMinValueSpeedVertical() { return fdMinValueSpeedVertical; };
 
  double getMaxErrorPosition() { return fdMaxErrorPosition; };
  double getMaxErrorElevation() { return fdMaxErrorElevation; };
  double getMaxErrorTime() { return fdMaxErrorTime; };
  double getMaxErrorBearing() { return fdMaxErrorBearing; };
  double getMaxErrorSpeed() { return fdMaxErrorSpeed; };
  double getMaxErrorSpeedVertical() { return fdMaxErrorSpeedVertical; };
 
  double getMaxAgePosition() { return fdMaxAgePosition; };
  double getMaxAgeElevation() { return fdMaxAgeElevation; };
  double getMaxAgeTime() { return fdMaxAgeTime; };
  double getMaxAgeBearing() { return fdMaxAgeBearing; };
  double getMaxAgeSpeed() { return fdMaxAgeSpeed; };
  double getMaxAgeSpeedVertical() { return fdMaxAgeSpeedVertical; };
 
  QColor getColorPointer() { return qColorPointer; };
  QColor getColorLandmark() { return qColorLandmark; };
  QColor getColorRoute() { return qColorRoute; };
  QColor getColorTrack() { return qColorTrack; };
  QColor getColorVessel() { return qColorVessel; };
  QColor getColorSelected() { return qColorSelected; };
 
  QString getMainWindowGeometry() { return qsMainWindowGeometry; };
  QString getMainWindowState() { return qsMainWindowState; };
  int getScreenDpi() { return iScreenDpi; };
  bool isScreenGestures() { return bScreenGestures; };
  int getRateRefresh() { return iRateRefresh; };
  int getRateRedraw() { return iRateRedraw; };
  int getChartOpacity() { return iChartOpacity; };
  bool isVisibleSymbols() { return bVisibleSymbols; };
  bool isPrintHighRes() { return bPrintHighRes; };
 
  //
  // OTHER
  //
protected:
  void validate();
 
public:
  void save( const QString& _rqsFilename ) const;
  void load( const QString& _rqsFilename );
  void dumpQVCT( QXmlStreamWriter& _rqXmlStreamWriter, bool _bProjectDump = false ) const;
  void parseQVCT( const QDomElement& _rqDomElement );
 
};
 
#endif // QVCT_CSETTINGS_HPP