include/drawerNative/unitDisplayManager.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2008 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: unitDisplayManager.h,v $ $Revision: 1.3 $ $State: Exp $
*********************************************************************/


#ifndef UNITDISPLAYMANAGER_H_
#define UNITDISPLAYMANAGER_H_

#include "drawerNative/drawerNativeDefines.h"
#include "archiver/archivableObject.h"
#include "tdbutil/tdbUnits.h"               
#include "drawerNative/unitDisplay.h"

#include <QtCore/QObject>
#include <QtCore/QStringList>
#include <QtCore/QVector>
#include <QtCore/QHash>

class DtUnitConverterFactory;



typedef QHash<QString, DtUnitDisplay*> DtUnitDisplayDict;
typedef QHash<QString, double> DtGridLineChoiceMap;

class DT_DLL_drawerNative DtUnitDisplayManager : public DtArchivableObject
{
   Q_OBJECT

public:

   DtUnitDisplayManager(const DtUnitConverterFactory*);

   virtual ~DtUnitDisplayManager();

   DtUnitDisplayManager(const DtUnitDisplayManager& orig);

   virtual DtUnitDisplayManager& operator=(const DtUnitDisplayManager& rhs);

   virtual bool init();

public:
   static DtUnitDisplayManager* create(const DtUnitConverterFactory*);
   const DtUnitConverterFactory* unitConverterFactory() const;

public:
   virtual bool addUnitToDisplay(const QString& unitDisplay, const QString& unit, int precision = 3, bool addTimeUnits = false);

   virtual bool addUnitToAllDisplay(const QString& unit, int precision = 3, bool addTimeUnits = false);

   virtual void addUnitDisplay(const QString& newUnit, const QString& basedOn, const QString& externalName);

   virtual void addGridLineChoices(double start, int steps, const QString& source, const QString& title,
      const QString& convertSource, const QString& convertDestination);

public:
   virtual void addUnitDisplay(const QString& internalName, const QString& externalName,
      const QStringList& supportedUnits, const QVector<int>& defaultPrecision = QVector<int>());

   virtual void removeDisplayUnit(const QString& internalName);

   virtual QString displayingUnitsFor(const QString& displayUnit) const;

   virtual void setDisplayingUnitsFor(const QString& displayUnit, const QString& unit, bool signal = true);

   virtual int precisionFor(const QString& displayUnit, const QString& unit) const;

   virtual int precisionForDisplay(const QString& displayUnit) const;

   virtual void setPrecisionFor(const QString& displayUnit, const QString& unit, int precision, bool signal = true);

   virtual QString formatToPrecision(double val, const QString& displayUnit, const QString& unit) const;

   virtual DtUnitDisplayManager* clone() const;

   int count() const;
   virtual DtUnitDisplay unitDisplay(int) const;
   virtual QString internalName(int) const;

   virtual int displayIndexOf(const QString& internalName) const;
   virtual void setDisplayIndex(const QString& internalName, int i);


   virtual DtGridLineChoiceMap gridLineChoices(const QString&) const;
   virtual void addGridLineChoice(const QString& unit, const QString& title, double frequency);
   virtual void removeGridLineChoice(const QString& unit, const QString& title);

   virtual void restoreDefaults();

   virtual bool operator==(const DtUnitDisplayManager&) const;
   bool operator!=(const DtUnitDisplayManager&) const;

public:
   virtual QString formatSourceToDestination(double val, const QString& unitDisplay, const QString& source,
      const QString& destination) const;

   virtual QString formatSourceToDisplay(double val, const QString& unitDisplay,
      const QString& source) const;

   virtual QString formatDestinationToSource(double val, const QString& unitDisplay,
      const QString& source, const QString& destination) const;

   virtual QString formatDisplayToSource(double val, const QString& unitDisplay,
      const QString& source) const;

   virtual double convertSourceToDisplay(double val, const QString& unitDisplay, const QString& source) const;

   virtual double convertDisplayToSource(double val, const QString& unitDisplay, const QString& source) const;

   virtual double convertSourceToDestination(double val, const QString& source, const QString& destination) const;

   virtual double convertDestinationToSource(double val, const QString& source, const QString& destination) const;

signals:
   void unitDisplayChanged(const QString& unitDisplay, const QString& oldValue, const QString& newValue);

   void unitDisplayChanged(const DtUnitDisplayManager*);

public:
   virtual QString unitLabel(const QString& unitDisplay) const;

protected:
   virtual void copyDisplayUnits(const DtUnitDisplayDict&);
   virtual void cleanupUnitDisplay(DtUnitDisplayDict&);
   virtual void read(QTextStream& ts);
   virtual void write(QTextStream& ts);
   virtual void initGridLineChoices();

protected:
   const DtUnitConverterFactory*  myUnitConverterFactory;
   DtUnitDisplayDict myDisplayUnits;
   QHash<QString, DtGridLineChoiceMap> myGridLineChoices;

   DtUnitDisplayManager*   myDefaults;
};

inline const DtUnitConverterFactory* DtUnitDisplayManager::unitConverterFactory() const
{
   return myUnitConverterFactory;
}

inline bool DtUnitDisplay::operator!=(const DtUnitDisplay& rhs) const
{
   return !(*this == rhs);
}

inline bool DtUnitDisplayManager::operator!=(const DtUnitDisplayManager& rhs) const
{
   return !(*this == rhs);
}

#endif