Added kmymoney

git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/kmymoney@1239792 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 158 insertions, 0 deletions

diff --git a/kmymoney2/mymoney/mymoneyprice.h b/kmymoney2/mymoney/mymoneyprice.h
new file mode 100644
index 0000000..faf6454
--- /dev/null
+++ b/kmymoney2/mymoney/mymoneyprice.h
@@ -0,0 +1,158 @@
+/***************************************************************************
+                          mymoneyprice  -  description
+                             -------------------
+    begin                : Sun Nov 21 2004
+    copyright            : (C) 2000-2004 by Michael Edwardes
+    email                : mte@users.sourceforge.net
+                           Javier Campos Morales <javi_c@users.sourceforge.net>
+                           Felix Rodriguez <frodriguez@users.sourceforge.net>
+                           John C <thetacoturtle@users.sourceforge.net>
+                           Thomas Baumgart <ipwizard@users.sourceforge.net>
+                           Kevin Tambascio <ktambascio@users.sourceforge.net>
+ ***************************************************************************/
+
+/***************************************************************************
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ ***************************************************************************/
+
+#ifndef MYMONEYPRICE_H
+#define MYMONEYPRICE_H
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+// ----------------------------------------------------------------------------
+// QT Includes
+
+#include <qstring.h>
+#include <qdatetime.h>
+#include <qpair.h>
+#include <qmap.h>
+#include <qdom.h>
+
+// ----------------------------------------------------------------------------
+// KDE Includes
+
+// ----------------------------------------------------------------------------
+// Project Includes
+
+#include <kmymoney/mymoneymoney.h>
+#include <kmymoney/export.h>
+
+/**
+  * @author Thomas Baumgart
+  */
+
+/**
+  * This class represents an exchange rate of a security, currency or commodity
+  * based on another security, currency or commodity for a specific date.
+  * The term security is used in this class as a placeholder for all
+  * those previously mentioned items.
+  * In general, the other security is a currency.
+  *
+  * The securities and the rate form the following equation:
+  *
+  * @code
+  *
+  *   toSecurity = rate * fromSecurity
+  *
+  * @endcode
+  *
+  * Using the @p rate() member function, one can retrieve the conversion rate based
+  * upon the @p toSecurity or the @p fromSecurity.
+  */
+class KMYMONEY_EXPORT MyMoneyPrice
+{
+public:
+  MyMoneyPrice();
+  MyMoneyPrice(const QString& from, const QString& to, const QDomElement& node);
+  MyMoneyPrice(const QString& from, const QString& to, const QDate& date, const MyMoneyMoney& rate, const QString& source = QString());
+  virtual ~MyMoneyPrice();
+
+  /**
+    * This method returns the price information based on the
+    * security referenced by @p id. If @p id is empty (default), the
+    * price is returned based on the toSecurity. If this price
+    * object is invalid (see isValid()) MyMoneyMoney(1,1) is returned.
+    *
+    * @param id return price to be the factor to be used to convert a value into
+    *           the correcponding value in security @p id.
+    *
+    * @return returns the exchange rate (price) as MyMoneyMoney object.
+    *
+    * If @p id is not empty and does not match either security ids of this price
+    * an exception will be thrown.
+    *
+    * Example:
+    * Assume the following code, where you have a price object and
+    * and you wish to convert from an amount in GBP (@p valGBP) to ADF (@p valADF).
+    * Then your code will look like this:
+    *
+    * @code
+    *
+    * MyMoneyPrice price("ADF", "GBP", QDate(2005,9,20), MyMoneyMoney(1,3), "User");
+    * MyMoneyMoney valADF, valGBP(100,1);
+    *
+    * valADF = valGBP * price.rate("ADF");
+    *
+    * @endcode
+    *
+    * valADF will contain the value 300 after the assignment operation, because @p price.rate("ADF") returned
+    * @p 3/1 even though the price information kept with the object was @p 1/3, but based on the other
+    * conversion direction (from ADF to GBP).
+    */
+  const MyMoneyMoney rate(const QString& id) const;
+
+  const QDate& date(void) const { return m_date; };
+  const QString& source(void) const { return m_source; };
+  const QString& from(void) const { return m_fromSecurity; };
+  const QString& to(void) const { return m_toSecurity; };
+
+  /**
+    * Check whether the object is valid or not. A MyMoneyPrice object
+    * is valid if the date is valid and both security ids are set. In case
+    * of an invalid object, price() always returns 1.
+    *
+    * @retval true if price object is valid
+    * @retval false if price object is not valid
+    */
+  bool isValid(void) const;
+
+  // Equality operator
+  bool operator == (const MyMoneyPrice &) const;
+
+  // Inequality operator
+  bool operator != (const MyMoneyPrice &right) const { return !(operator == (right)); };
+
+  /**
+    * This method checks if a reference to the given object exists. It returns,
+    * a @p true if the object is referencing the one requested by the
+    * parameter @p id. If it does not, this method returns @p false.
+    *
+    * @param id id of the object to be checked for references
+    * @retval true This object references object with id @p id.
+    * @retval false This object does not reference the object with id @p id.
+    */
+  bool hasReferenceTo(const QString& id) const;
+
+private:
+  QString       m_fromSecurity;
+  QString       m_toSecurity;
+  QDate         m_date;
+  MyMoneyMoney  m_rate;
+  MyMoneyMoney  m_invRate;
+  QString       m_source;
+};
+
+
+typedef QPair<QString, QString> MyMoneySecurityPair;
+typedef QMap<QDate, MyMoneyPrice> MyMoneyPriceEntries;
+typedef QMap<MyMoneySecurityPair, MyMoneyPriceEntries> MyMoneyPriceList;
+
+#endif