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

HBCI::Limit Class Reference

#include <limit.h>

List of all members.

Public Methods

 Limit ()
 Limit (const Value &limitValue, LimitType type, int days=0)
bool isValid () const
const Valuevalue () const
LimitType type () const
int daysForTimeLimit () const

Static Public Methods

LimitType typeFromChar (char type_char)
char typeToChar (LimitType type_enum)


Constructor & Destructor Documentation

HBCI::Limit::Limit   [inline]
 

Create a blank limit that will return <false> on calling isValid()

HBCI::Limit::Limit const Value   limitValue,
LimitType    type,
int    days = 0
 

Creates a new limit whith the specified limit data

Parameters:
limitValue  The value of the limit in currency of the account
type  Specifies the kind of limit
days  Only used if type() = LIMIT_TIME. The days between the limits.


Member Function Documentation

int HBCI::Limit::daysForTimeLimit   const [inline]
 

Returns the number of days for rotating time limits (Zeitlimit), if it is of type LIMIT_TIME (Zeitlimit). Otherwise this is zero.

bool HBCI::Limit::isValid   const
 

Returns <true> is this is a valid limit. Some banks tell us limits, some don't, for some accounts there are limits, for others not. If it is not valid, then we don't have any information about the existance of a limit.

LimitType HBCI::Limit::type   const [inline]
 

Returns the type of limit.

@note: This is *not* the one-character type representation that is used in the HBCI communication. Instead, this is only a value from the enum LimitType. If you need the HBCI-compliant type character, then put the result from here through Limit::typeToChar.

LimitType HBCI::Limit::typeFromChar char    type_char [static]
 

Returns the enum value from a HBCI compliant one-character type.

char HBCI::Limit::typeToChar LimitType    type_enum [static]
 

Returns the HBCI compliant one-character type that belongs to one particular enum value.

const Value& HBCI::Limit::value   const [inline]
 

Returns the value of the limit


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