PropertyBranch.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2008 by Matthias Nagl   *
 *   mnagl@uni-goettingen.de   *
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef PropertyBranch_H
#define PropertyBranch_H

#include <PropertyBranchInterface.h>
#include <QReadWriteLock>
#include <QReadLocker>
#include <QWriteLocker>
#include <QMutex>
#include <QSet>

#if defined(PROPERTYBRANCHES_LIBRARY)
#  define PB_EXPORT Q_DECL_EXPORT
#else
#  define PB_EXPORT Q_DECL_IMPORT
#endif

class PB_EXPORT PropertyBranch : public virtual PropertyBranchInterface
{
  public:
    PropertyBranch();
    ~PropertyBranch();

    virtual void setParentBranch(PropertyBranchInterface *p = 0);
    virtual PropertyBranchInterface * parentBranch() { QReadLocker l(&mtxparents); return pp; }
    virtual const PropertyBranchInterface * parentBranch() const { QReadLocker l(&mtxparents); return pp; }
    virtual void setBranchName(QString name);
    virtual QString branchName() const { QReadLocker l(&mtxparams); return n; }
    virtual QStringList branchNamePath() const;
    virtual void setQSettingsSubBranch(QString qsprefix = QString()) { QWriteLocker l(&mtxparams); qsp = qsprefix; }
    virtual QString qSettingsSubBranch() const { QReadLocker l(&mtxparams); return qsp; }
    virtual QString qSettingsPath() const;
    virtual void setBranchProperty(TransmittableProperty *p);
    virtual TransmittableProperty * transmittableBranchProperty() const;
    virtual void forwardPropertyUpdate(TransmittablePropertyData &u);
    virtual void forwardConfirmationData(const TransmittablePropertyData *d) const;
    virtual void forwardNewProperty(const TransmittableProperty *p) const;
    virtual void forwardChildProperties() const;
    virtual QList<const TransmittableProperty*> childProperties() const;
    virtual void addChild(PropertyBranchInterface *child) { QWriteLocker l(&mtxchildren); c << child; }
    virtual void removeChild(PropertyBranchInterface *child) { QWriteLocker l(&mtxchildren); c.removeAll(child); }
    virtual void addProperty(TransmittableProperty *property) const;
    virtual void removeProperty(TransmittableProperty *property) const;
    virtual void childPropertyChanged(TransmittableProperty *p) { QReadLocker l(&mtxparents); if (pp!=0) pp->childPropertyChanged(p); }

  protected:
    virtual void propertyChanged(TransmittableProperty *p) { QReadLocker l(&mtxparents); if (pp!=0) pp->childPropertyChanged(p); }
    mutable QReadWriteLock mtxchildren, mtxparents, mtxparams;
    mutable QMutex updtmutex;
    mutable TransmittableProperty *tp;

  private:
    QString n;
    PropertyBranchInterface *pp;
    QString qsp;
    mutable bool selfmadeproperty;
    QList<PropertyBranchInterface*> c;
    mutable QList<TransmittableProperty*> props;
};

#endif