OSB_LIB::Unit Class Reference

Collaboration diagram for OSB_LIB::Unit:

[legend]List of all members.

---

Detailed Description

Definition at line 63 of file osbunit.h.

Public Types

• typedef TypeId< Unit > Oid

  Type-safe object identifier.
  

• uiSeconds = 1
• uiMinutes = 2
• uiHours = 3
• uiDays = 4
• uiMonths = 5
• uiYears = 6
• uiBilledPeriod = 7
• uiBytes = 8
• uiMessages = 9
• uiMax = uiMessages
• enum UnitId {
    uiSeconds = 1, uiMinutes = 2, uiHours = 3, uiDays = 4,
    uiMonths = 5, uiYears = 6, uiBilledPeriod = 7, uiBytes = 8,
    uiMessages = 9, uiMax = uiMessages
  }

  Units supported by OSB. More...
  

Public Member Functions

• Oid oid () const

  Get object id.
  

• UnitId unitId () const

  Convert object id to `long'.
  

• const std::string & name () const

  Get name.
  

Static Public Member Functions

• static UnitId unitId (const Oid &oid)

  Convert object id to `long', class utility.
  

• static bool canConvert (const Oid &lhs, const Oid &rhs)

  Determine whether rhs can be converted to lhs.
  

• static Decimal convert (const Oid &lhs, const Oid &rhs, const Decimal &value)

  Convert a value from one unit to another.
  

Private Attributes

• Oid oid_

  Object id.
  

• std::string name_

  Name of the unit.
  

Friends

• class OSB_DB::UnitGw

---

Member Typedef Documentation

typedef TypeId<Unit> OSB_LIB::Unit::Oid

Type-safe object identifier.

Definition at line 67 of file osbunit.h.

---

Member Enumeration Documentation

enum OSB_LIB::Unit::UnitId

Units supported by OSB.

Enumerator:

uiSeconds
uiMinutes
uiHours
uiDays
uiMonths
uiYears
uiBilledPeriod
uiBytes
uiMessages
uiMax

Definition at line 71 of file osbunit.h.

---

Member Function Documentation

static bool OSB_LIB::Unit::canConvert	(	const Oid &	lhs,
		const Oid &	rhs
	)			[static]

Determine whether rhs can be converted to lhs.

static Decimal OSB_LIB::Unit::convert	(	const Oid &	lhs,
		const Oid &	rhs,
		const Decimal &	value
	)			[static]

Convert a value from one unit to another.

Parameters:

	lhs	The unit to be converted to.
	rhs	The unit of the original value to be converted.
	value	Original value to be converted.

Returns:

Converted value from the original rhs unit to the lhs unit.

Exceptions:

OsbException

if the original value cannot be converted to the new value due to incompatible unit.

const std::string& OSB_LIB::Unit::name

(

)

const

Get name.

Oid OSB_LIB::Unit::oid

(

)

const

Get object id.

UnitId OSB_LIB::Unit::unitId

(

)

const

Convert object id to `long'.

static UnitId OSB_LIB::Unit::unitId

(

const Oid &

oid

)

[static]

Convert object id to `long', class utility.

---

Friends And Related Function Documentation

friend class OSB_DB::UnitGw [friend]

Definition at line 64 of file osbunit.h.

---

Member Data Documentation

std::string OSB_LIB::Unit::name_ [private]

Name of the unit.

Definition at line 120 of file osbunit.h.

Oid OSB_LIB::Unit::oid_ [private]

Object id.

Definition at line 118 of file osbunit.h.

---

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

• osbunit.h

---