OSB_LIB::CtBase Class Reference

Inheritance diagram for OSB_LIB::CtBase:

[legend]Collaboration diagram for OSB_LIB::CtBase:

[legend]List of all members.

---

Detailed Description

Abstract base class for ChargeTraits and TaxTraits.

Data classes holding relevant billing information for amounts or charges other than the actual value.

Definition at line 83 of file chargetraits.h.

Public Types

• typedef CmStatus CheckMask [cm_lastAttribute]
• typedef Id< CtBase > Oid

  Object id of CtBase.
  

• cm_clear
• cm_set
• cm_grey
• cm_currency
• cm_roundRule
• cm_accountCode
• cm_numberFormat
• cm_chargeType
• cm_taxkey
• cm_taxIdVs
• cm_lastAttribute
• enum CmStatus { cm_clear, cm_set, cm_grey }

  A check mask controls which attributes of a charge traits related object are available. More...
  

• enum CmAttribute {
    cm_currency, cm_roundRule, cm_accountCode, cm_numberFormat,
    cm_chargeType, cm_taxkey, cm_taxIdVs, cm_lastAttribute
  }

Public Member Functions

• CtBase (const Oid &oid=Oid())

  Constructor with object id.
  

• virtual ~CtBase ()=0

  Pure virtual destructor.
  

Read access to data members

• const Oid & oid () const
• const Currency::Oid & currency () const
• const Id< RoundRule > & roundRule () const
• const Id< Account > & accountCode () const
• std::string numberFormat () const
• CmStatus checkMask (CmAttribute a) const

Modify data members.

Attributes are not public so that the set* functions can maintain the check mask.

• void setCurrency (const Currency::Oid &)
• void setRoundRule (const Id< RoundRule > &)
• void setAccountCode (const Id< Account > &)
• void setNumberFormat (const std::string &)

Protected Member Functions

• bool match (const CtBase &rhs) const

  Compare by attributes.
  

• CtBase & operator &= (const CtBase &rhs)

  Compare two traits and set check mask.
  

Protected Attributes

• Oid oid_

  Unique object id, database link.
  

• Currency::Oid currency_

  Currency code.
  

• Id< RoundRule > roundRule_

  Rounding rule.
  

• Id< Account > accountCode_

  An account key to determine the GL account for book-keeping.
  

• std::string numberFormat_

  The print format for the amount string.
  

• CheckMask checkMask_

  A check mask field which indicates the relevant fields of a particular charge traits.
  

Friends

• class OSB_DB::ChargeTraitsGw
• class ChargeTraitsList

---

Member Typedef Documentation

typedef CmStatus OSB_LIB::CtBase::CheckMask[cm_lastAttribute]

Definition at line 99 of file chargetraits.h.

typedef Id<CtBase> OSB_LIB::CtBase::Oid

Object id of CtBase.

Definition at line 102 of file chargetraits.h.

---

Member Enumeration Documentation

enum OSB_LIB::CtBase::CmAttribute

Enumerator:

cm_currency
cm_roundRule
cm_accountCode
cm_numberFormat
cm_chargeType
cm_taxkey
cm_taxIdVs
cm_lastAttribute

Definition at line 96 of file chargetraits.h.

enum OSB_LIB::CtBase::CmStatus

A check mask controls which attributes of a charge traits related object are available.

ToDo: Do we also need a status 'required' or 'optional'?

Enumerator:

cm_clear
cm_set
cm_grey

Definition at line 95 of file chargetraits.h.

---

Constructor & Destructor Documentation

OSB_LIB::CtBase::CtBase

(

const Oid &

oid = Oid()

)

[explicit]

Constructor with object id.

virtual OSB_LIB::CtBase::~CtBase

(

)

[pure virtual]

Pure virtual destructor.

---

Member Function Documentation

const Id<Account>& OSB_LIB::CtBase::accountCode

(

)

const

CmStatus OSB_LIB::CtBase::checkMask

(

CmAttribute

a

)

const

const Currency::Oid& OSB_LIB::CtBase::currency

(

)

const

bool OSB_LIB::CtBase::match

(

const CtBase &

rhs

)

const [protected]

Compare by attributes.

Parameters:

rhs

Traits to compare with.

Returns:

true if the following members match:

• currency_
• roundRule_
• accountCode_
• numberFormat_.

std::string OSB_LIB::CtBase::numberFormat

(

)

const

const Oid& OSB_LIB::CtBase::oid

(

)

const

CtBase& OSB_LIB::CtBase::operator &=

(

const CtBase &

rhs

)

[protected]

Compare two traits and set check mask.

'Add' two CtBase by 'greying' all entries which:

• both have check mask 'set' but not the same value
• or have different check mask status.

const Id<RoundRule>& OSB_LIB::CtBase::roundRule

(

)

const

void OSB_LIB::CtBase::setAccountCode

(

const Id< Account > &

)

void OSB_LIB::CtBase::setCurrency

(

const Currency::Oid &

)

void OSB_LIB::CtBase::setNumberFormat

(

const std::string &

)

void OSB_LIB::CtBase::setRoundRule

(

const Id< RoundRule > &

)

---

Friends And Related Function Documentation

friend class ChargeTraitsList [friend]

Definition at line 90 of file chargetraits.h.

friend class OSB_DB::ChargeTraitsGw [friend]

Allow ChargeTraitsGw and ChargeTraitsList to access oid_. This is the only reason to make ChargeTraitsGw and ChargeTraitsList as a friend.

Definition at line 89 of file chargetraits.h.

---

Member Data Documentation

Id<Account> OSB_LIB::CtBase::accountCode_ [protected]

An account key to determine the GL account for book-keeping.

Definition at line 161 of file chargetraits.h.

CheckMask OSB_LIB::CtBase::checkMask_ [protected]

A check mask field which indicates the relevant fields of a particular charge traits.

Definition at line 168 of file chargetraits.h.

Currency::Oid OSB_LIB::CtBase::currency_ [protected]

Currency code.

Definition at line 157 of file chargetraits.h.

std::string OSB_LIB::CtBase::numberFormat_ [protected]

The print format for the amount string.

Definition at line 163 of file chargetraits.h.

Oid OSB_LIB::CtBase::oid_ [protected]

Unique object id, database link.

Definition at line 155 of file chargetraits.h.

Id<RoundRule> OSB_LIB::CtBase::roundRule_ [protected]

Rounding rule.

Definition at line 159 of file chargetraits.h.

---

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

• chargetraits.h

---