PropertyBranch Class Reference

#include <PropertyBranch.h>

Inheritance diagram for PropertyBranch:

List of all members.

Public Member Functions
	PropertyBranch ()
	~PropertyBranch ()
virtual void	setParentBranch (PropertyBranchInterface *p=0)
	All methods must be thread-safe!!
virtual PropertyBranchInterface *	parentBranch ()
virtual const PropertyBranchInterface *	parentBranch () const
virtual void	setBranchName (QString name)
virtual QString	branchName () const
virtual QStringList	branchNamePath () const
virtual void	setQSettingsSubBranch (QString qsprefix=QString())
virtual QString	qSettingsSubBranch () const
virtual QString	qSettingsPath () const
virtual void	setBranchProperty (TransmittableProperty *p)
virtual TransmittableProperty *	transmittableBranchProperty () const
virtual void	forwardPropertyUpdate (TransmittablePropertyData &u)
	Forwards adequate updates and returns false for others.
virtual void	forwardConfirmationData (const TransmittablePropertyData *d) const
	Forwards confirmation-properties to the parent branch. MUST be redefined as a thread-safe method for the root branch!
virtual void	forwardNewProperty (const TransmittableProperty *p) const
	Forwards newly arisen properties to the root of the property tree.
virtual void	forwardChildProperties () const
	Forwards all child properties as new ones (called if ready made subtree gets a new parent node)
virtual QList< const TransmittableProperty * >	childProperties () const
	returns a list containing all heir properties
virtual void	addChild (PropertyBranchInterface *child)
	called by setParentBranch()!
virtual void	removeChild (PropertyBranchInterface *child)
virtual void	addProperty (TransmittableProperty *property) const
	called by TransmittableProperty
virtual void	removeProperty (TransmittableProperty *property) const
virtual void	childPropertyChanged (TransmittableProperty *p)
	Method that can be reimplemented to catch downstream changes.
Protected Member Functions
virtual void	propertyChanged (TransmittableProperty *p)
	Method that can be reimplemented to catch changes to properties.
Protected Attributes
QReadWriteLock	mtxchildren
QReadWriteLock	mtxparents
QReadWriteLock	mtxparams
QMutex	updtmutex
TransmittableProperty *	tp

---

Detailed Description

Author:

Matthias Nagl <mnagl@uni-goettingen.de>

---

Constructor & Destructor Documentation

PropertyBranch::PropertyBranch

(

)

PropertyBranch::~PropertyBranch

(

)

---

Member Function Documentation

virtual void PropertyBranch::addChild

(

PropertyBranchInterface *

child

)

[inline, virtual]

called by setParentBranch()!

Implements PropertyBranchInterface.

void PropertyBranch::addProperty

(

TransmittableProperty *

property

)

const [virtual]

called by TransmittableProperty

Implements PropertyBranchInterface.

virtual QString PropertyBranch::branchName

(

)

const [inline, virtual]

Implements PropertyBranchInterface.

QStringList PropertyBranch::branchNamePath

(

)

const [virtual]

Implements PropertyBranchInterface.

QList< const TransmittableProperty * > PropertyBranch::childProperties

(

)

const [virtual]

returns a list containing all heir properties

Implements PropertyBranchInterface.

virtual void PropertyBranch::childPropertyChanged

(

TransmittableProperty *

p

)

[inline, virtual]

Method that can be reimplemented to catch downstream changes.

Implements PropertyBranchInterface.

void PropertyBranch::forwardChildProperties

(

)

const [virtual]

Forwards all child properties as new ones (called if ready made subtree gets a new parent node)

Implements PropertyBranchInterface.

void PropertyBranch::forwardConfirmationData

(

const TransmittablePropertyData *

d

)

const [virtual]

Forwards confirmation-properties to the parent branch. MUST be redefined as a thread-safe method for the root branch!

Implements PropertyBranchInterface.

void PropertyBranch::forwardNewProperty

(

const TransmittableProperty *

p

)

const [virtual]

Forwards newly arisen properties to the root of the property tree.

Implements PropertyBranchInterface.

void PropertyBranch::forwardPropertyUpdate

(

TransmittablePropertyData &

u

)

[virtual]

Forwards adequate updates and returns false for others.

Implements PropertyBranchInterface.

virtual PropertyBranchInterface* PropertyBranch::parentBranch

(

)

[inline, virtual]

Implements PropertyBranchInterface.

virtual const PropertyBranchInterface* PropertyBranch::parentBranch

(

)

const [inline, virtual]

Implements PropertyBranchInterface.

virtual void PropertyBranch::propertyChanged

(

TransmittableProperty *

p

)

[inline, protected, virtual]

Method that can be reimplemented to catch changes to properties.

Implements PropertyBranchInterface.

QString PropertyBranch::qSettingsPath

(

)

const [virtual]

Implements PropertyBranchInterface.

virtual QString PropertyBranch::qSettingsSubBranch

(

)

const [inline, virtual]

Implements PropertyBranchInterface.

virtual void PropertyBranch::removeChild

(

PropertyBranchInterface *

child

)

[inline, virtual]

Implements PropertyBranchInterface.

void PropertyBranch::removeProperty

(

TransmittableProperty *

property

)

const [virtual]

Implements PropertyBranchInterface.

void PropertyBranch::setBranchName

(

QString

name

)

[virtual]

Implements PropertyBranchInterface.

void PropertyBranch::setBranchProperty

(

TransmittableProperty *

p

)

[virtual]

Implements PropertyBranchInterface.

void PropertyBranch::setParentBranch

(

PropertyBranchInterface *

p = 0

)

[virtual]

All methods must be thread-safe!!

Implements PropertyBranchInterface.

virtual void PropertyBranch::setQSettingsSubBranch

(

QString

qsprefix = QString()

)

[inline, virtual]

Implements PropertyBranchInterface.

TransmittableProperty * PropertyBranch::transmittableBranchProperty

(

)

const [virtual]

Implements PropertyBranchInterface.

---

Member Data Documentation

QReadWriteLock PropertyBranch::mtxchildren [mutable, protected]

QReadWriteLock PropertyBranch::mtxparams [mutable, protected]

QReadWriteLock PropertyBranch::mtxparents [mutable, protected]

TransmittableProperty* PropertyBranch::tp [mutable, protected]

QMutex PropertyBranch::updtmutex [mutable, protected]

---

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

• PropertyBranch.h
• PropertyBranch.cpp