MyMoneySecurity Class Reference

#include <mymoneysecurity.h>

Inheritance diagram for MyMoneySecurity:

Collaboration diagram for MyMoneySecurity:

[legend]

List of all members.

Public Types
enum	eSECURITYTYPE {   SECURITY_STOCK, SECURITY_MUTUALFUND, SECURITY_BOND, SECURITY_CURRENCY,   SECURITY_NONE }
Public Member Functions
	MyMoneySecurity ()
	MyMoneySecurity (const QString &id, const MyMoneySecurity &equity)
	MyMoneySecurity (const QString &id, const QString &name, const QString &symbol=QString(), const int partsPerUnit=100, const int smallestCashFraction=100, const int smallestAccountFraction=0)
	MyMoneySecurity (const QDomElement &node)
virtual	~MyMoneySecurity ()
bool	operator< (const MyMoneySecurity &) const
bool	operator== (const MyMoneySecurity &) const
bool	operator!= (const MyMoneySecurity &r) const
const QString &	name () const
void	setName (const String &str)
const QString &	tradingSymbol () const
void	setTradingSymbol (const String &str)
eSECURITYTYPE	securityType () const
void	setSecurityType (const eSECURITYTYPE &s)
bool	isCurrency (void) const
const QString &	tradingMarket () const
void	setTradingMarket (const QString &str)
const QString &	tradingCurrency (void) const
void	setTradingCurrency (const QString &str)
int	smallestAccountFraction (void) const
void	setSmallestAccountFraction (const int sf)
int	partsPerUnit (void) const
int	smallestCashFraction (void) const
void	setPartsPerUnit (const int ppu)
void	setSmallestCashFraction (const int sf)
void	writeXML (QDomDocument &document, QDomElement &parent) const
bool	hasReferenceTo (const QString &id) const
Static Public Member Functions
static QString	securityTypeToString (const MyMoneySecurity::eSECURITYTYPE securityType)
Protected Attributes
QString	m_name
QString	m_tradingSymbol
QString	m_tradingMarket
QString	m_tradingCurrency
eSECURITYTYPE	m_securityType
int	m_smallestAccountFraction
int	m_smallestCashFraction
int	m_partsPerUnit

---

Detailed Description

Class that holds all the required information about a security that the user has entered information about. A security can be a stock, a mutual fund, a bond or a currency.

Author:

Kevin Tambascio

Thomas Baumgart

---

Member Enumeration Documentation

enum MyMoneySecurity::eSECURITYTYPE

Enumerator:

SECURITY_STOCK
SECURITY_MUTUALFUND
SECURITY_BOND
SECURITY_CURRENCY
SECURITY_NONE

---

Constructor & Destructor Documentation

MyMoneySecurity::MyMoneySecurity

(

)

MyMoneySecurity::MyMoneySecurity	(	const QString &	id,
		const MyMoneySecurity &	equity
	)

MyMoneySecurity::MyMoneySecurity	(	const QString &	id,
		const QString &	name,
		const QString &	symbol = QString(),
		const int	partsPerUnit = 100,
		const int	smallestCashFraction = 100,
		const int	smallestAccountFraction = 0
	)

MyMoneySecurity::MyMoneySecurity

(

const QDomElement &

node

)

virtual MyMoneySecurity::~MyMoneySecurity

(

)

[virtual]

---

Member Function Documentation

bool MyMoneySecurity::operator<

(

const MyMoneySecurity &

)

const

bool MyMoneySecurity::operator==

(

const MyMoneySecurity &

)

const

This operator tests for equality of two MyMoneySecurity objects

bool MyMoneySecurity::operator!=

(

const MyMoneySecurity &

r

)

const [inline]

This operator tests for inequality of this MyMoneySecurity object and the one passed by r

Parameters:

r

the right side of the comparison

const QString& MyMoneySecurity::name

(

void

)

const [inline]

void MyMoneySecurity::setName

(

const String &

str

)

[inline]

const QString& MyMoneySecurity::tradingSymbol

(

)

const [inline]

void MyMoneySecurity::setTradingSymbol

(

const String &

str

)

[inline]

eSECURITYTYPE MyMoneySecurity::securityType

(

)

const [inline]

void MyMoneySecurity::setSecurityType

(

const eSECURITYTYPE &

s

)

[inline]

bool MyMoneySecurity::isCurrency

(

void

)

const [inline]

const QString& MyMoneySecurity::tradingMarket

(

)

const [inline]

void MyMoneySecurity::setTradingMarket

(

const QString &

str

)

[inline]

const QString& MyMoneySecurity::tradingCurrency

(

void

)

const [inline]

void MyMoneySecurity::setTradingCurrency

(

const QString &

str

)

[inline]

int MyMoneySecurity::smallestAccountFraction

(

void

)

const [inline]

void MyMoneySecurity::setSmallestAccountFraction

(

const int

sf

)

[inline]

int MyMoneySecurity::partsPerUnit

(

void

)

const [inline]

int MyMoneySecurity::smallestCashFraction

(

void

)

const [inline]

void MyMoneySecurity::setPartsPerUnit

(

const int

ppu

)

[inline]

void MyMoneySecurity::setSmallestCashFraction

(

const int

sf

)

[inline]

void MyMoneySecurity::writeXML	(	QDomDocument &	document,
		QDomElement &	parent
	)			const

This method creates a QDomElement for the document under the parent node parent.

Parameters:

	document	reference to QDomDocument
	parent	reference to QDomElement parent node

Reimplemented from MyMoneyKeyValueContainer.

bool MyMoneySecurity::hasReferenceTo

(

const QString &

id

)

const [virtual]

This method checks if a reference to the given object exists. It returns, a true if the object is referencing the one requested by the parameter id. If it does not, this method returns false.

Parameters:

id

id of the object to be checked for references

Return values:

	true	This object references object with id id.
	false	This object does not reference the object with id id.

Implements MyMoneyObject.

static QString MyMoneySecurity::securityTypeToString

(

const MyMoneySecurity::eSECURITYTYPE

securityType

)

[static]

This method is used to convert the internal representation of an security type into a human readable format

Parameters:

securityType

enumerated representation of the security type. For possible values, see MyMoneySecurity::eSECURITYTYPE

Returns:

QString representing the human readable form

---

Member Data Documentation

QString MyMoneySecurity::m_name [protected]

QString MyMoneySecurity::m_tradingSymbol [protected]

QString MyMoneySecurity::m_tradingMarket [protected]

QString MyMoneySecurity::m_tradingCurrency [protected]

eSECURITYTYPE MyMoneySecurity::m_securityType [protected]

int MyMoneySecurity::m_smallestAccountFraction [protected]

int MyMoneySecurity::m_smallestCashFraction [protected]

int MyMoneySecurity::m_partsPerUnit [protected]

---

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

• mymoneysecurity.h