omni::LengthUnit Class Reference

An encapsulation for length units. More...

#include <LengthUnit.h>

Public Types
enum	Type {   METER, MILLIMETER, CENTIMETER, INCH,   FOOT, NUM_UNIT_TYPES, INVALID_UNIT = -1 }
	Supported unit types. More...

Public Member Functions
	LengthUnit (Type=METER)
	Make a new unit with a certain type. More...
	LengthUnit (QString const &)
	Make a new unit from abbreviation type. More...
QString	abbreviation () const
	Return abbreviation of unit. More...
Type	type () const
	Return type of unit. More...
void	setType (Type)
	Set type of unit. More...
QString	nameSingular () const
	Return singular name of unit. More...
QString	namePlural () const
	Return plural name of unit. More...
void	fromStream (QDataStream &)
	Deserialize from stream. More...
void	toStream (QDataStream &) const
	Serialize to stream. More...

Static Public Member Functions
static QString	abbreviation (Type)
	Return abbreviation for unit with type. More...
static Type	type (QString const &abbr)
	Get unit type from abbreviation. More...
static QString	nameSingular (Type)
	Return singular name of unit with type. More...
static QString	namePlural (Type)
	Return plural name of unit with type. More...

Private Types
typedef std::map< Type, QString >	map_type

Private Attributes
Type	type_

Friends
bool	operator== (LengthUnit const &, LengthUnit const &)
	Test for equality. ScreenSetup is ignored. More...

Detailed Description

An encapsulation for length units.

Member Typedef Documentation

typedef std::map<Type, QString> omni::LengthUnit::map_type

private

Member Enumeration Documentation

enum omni::LengthUnit::Type

Supported unit types.

Enumerator
METER
MILLIMETER
CENTIMETER
INCH
FOOT
NUM_UNIT_TYPES
INVALID_UNIT

                {
        METER, MILLIMETER, CENTIMETER,
        INCH, FOOT, NUM_UNIT_TYPES,
        INVALID_UNIT = -1
      };

Constructor & Destructor Documentation

omni::LengthUnit::LengthUnit

(

Type

_type = METER

)

Make a new unit with a certain type.

                                   :
    type_(_type)
  {}

omni::LengthUnit::LengthUnit

(

QString const &

_abbr

)

Make a new unit from abbreviation type.

  {
    type_ = type(_abbr);
  }

Member Function Documentation

QString omni::LengthUnit::abbreviation ( Type  _type )

static

Return abbreviation for unit with type.

                                             {
    static map_type abbrMap_;

    if (abbrMap_.empty()) {
      abbrMap_ = map_type({
        { METER, "m" },
        { MILLIMETER, "mm" },
        { CENTIMETER, "cm" },
        { INCH, "in" },
        { FOOT, "ft" }
      });
    }

    if (abbrMap_.count(_type) == 0) {
      return "INVALID_UNIT";
    }
    return abbrMap_.at(_type);
  }

QString omni::LengthUnit::abbreviation

(

)

const

Return abbreviation of unit.

                                         {
    return abbreviation(type_);
  }

void omni::LengthUnit::fromStream

(

QDataStream &

_is

)

Deserialize from stream.

                                              {
    _is >> type_;
  }

QString omni::LengthUnit::namePlural ( Type  _type )

static

Return plural name of unit with type.

                                           {
    static map_type npMap_;

    if (npMap_.empty()) {
      npMap_ = map_type({
        { METER, "meters" },
        { MILLIMETER, "millimeters" },
        { CENTIMETER, "centimeters" },
        { INCH, "inches" },
        { FOOT, "feet" }
      });
    }

    if (npMap_.count(_type) == 0) {
      return "INVALID_UNIT";
    }
    return npMap_.at(_type);
  }

QString omni::LengthUnit::namePlural

(

)

const

Return plural name of unit.

                                       {
    return namePlural(type_);
  }

QString omni::LengthUnit::nameSingular ( Type  _type )

static

Return singular name of unit with type.

                                             {
    static map_type nsMap_;

    if (nsMap_.empty()) {
      nsMap_ = map_type({
        { METER, "meter" },
        { MILLIMETER, "millimeter" },
        { CENTIMETER, "centimeter" },
        { INCH, "inch" },
        { FOOT, "foot" }
      });
    }

    if (nsMap_.count(_type) == 0) {
      return "INVALID_UNIT";
    }
    return nsMap_.at(_type);
  }

QString omni::LengthUnit::nameSingular

(

)

const

Return singular name of unit.

                                         {
    return nameSingular(type_);
  }

void omni::LengthUnit::setType

(

Type

_type

)

Set type of unit.

                                     {
    type_ = _type;
  }

void omni::LengthUnit::toStream

(

QDataStream &

_os

)

const

Serialize to stream.

                                                  {
    _os << type_;
  }

LengthUnit::Type omni::LengthUnit::type ( QString const &  abbr )

static

Get unit type from abbreviation.

                                                     {
    static std::map<QString, Type> typeMap_;

    if (typeMap_.empty()) {
      typeMap_ = std::map<QString, Type>({
        { "m", METER },
        { "mm", MILLIMETER },
        { "cm", CENTIMETER },
        { "in", INCH },
        { "ft", FOOT }
      });
    }

    if (typeMap_.count(abbr) == 0) {
      return INVALID_UNIT;
    }
    return typeMap_.at(abbr);
  }

LengthUnit::Type omni::LengthUnit::type

(

)

const

Return type of unit.

                                        {
    return type_;
  }

Friends And Related Function Documentation

bool operator== ( LengthUnit const &  _lhs, LengthUnit const &  _rhs  )

friend

Test for equality. ScreenSetup is ignored.

                                                                  {
    return OMNI_TEST_MEMBER_EQUAL(type_);
  }

Field Documentation

Type omni::LengthUnit::type_

private

---

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

• include/omni/LengthUnit.h
• src/lib/LengthUnit.cpp