CUnitSpeed Class Reference

Speed unit (m/s,km/h,mi/h,kt) rendering/parsing class. More...

#include <units/CUnitSpeed.hpp>

Public Types
enum	EUnit {   M_S , KM_H , MI_H , KT ,   UNDEFINED }
	Format/unit ID. More...

Static Public Member Functions
static const QMap< EUnit, QString > &	symbols ()
	Returns the list of supported human-readable format/unit symbols. More...
static QString	toSymbol (EUnit _eUnit)
	Returns the human-readable symbol corresponding to the given format/unit ID. More...
static EUnit	fromSymbol (const QString &_rqsSymbol)
	Returns the format/unit ID corresponding to the given human-readable symbol. More...
static const QMap< EUnit, QString > &	codes ()
	Returns the list of supported machine-friendly format/unit codes. More...
static QString	toCode (EUnit _eUnit)
	Returns the machine-friendly code corresponding to the given format/unit ID. More...
static EUnit	fromCode (const QString &_rqsCode)
	Returns the format/unit ID corresponding to the given machine-friendly code. More...
static double	toValue (double _fdValue, EUnit _eUnit)
	Returns the converted value, using the specified format/unit. More...
static QString	toString (double _fdValue, EUnit _eUnit, int _iPrecision=0)
	Returns the formatted represention of the given value, using the specified format/unit and decimal precision. More...
static QString	toString (double _fdValue)
	Returns the formatted represention of the given value, using the application settings. More...
static double	fromString (const QString &_rqString, EUnit _eUnit, bool *_pbOK=0)
	Returns the numeric value corresponding (parsed) from the string. More...
static double	fromString (const QString &_rqString, bool *_pbOK=0)
	Returns the numeric value corresponding (parsed) from the string, using the application settings. More...

Static Private Attributes
static const CUnitSpeedSymbols	oUnitSpeedSymbols
	Container for supported human-readable format/unit symbols. More...
static const CUnitSpeedCodes	oUnitSpeedCodes
	Container for supported machine-friendly format/unit codes. More...

Detailed Description

Speed unit (m/s,km/h,mi/h,kt) rendering/parsing class.

This class allows to render/parse speed values according to the various supported (and user specified) formats/units.

Author

Cedric Dufour http://cedric.dufour.name

Definition at line 44 of file CUnitSpeed.hpp.

Member Enumeration Documentation

EUnit

enum CUnitSpeed::EUnit

Format/unit ID.

Enumerator
M_S	meters per second [m/s]
KM_H	kilometers per hour [km/h]
MI_H	statute miles per hour [mi/h]
KT	nautical miles per hour (knots) [kt]
UNDEFINED	undefined format/unit

Definition at line 53 of file CUnitSpeed.hpp.

Member Function Documentation

symbols()

const QMap< CUnitSpeed::EUnit, QString > & CUnitSpeed::symbols ( )

static

Returns the list of supported human-readable format/unit symbols.

Definition at line 36 of file CUnitSpeed.cpp.

toSymbol()

QString CUnitSpeed::toSymbol ( CUnitSpeed::EUnit  _eUnit )

static

Returns the human-readable symbol corresponding to the given format/unit ID.

Definition at line 41 of file CUnitSpeed.cpp.

fromSymbol()

CUnitSpeed::EUnit CUnitSpeed::fromSymbol ( const QString &  _rqsSymbol )

static

Returns the format/unit ID corresponding to the given human-readable symbol.

Definition at line 46 of file CUnitSpeed.cpp.

codes()

const QMap< CUnitSpeed::EUnit, QString > & CUnitSpeed::codes ( )

static

Returns the list of supported machine-friendly format/unit codes.

Definition at line 51 of file CUnitSpeed.cpp.

toCode()

QString CUnitSpeed::toCode ( CUnitSpeed::EUnit  _eUnit )

static

Returns the machine-friendly code corresponding to the given format/unit ID.

Definition at line 56 of file CUnitSpeed.cpp.

fromCode()

CUnitSpeed::EUnit CUnitSpeed::fromCode ( const QString &  _rqsCode )

static

Returns the format/unit ID corresponding to the given machine-friendly code.

Definition at line 61 of file CUnitSpeed.cpp.

toValue()

double CUnitSpeed::toValue ( double  _fdValue, CUnitSpeed::EUnit  _eUnit  )

static

Returns the converted value, using the specified format/unit.

Definition at line 66 of file CUnitSpeed.cpp.

toString() [1/2]

QString CUnitSpeed::toString ( double  _fdValue, CUnitSpeed::EUnit  _eUnit, int  _iPrecision = 0  )

static

Returns the formatted represention of the given value, using the specified format/unit and decimal precision.

Definition at line 78 of file CUnitSpeed.cpp.

toString() [2/2]

QString CUnitSpeed::toString ( double  _fdValue )

static

Returns the formatted represention of the given value, using the application settings.

Definition at line 90 of file CUnitSpeed.cpp.

fromString() [1/2]

double CUnitSpeed::fromString ( const QString &  _rqString, EUnit  _eUnit, bool *  _pbOK = 0  )

static

Returns the numeric value corresponding (parsed) from the string.

This methods will attempt to automatically detect the used format/unit. If the format/unit can not be determined, it will default to the (optionally) specified format/unit). The success of the parsing may be retrieved using the (optionally) supplied boolean flag.

Parameters

[in]	_rqString	Formatted represention of the value
[in]	_eUnit	Default format/unit (if none can be automatically determined)
[out]	_pbOK	Parsing success status

Definition at line 96 of file CUnitSpeed.cpp.

fromString() [2/2]

double CUnitSpeed::fromString ( const QString &  _rqString, bool *  _pbOK = 0  )

static

Returns the numeric value corresponding (parsed) from the string, using the application settings.

Definition at line 118 of file CUnitSpeed.cpp.

Member Data Documentation

oUnitSpeedSymbols

const CUnitSpeedSymbols CUnitSpeed::oUnitSpeedSymbols

staticprivate

Container for supported human-readable format/unit symbols.

Definition at line 63 of file CUnitSpeed.hpp.

oUnitSpeedCodes

const CUnitSpeedCodes CUnitSpeed::oUnitSpeedCodes

staticprivate

Container for supported machine-friendly format/unit codes.

Definition at line 65 of file CUnitSpeed.hpp.

---

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

• units/CUnitSpeed.hpp
• units/CUnitSpeed.cpp