CUnitDate Class Reference

Date unit (YMD, DMY, MDY) rendering/parsing class. More...

#include <units/CUnitDate.hpp>

Public Types
enum	EUnit { YMD , DMY , MDY , 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 QString	toString (double _fdValue, CUnitTimeZone::EUnit _eUnitTimeZone, EUnit _eUnit)
	Returns the formatted represention of the given value, using the specified format/unit and decimal precision. More...
static QString	toString (double _fdValue, bool _bAlternateTimeZone=false)
	Returns the formatted represention of the given value, using the application settings. More...
static double	fromString (const QString &_rqString, CUnitTimeZone::EUnit _eUnitTimeZone, 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 CUnitDateSymbols	oUnitDateSymbols
	Container for supported human-readable format/unit symbols. More...
static const CUnitDateCodes	oUnitDateCodes
	Container for supported machine-friendly format/unit codes. More...

Detailed Description

Date unit (YMD, DMY, MDY) rendering/parsing class.

This class allows to render/parse UTC or local dates according to the various supported (and user specified) formats/units.

Author

Cedric Dufour http://cedric.dufour.name

Definition at line 38 of file CUnitDate.hpp.

Member Enumeration Documentation

EUnit

enum CUnitDate::EUnit

Format/unit ID.

Enumerator
YMD	YYYY-MM-DD.
DMY	DD-MM-YYYY.
MDY	MM-DD-YYYY.
UNDEFINED	undefined format/unit

Definition at line 47 of file CUnitDate.hpp.

Member Function Documentation

symbols()

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

static

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

Definition at line 41 of file CUnitDate.cpp.

toSymbol()

QString CUnitDate::toSymbol ( CUnitDate::EUnit  _eUnit )

static

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

Definition at line 46 of file CUnitDate.cpp.

fromSymbol()

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

static

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

Definition at line 51 of file CUnitDate.cpp.

codes()

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

static

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

Definition at line 56 of file CUnitDate.cpp.

toCode()

QString CUnitDate::toCode ( CUnitDate::EUnit  _eUnit )

static

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

Definition at line 61 of file CUnitDate.cpp.

fromCode()

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

static

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

Definition at line 66 of file CUnitDate.cpp.

toString() [1/2]

QString CUnitDate::toString ( double  _fdValue, CUnitTimeZone::EUnit  _eUnitTimeZone, CUnitDate::EUnit  _eUnit  )

static

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

Definition at line 71 of file CUnitDate.cpp.

toString() [2/2]

QString CUnitDate::toString ( double  _fdValue, bool  _bAlternateTimeZone = false  )

static

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

Definition at line 91 of file CUnitDate.cpp.

fromString() [1/2]

double CUnitDate::fromString ( const QString &  _rqString, CUnitTimeZone::EUnit  _eUnitTimeZone, 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]	_eUnitTimeZone	Timezone format/unit (if none can be automatically determined)
[out]	_pbOK	Parsing success status

Definition at line 99 of file CUnitDate.cpp.

fromString() [2/2]

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

static

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

Definition at line 139 of file CUnitDate.cpp.

Member Data Documentation

oUnitDateSymbols

const CUnitDateSymbols CUnitDate::oUnitDateSymbols

staticprivate

Container for supported human-readable format/unit symbols.

Definition at line 56 of file CUnitDate.hpp.

oUnitDateCodes

const CUnitDateCodes CUnitDate::oUnitDateCodes

staticprivate

Container for supported machine-friendly format/unit codes.

Definition at line 58 of file CUnitDate.hpp.

---

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

• units/CUnitDate.hpp
• units/CUnitDate.cpp