RWExchangeRateTable

Module:  Currency   Group:  Conversion

Does not inherit

• Local Index
• Synopsis
• Description
• Public Static Data Members
• Public Constructors
• Public Member Operators
• Public Member Functions
• Related Global Operators

Members

add() clear() contains() conversionFactorTag entries()

findConversionFactor() findExchangeRate() getAllExchangeRates() initialize() operator=()

remove() restoreFrom() RWExchangeRateTable() saveOn() setConversionFactor()

sourceTag targetTag

Non-Members

operator>>()

operator<<()

#include<rw/currency/exchgratetbl.h>
ifstream strm(" exchange_rates.txt");
RWExchangeRateTable rates;
rates.initialize();

Class RWExchangeRateTable stores exchange rates as unique pairs of source and target currencies. No two exchange rates in the table have the same source-target currency pair.

The RWExchangeRateTable class can be initialized from a stream, in particular, from an std::ifstream (file). The format for the stream is:

BEGIN_EXCHANGE
source=
target=
rate=
END_EXCHANGE

The following values are used for the names in the name/value pairs described in the RWExchangeRateTable::intialize() member function.

const RWCString sourceTag;
const RWCString targetTag;
const RWCstring conversionFactorTag;

RWExchangeRateTable();

Default constructor. Constructs an empty exchange rate table.

RWExchangeRateTable(const RWExchangeRateTable& t);

Copy constructor. Copies contents of t to self.

RWExchangeRateTable& 
operator=(const RWExchangeRateTable& rhs);

Assignment operator.

bool 
add(const RWExchangeRate& exchangeRate);

Adds exchangeRate to the table and returns true if there is no exchange rate in the table with the same source and target currency as exchangeRate. If the table already contains an exchange rate with the same source and target currencies as exchangeRate exists, the function returns false without adding to the table.

bool
add(const RWCString& source, const RWCString& target,
    double convFactor);

Adds an exchange rate object with the given source, target and convFactor to the table if none exists, and returns true. If the table already contains an exchange rate with the given source and target, this function returns false without adding to the table.

void
clear();

Removes all exchange rates from the table.

bool 
contains(const RWExchangeRate& rate);
bool 
contains(const RWCString& sourceMnemonic, 
         const RWCString& targetMnemonic);

Returns true if the table contains a rate for the given source and target currencies. Returns false otherwise.

size_t
entries() const;

Returns the number of exchange rates in the table.

bool 
findConversionFactor(const RWCString& sourceMnemonic, 
            RWCString targetMnemonic, double& factor);

Searches the exchange rate table to find the exchange rate for converting money with currency specified by sourceMnemonic into money in currency specified my targetMnemonic. If the rate is found, the conversion factor is placed in factor and the function returns true. If the rate is not found, the function returns false and factor is unchanged.

bool 
findExchangeRate(const RWCString& sourceMnemonic, 
                 RWCString targetMnemonic,
                 RWExchangeRate& rate);

Searches the exchange rate table to determine whether an exchange rate for the currency specified by sourceMnemonic into the currency specified by targetMnemonic exists. If an exchange rate is found, it is placed in rate and the function returns true. If an exchange rate is not found, the function returns false and rate is unchanged.

RWTValSlist<RWExchangeRate>
getAllExchangeRates()const;

Returns a list of all the exchange rates in the table.

bool
initialize(istream& strm);

Initializes an exchange rate table from the information in strm. Returns false if there is an error in the stream format.

An exchange rate specification begins with the token BEGIN_EXCHANGE on a line by itself. Each attribute of the exchange rate follows, specified as a name/value pair, one per line. The name/value separator is the equal sign `='. The end of an exchange rate specification is indicated by the token END_EXCHANGE. Comment lines start with a # character and are automatically skipped. For example:

# DZD/CAD (Algeria to Canada)
BEGIN_EXCHANGE
  source=CAD
  target=DZD
  rate=35.5
END_EXCHANGE
.
.
.

Name matching is case-insensitive. Valid names for the name/value pairs are:

source = RWExchangeRateTable::sourceTag
target = RWExchangeRateTable::targetTag
rate = RWExchangeRateTable::conversionFactorTag

bool 
remove(const RWExchangeRate& exchangeRate);
bool 
remove(const RWCString& sourceMnemonic, 
       const RWCString targetMnemonic);

Removes the exchange rate for the given source and target currencies. If no such exchange rate was found, this function returns false. Otherwise, it returns true.

void 
restoreFrom(RWFile&);

Restore from an RWFile.

void 
restoreFrom(RWvistream&);

Restore from a virtual stream.

void 
saveOn(RWvostream&) const;

Persists to a virtual stream.

void 
saveOn(RWFile&) const;

Persists to an RWFile.

bool 
setConversionFactor(const RWCString& source,
                    const RWCString& target, 
                    double convFactor);

Searches the exchange rate table for an exchange rate with the same source and target currencies as source and target. If one exists, this function replaces its conversion factor with convFactor, and returns true. If one does not exist, this function returns false.

RWvostream& 
operator<<(RWvostream& strm, const RWExchangeRateTable& r);
RWFile& 
operator<<(RWFile& file, const RWExchangeRateTable& r);

Saves the object to a virtual stream or RWFile, respectively.

RWvistream& 
operator>>(RWvistream& strm, const RWExchangeRateTable& r);
RWFile& 
operator>>(RWFile& strm, const RWExchangeRateTable& r);

Restores a object from a virtual stream or RWFile, respectively.

ostream& rwdcmlexport
operator<<(ostream& strm, const RWExchangeRateTable& t);
istream& rwdcmlexport
operator>>(istream& strm, RWExchangeRateTable& t);

Writes to and reads from strm using the format described in RWExchangeRateTable::initialize().

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.