DtUnitDisplayManager Class Reference

Inheritance diagram for DtUnitDisplayManager:

Signals
void	unitDisplayChanged (const QString &unitDisplay, const QString &oldValue, const QString &newValue)
void	unitDisplayChanged (const DtUnitDisplayManager *)
	Emitted right after unitDisplayChanged(const QString&, const QString&, const QString&);.

Public Member Functions
	DtUnitDisplayManager (const DtUnitConverterFactory *)
	Default constructor.
virtual	~DtUnitDisplayManager ()
	Destructor.
	DtUnitDisplayManager (const DtUnitDisplayManager &orig)
	Copy Constructor.
virtual DtUnitDisplayManager &	operator= (const DtUnitDisplayManager &rhs)
	Assignment operator.
virtual bool	init ()
const DtUnitConverterFactory *	unitConverterFactory () const
virtual bool	addUnitToDisplay (const QString &unitDisplay, const QString &unit, int precision=3, bool addTimeUnits=false)
	Use this call to add new unit displays to an existing category.
virtual bool	addUnitToAllDisplay (const QString &unit, int precision=3, bool addTimeUnits=false)
	Adds the display unit to all categories currently known about.
virtual void	addUnitDisplay (const QString &newUnit, const QString &basedOn, const QString &externalName)
	Adds a new display unit category based on the supplied category.
virtual void	addGridLineChoices (double start, int steps, const QString &source, const QString &title, const QString &convertSource, const QString &convertDestination)
	Adds grid line choices starting at the bottom range and multiplying that range by 10 for the number of give steps.
virtual void	addUnitDisplay (const QString &internalName, const QString &externalName, const QStringList &supportedUnits, const QVector< int > &defaultPrecision=QVector< int >())
	Adds a new display item to the factory.
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)
	If signal is false, do not emit change signal.
virtual int	precisionFor (const QString &displayUnit, const QString &unit) const
virtual int	precisionForDisplay (const QString &displayUnit) const
	Calls precisionFor to get precision for currently displayed unit.
virtual void	setPrecisionFor (const QString &displayUnit, const QString &unit, int precision, bool signal=true)
	If signal is false, do not emit signal if current displayed unit is changed.
virtual QString	formatToPrecision (double val, const QString &displayUnit, const QString &unit) const
	Formats the string given the particular display unit and unit.
virtual DtUnitDisplayManager *	clone () const
	Creates a copy of this object.
int	count () const
virtual DtUnitDisplay	unitDisplay (int) const
virtual QString	internalName (int) const
virtual int	displayIndexOf (const QString &internalName) const
	Controls ordering of items for display.
virtual void	setDisplayIndex (const QString &internalName, int i)
virtual DtGridLineChoiceMap	gridLineChoices (const QString &) const
	Given a particular unit type, return grid line choices (if any)
virtual void	addGridLineChoice (const QString &unit, const QString &title, double frequency)
virtual void	removeGridLineChoice (const QString &unit, const QString &title)
virtual void	restoreDefaults ()
	Will call assignment operator on this if myDefaults is set.
virtual bool	operator== (const DtUnitDisplayManager &) const
bool	operator!= (const DtUnitDisplayManager &) const
virtual QString	formatSourceToDestination (double val, const QString &unitDisplay, const QString &source, const QString &destination) const
	Formats from the source to the destination units and returns formatted value.
virtual QString	formatSourceToDisplay (double val, const QString &unitDisplay, const QString &source) const
	Uses destination as selected by user.
virtual QString	formatDestinationToSource (double val, const QString &unitDisplay, const QString &source, const QString &destination) const
	Formats from the destination to the source.
virtual QString	formatDisplayToSource (double val, const QString &unitDisplay, const QString &source) const
	Uses destination as selected by user.
virtual double	convertSourceToDisplay (double val, const QString &unitDisplay, const QString &source) const
	Converts from the source to the destination units and returns formatted value.
virtual double	convertDisplayToSource (double val, const QString &unitDisplay, const QString &source) const
	Converts from the destination to the source.
virtual double	convertSourceToDestination (double val, const QString &source, const QString &destination) const
	Converts from the source to the destination units and returns formatted value.
virtual double	convertDestinationToSource (double val, const QString &source, const QString &destination) const
	Converts from the destination to the source.
virtual QString	unitLabel (const QString &unitDisplay) const
	Returns a label based on display category and units.
Public Member Functions inherited from DtArchivableObject
	DtArchivableObject (QString name, DtArchivableObjectCreator fcn)
	This constructor will add this object to the archivable object factory.
	DtArchivableObject (QString name)
	DtArchivableObject ()
virtual	~DtArchivableObject ()
virtual QString	name () const
DtArchiver *	archiver ()
	Returns the archiver of this object.
virtual void	setLevel (int i)
virtual int	level () const
virtual DtArchivableObject *	clone ()
	Allows for cloning of this object.

Static Public Member Functions
static DtUnitDisplayManager *	create (const DtUnitConverterFactory *)

Protected Member Functions
virtual void	copyDisplayUnits (const DtUnitDisplayDict &)
virtual void	cleanupUnitDisplay (DtUnitDisplayDict &)
virtual void	read (QTextStream &ts)
	Reads/writes archiver.
virtual void	write (QTextStream &ts)
virtual void	initGridLineChoices ()

Protected Attributes
const DtUnitConverterFactory *	myUnitConverterFactory
DtUnitDisplayDict	myDisplayUnits
QHash< QString, DtGridLineChoiceMap >	myGridLineChoices
DtUnitDisplayManager *	myDefaults
	This is only used for restoring defaults.
Protected Attributes inherited from DtArchivableObject
DtArchiver *	myArchiver

Constructor & Destructor Documentation

DtUnitDisplayManager::DtUnitDisplayManager

(

const DtUnitConverterFactory *

)

Default constructor.

virtual DtUnitDisplayManager::~DtUnitDisplayManager ( )

virtual

Destructor.

DtUnitDisplayManager::DtUnitDisplayManager

(

const DtUnitDisplayManager &

orig

)

Copy Constructor.

Member Function Documentation

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

virtual

Assignment operator.

virtual bool DtUnitDisplayManager::init ( )

virtual

static DtUnitDisplayManager* DtUnitDisplayManager::create ( const DtUnitConverterFactory *  )

static

const DtUnitConverterFactory * DtUnitDisplayManager::unitConverterFactory ( ) const

inline

References myUnitConverterFactory.

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

virtual

Use this call to add new unit displays to an existing category.

The method will return false if the unit display category does not exist. If the addTimeUnits flag is true, all existing time units (except second2) will be added via the "-per-" keyword

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

virtual

Adds the display unit to all categories currently known about.

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

virtual

Adds a new display unit category based on the supplied category.

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

virtual

Adds grid line choices starting at the bottom range and multiplying that range by 10 for the number of give steps.

Uses the source units as display source and converts to destination

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

virtual

Adds a new display item to the factory.

The internal name is used for conversions. The external name is what is displayed to the user. The string list contains all units that are valid for this display unit (internal). If display unit already exists, replaces existing

virtual void DtUnitDisplayManager::removeDisplayUnit ( const QString &  internalName )

virtual

virtual QString DtUnitDisplayManager::displayingUnitsFor ( const QString &  displayUnit ) const

virtual

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

virtual

If signal is false, do not emit change signal.

virtual int DtUnitDisplayManager::precisionFor ( const QString &  displayUnit, const QString &  unit  ) const

virtual

virtual int DtUnitDisplayManager::precisionForDisplay ( const QString &  displayUnit ) const

virtual

Calls precisionFor to get precision for currently displayed unit.

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

virtual

If signal is false, do not emit signal if current displayed unit is changed.

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

virtual

Formats the string given the particular display unit and unit.

virtual DtUnitDisplayManager* DtUnitDisplayManager::clone ( ) const

virtual

Creates a copy of this object.

int DtUnitDisplayManager::count

(

)

const

virtual DtUnitDisplay DtUnitDisplayManager::unitDisplay ( int  ) const

virtual

virtual QString DtUnitDisplayManager::internalName ( int  ) const

virtual

virtual int DtUnitDisplayManager::displayIndexOf ( const QString &  internalName ) const

virtual

Controls ordering of items for display.

virtual void DtUnitDisplayManager::setDisplayIndex ( const QString &  internalName, int  i  )

virtual

virtual DtGridLineChoiceMap DtUnitDisplayManager::gridLineChoices ( const QString &  ) const

virtual

Given a particular unit type, return grid line choices (if any)

virtual void DtUnitDisplayManager::addGridLineChoice ( const QString &  unit, const QString &  title, double  frequency  )

virtual

virtual void DtUnitDisplayManager::removeGridLineChoice ( const QString &  unit, const QString &  title  )

virtual

virtual void DtUnitDisplayManager::restoreDefaults ( )

virtual

Will call assignment operator on this if myDefaults is set.

virtual bool DtUnitDisplayManager::operator== ( const DtUnitDisplayManager &  ) const

virtual

bool DtUnitDisplayManager::operator!= ( const DtUnitDisplayManager &  rhs ) const

inline

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

virtual

Formats from the source to the destination units and returns formatted value.

Unit display is defined in unitDisplayManager.h

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

virtual

Uses destination as selected by user.

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

virtual

Formats from the destination to the source.

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

virtual

Uses destination as selected by user.

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

virtual

Converts from the source to the destination units and returns formatted value.

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

virtual

Converts from the destination to the source.

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

virtual

Converts from the source to the destination units and returns formatted value.

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

virtual

Converts from the destination to the source.

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

signal

void DtUnitDisplayManager::unitDisplayChanged ( const DtUnitDisplayManager *  )

signal

Emitted right after unitDisplayChanged(const QString&, const QString&, const QString&);.

virtual QString DtUnitDisplayManager::unitLabel ( const QString &  unitDisplay ) const

virtual

Returns a label based on display category and units.

Will query the unit converter factory for exact label

virtual void DtUnitDisplayManager::copyDisplayUnits ( const DtUnitDisplayDict &  )

protectedvirtual

virtual void DtUnitDisplayManager::cleanupUnitDisplay ( DtUnitDisplayDict &  )

protectedvirtual

virtual void DtUnitDisplayManager::read ( QTextStream &  s )

protectedvirtual

Reads/writes archiver.

Reimplemented from DtArchivableObject.

virtual void DtUnitDisplayManager::write ( QTextStream &  ts )

protectedvirtual

Reimplemented from DtArchivableObject.

virtual void DtUnitDisplayManager::initGridLineChoices ( )

protectedvirtual

Member Data Documentation

const DtUnitConverterFactory* DtUnitDisplayManager::myUnitConverterFactory

protected

Referenced by unitConverterFactory().

DtUnitDisplayDict DtUnitDisplayManager::myDisplayUnits

protected

QHash<QString, DtGridLineChoiceMap> DtUnitDisplayManager::myGridLineChoices

protected

DtUnitDisplayManager* DtUnitDisplayManager::myDefaults

protected

This is only used for restoring defaults.

It is created once during init() and again right before reading from the text stream

---

The documentation for this class was generated from the following file:

• include/drawerNative/unitDisplayManager.h