KockpitMap Class Reference

Class for attribute mapping. More...

#include <kockpitmap.h>

Collaboration diagram for KockpitMap:

[legend]

Public Member Functions
	KockpitMap (KockpitUser *kuser, QObject *parent=0)
	Constructor.
	KockpitMap (KockpitGroup *kgrp, QObject *parent=0)
	Constructor.
	KockpitMap (const KockpitMap &kmap)
	Copy constructor.
virtual	~KockpitMap ()
	Destructor.
QListIterator< AttributeMap >	getIterator () const
	Getter.
KockpitUnit *	getKunit ()
	Getter.
virtual KockpitUser *	getKockpitUser (caller cal=APP) const
	Getter.
virtual KockpitGroup *	getKockpitGroup (caller cal=APP) const
	Getter.
virtual bool	hasAttributeMaps () const
	Check if attribute map entries exist.
Protected Attributes
QList< AttributeMap >	attrsMap
	Contains mapping information for a KockpitUser respectively a KockpitUser.
Private Attributes
KockpitUnit *	kunit
	Pointer to a KockpitUser or KockpitGroup object which is encapsulated by this object.
Friends
class	XMLMapReader
std::ostream &	operator<< (std::ostream &output, const KockpitMap &kmap)
	Output.

---

Detailed Description

Class for attribute mapping.

This class is needed to encapsulate a KockpitUser or a KockpitGroup and realize an attribute mapping using a list of AttributeMap objects.

---

Constructor & Destructor Documentation

KockpitMap::KockpitMap	(	KockpitUser *	kuser,
		QObject *	parent = 0
	)

Constructor.

Parameters:

	kuser	This pointer points to the object which attributes will be mapped.
	parent	Parent Object.

KockpitMap::KockpitMap	(	KockpitGroup *	kgrp,
		QObject *	parent = 0
	)

Constructor.

Parameters:

	kgrp	This pointer points to the object which attributes will be mapped.
	parent	Parent Object.

KockpitMap::KockpitMap

(

const KockpitMap &

kmap

)

Copy constructor.

Create a copy of an existing KockpitMap object.

Parameters:

kmap

The AttributeMap which should be cloned.

virtual KockpitMap::~KockpitMap

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

QListIterator< AttributeMap > KockpitMap::getIterator

(

)

const

Getter.

Get an iterator to iterate over attrsMap.

Returns:

QListIterator<AttributeMap> Iterator over attrsMap.

KockpitGroup * KockpitMap::getKockpitGroup

(

caller

cal = APP

)

const [virtual]

Getter.

Parameters:

cal

Who calls this function (plugin or main application). Needed because dynamic_cast ist not possible in plugins (RTTI).

Returns:

KockpitGroup* kunit

NULL Somethin went wrong or kunit points to a KockpitUser object.

KockpitUser * KockpitMap::getKockpitUser

(

caller

cal = APP

)

const [virtual]

Getter.

Parameters:

cal

Who calls this function (plugin or main application). Needed because dynamic_cast ist not possible in plugins.

Returns:

KockpitUser* kunit

NULL Something went wrong or kunit points to a KockpitGroup object.

KockpitUnit * KockpitMap::getKunit

(

)

Getter.

Returns:

KockpitUnit* kunit

bool KockpitMap::hasAttributeMaps

(

)

const [virtual]

Check if attribute map entries exist.

Returns:

true There are some attribute mappings.

false No attribute mappings are defined.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	output,
		const KockpitMap &	kmap
	)			[friend]

Output.

This function is only needed to give out the KockpitMap on STDOUT.

Parameters:

	output	Reference to stdout.
	kmap	Reference to an KockpitMap object.

friend class XMLMapReader [friend]

---

Field Documentation

QList<AttributeMap> KockpitMap::attrsMap [protected]

Contains mapping information for a KockpitUser respectively a KockpitUser.

KockpitUnit* KockpitMap::kunit [private]

Pointer to a KockpitUser or KockpitGroup object which is encapsulated by this object.

---

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

• kockpit/kockpitmap.h
• kockpit/kockpitmap.cpp