Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

HBCI::Balance Class Reference

Stores all data belonging to one specific balance. More...

#include <balance.h>

List of all members.

Public Methods

 Balance ()
 ~Balance ()
void dump ()
 Dumps the data of this object to stderr.

Balance
bool isDebit () const
 Returns true if the value is a debit (i.e. positive).

void setDebit (bool c)
const Value & value () const
 Returns the value of this balance.

void setValue (const Value &v)
Date and Time
const Date & date () const
void setDate (const Date &d)
const Time & time () const
void setTime (const Time &t)


Detailed Description

Stores all data belonging to one specific balance.

This class stores the data that represent one specific balance. An account can have multiple balances according to different balancing rules.


Constructor & Destructor Documentation

HBCI::Balance::Balance (    ) 
 

Empty Constructor.

HBCI::Balance::~Balance (    ) 
 

Default Destructor.


Member Function Documentation

const Date& HBCI::Balance::date (    )  const [inline]
 

Returns the Date of this balance.

Returns the Date when this balance was valid/computed/fixed.

void HBCI::Balance::dump (    ) 
 

Dumps the data of this object to stderr.

Useful for debuggin purposes.

bool HBCI::Balance::isDebit (    )  const [inline]
 

Returns true if the value is a debit (i.e. positive).

If the value of this balance is a debit, then this method returns true. Usually this means that your account has a positive amount of money in it, i.e. the bank owes you money.

However, for some account types (which are probably not-so-common for private homebanking), in accountant-speak a "debit" can also mean that you owe money to the bank. Please take the written statements of the bank as a reference: If the bank calls your balance a "debit", then this method returns true -- so eventually the interpretation is up to you.

void HBCI::Balance::setDate (  const Date &    d )  [inline]
 

Set the Date of this balance.

Parameters:
d  The Date at which this balance is valid.

void HBCI::Balance::setDebit (  bool    c )  [inline]
 

Set whether this value is a debit (i.e. positive).

Parameters:
c  true</true> if this value is a debit.

void HBCI::Balance::setTime (  const Time &    t )  [inline]
 

Set the Time of this balance.

Parameters:
t  The Time of this balance.

void HBCI::Balance::setValue (  const Value &    v )  [inline]
 

Set the value of this balance.

Parameters:
v  The value that this balance should be set to.

const Time& HBCI::Balance::time (    )  const [inline]
 

Returns the Time of day of this balance.

const Value& HBCI::Balance::value (    )  const [inline]
 

Returns the value of this balance.


The documentation for this class was generated from the following file:
Generated on Mon Jun 23 13:41:09 2003 for openhbci by doxygen1.2.17