PARP Research Group

Universidad de Murcia

---

src/qvblockprogramming/qvpropertycontainer.h Go to the documentation of this file. /* * Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012. PARP Research Group. * <http://perception.inf.um.es> * University of Murcia, Spain. * * This file is part of the QVision library. * * QVision is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as * published by the Free Software Foundation, version 3 of the License. * * QVision 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 Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with QVision. If not, see <http://www.gnu.org/licenses/>. */ #ifndef QVPROPERTYHOLDER_H #define QVPROPERTYHOLDER_H #include <QStringList> #include <QVariant> #include <QRegExp> #include <QSet> #include <QReadWriteLock> #include <QSemaphore> #include <QDebug> #include <QVPropertyContainerChange> #include <iostream> #include <QVApplication> #ifndef DOXYGEN_IGNORE_THIS class QVPropertyContainerInformer : public QObject { Q_OBJECT public: void emitChange(QVPropertyContainerChange change) { emit changed(change); } signals: void changed(QVPropertyContainerChange change); }; #endif class QVPropertyContainer { public: typedef enum {AsynchronousLink,SynchronousLink,SequentialLink} LinkType; typedef enum {noInputOutputFlag=0x0,inputFlag=0x1,outputFlag=0x2, guiInvisible=0x4, internalProp=0x8} PropertyFlag; Q_DECLARE_FLAGS(PropertyFlags, PropertyFlag) #ifndef DOXYGEN_IGNORE_THIS typedef enum {noLinkFlag=0x0,linkedInputFlag=0x1,linkedOutputFlag=0x2} PropertyLinkFlag; Q_DECLARE_FLAGS(PropertyLinkFlags, PropertyLinkFlag) #endif QVPropertyContainer(const QString name = QString()); QVPropertyContainer(const QVPropertyContainer &cont); QVPropertyContainer & operator=(const QVPropertyContainer &cont); virtual ~QVPropertyContainer(); void setName(const QString name); const QString getName() const; uint getId() const; bool operator==(const QVPropertyContainer &cont) const; QList<QString> getPropertyList() const; template <class Type> QList<QString> getPropertyListByType() const { QList<QString> result; QList<QString> names = variants.keys(); for(QList<QString>::iterator i = names.begin();i != names.end();++i) if(isType<Type>(*i)) result.append(*i); return result; } template <class Type> bool isType(QString name,bool *ok = NULL) const { if(not checkExists(name,"QVPropertyContainer::propertyIsType()")) { if(ok != NULL) *ok = FALSE; return FALSE; } if(ok != NULL) *ok = TRUE; QVariant::Type type = QVariant::fromValue(Type()).type(); if ((type != QVariant::UserType) && (variants[name].type() == type)) return TRUE; if (variants[name].userType() == QVariant::fromValue(Type()).userType()) return TRUE; return FALSE; } bool containsProperty(const QString name) const; int getPropertyType(const QString name, bool *ok = NULL) const; template <class Type> bool addProperty(const QString name, const PropertyFlags flags = inputFlag, const Type & value = Type(), const QString info = QString("(Info not available)")) { if (addPropertyFromQVariant(name, flags, QVariant::fromValue(value), info)) setPropertyFromArguments<Type>(name); else return FALSE; return TRUE; } template <class Type> bool addProperty(const QString name, const PropertyFlags flags, const Type & value, const QString info, const Type & minValue, const Type & maxValue) { if (addProperty<Type>(name, flags, value, info)) setPropertyRange<Type>(name, minValue, maxValue); else return FALSE; return TRUE; } bool addPropertyFromQVariant(const QString &name, const PropertyFlags flags, QVariant variant, const QString info) { //qDebug() << "PEO adding property" << name << "to container" << getName(); if(not checkIsNewProperty(name,"QVPropertyContainer::addProperty()")) return FALSE; insertion_order.push_back(name); //qDebug() << "PEO insertion_order after new property " << name << "->" << insertion_order; _info[name] = info; io_flags[name] = flags; link_flags[name] = noLinkFlag; variants[name] = variant; informer.emitChange(QVPropertyContainerChange(this->getName(), this->getId(), QVPropertyContainerChange::PropertyAdd, name)); return TRUE; } bool removeProperty(const QString name); /* /// \deprecated Should set range in the constructor. bool setPropertyRange(const QString name, const double & minimum, const double & maximum); bool setPropertyRange(QString name, int & minimum, int & maximum); */ bool hasRange(const QString name) const; PropertyFlags getPropertyFlags(const QString name) const { return io_flags[name]; } bool isInput(const QString name) const; bool isOutput(const QString name) const; bool isGUIInvisible(const QString name) const; bool isLinkedInput(const QString name) const; bool isLinkedOutput(const QString name) const; template <class Type> bool setPropertyValue(const QString name, const Type &value) { if(not checkExists(name,"QVPropertyContainer::setPropertyValue()")) return FALSE; else if (not correctRange(name,value)) return FALSE; else { QVariant variant = QVariant::fromValue<Type>(value); variants[name] = variant; informer.emitChange(QVPropertyContainerChange(this->getName(), this->getId(), QVPropertyContainerChange::PropertyValue, name, variant)); return TRUE; } } template <class Type> Type getPropertyValue(const QString name, bool *ok = NULL) const { if (not checkExists(name,"QVPropertyContainer::getPropertyValue()")) { if(ok != NULL) *ok = FALSE; } else { if(ok != NULL) *ok = TRUE; } return variants[name].value<Type>(); } QVariant getPropertyQVariantValue(const QString name, bool *ok = NULL) const; template <class Type> Type getPropertyMaximum(const QString name, bool *ok = NULL) const { if(not checkExists(name,"QVPropertyContainer::getPropertyMaximum()")) { if(ok != NULL) *ok = FALSE; } else if(not maximum.contains(name) and not minimum.contains(name)) { QString str = QString("QVPropertyContainer::getPropertyMaximum():") + QString(" property ") + name + QString(" has no maximum value in ") + QString("holder ") + getName() + QString("."); setLastError(str); if(qvApp->isRunning()) { std::cerr << qPrintable("Warning: " + str + "\n"); } // Otherwise, qApp will show the error and won't start the program. if(ok != NULL) *ok = FALSE; } else if(ok != NULL) *ok = TRUE; return maximum[name].value<Type>(); } template <class Type> Type getPropertyMinimum(const QString name, bool *ok = NULL) const { if(not checkExists(name,"QVPropertyContainer::getPropertyMinimum()")) { if(ok != NULL) *ok = FALSE; } else if(not maximum.contains(name) and not minimum.contains(name)) { QString str = QString("QVPropertyContainer::getPropertyMinimum():") + QString(" property ") + name + QString(" has no minimum value in ") + QString("holder ") + getName() + QString("."); setLastError(str); if(qvApp->isRunning()) { std::cerr << qPrintable("Warning: " + str + "\n"); } // Otherwise, qApp will show the error and won't start the program. if(ok != NULL) *ok = FALSE; } else if(ok != NULL) *ok = TRUE; return minimum[name].value<Type>(); } QString getPropertyInfo(const QString name, bool *ok = NULL) const; QString getLastError() const; const QString infoInputProperties() const; virtual bool linkProperty(QString sourcePropName, QVPropertyContainer *destinyContainer, QString destinyPropName, LinkType linkType = AsynchronousLink); virtual bool linkProperty(QString sourcePropName, QVPropertyContainer &destinyContainer, QString destinyPropName, LinkType linkType = AsynchronousLink); virtual bool linkProperty(QVPropertyContainer *destinyContainer, QString destinyPropName, LinkType linkType = AsynchronousLink); virtual bool linkProperty(QVPropertyContainer &destinyContainer, QString destinyPropName, LinkType linkType = AsynchronousLink); virtual bool linkProperty(QString sourcePropName, QVPropertyContainer *destinyContainer, LinkType linkType = AsynchronousLink); virtual bool linkProperty(QString sourcePropName, QVPropertyContainer &destinyContainer, LinkType linkType = AsynchronousLink); virtual void linkProperty(QVPropertyContainer *container, LinkType linkType = AsynchronousLink); virtual void linkProperty(QVPropertyContainer &container, LinkType linkType = AsynchronousLink); virtual bool unlinkProperty(QString origName, QVPropertyContainer *destCont, QString destName); virtual bool unlinkProperty(QString origName, QVPropertyContainer &destCont, QString destName); virtual void unlink(); static bool areSynchronized(const QList<QVPropertyContainer *> containers); QVPropertyContainerInformer *getInformer() { return &informer; } /* /// @brief Gets the global QVPropertyContainerInformer. static QVPropertyContainerInformer *getGlobalInformer() { return &globalInformer; } */ QVPropertyContainer *getSourceContainer(const QString name) const; QList<QVPropertyContainer *> getDestinyContainers(const QString name) const; QString getSourceProperty(const QString name) const; bool isSynchronous(const QString name) const; bool isSequential(const QString name) const; #ifndef DOXYGEN_IGNORE_THIS virtual bool linkUnspecifiedInputProperty(QVPropertyContainer *sourceContainer, QString sourcePropName, LinkType linkType = AsynchronousLink); virtual bool linkUnspecifiedOutputProperty(QVPropertyContainer *destContainer, QString destPropName, LinkType linkType = AsynchronousLink); virtual bool treatUnlinkInputProperty(QString destPropName, QVPropertyContainer *sourceCont, QString sourcePropName); #endif bool isSequentialGroupMaster() const { return master == this; } QVPropertyContainer *getMaster() const { return master; } protected: void readInputProperties(); void writeOutputProperties(); template <class Type> bool parseArgument(const QString parameter, const QString value); void setLastError(QString str) const; uint inputPropertyBlock(QString prop) const { if (inputLinks.contains(prop)) return inputLinks[prop]->qvp_orig->getId(); else return 0; } QVPropertyContainerInformer informer; // the group of slaves QVPropertyContainer, sorts by level of deep, in witch it is its master QList<QList<QVPropertyContainer *> > slavesByLevel; //protected: private: QString name; uint ident; mutable QString errorString; QMap<QString, QVariant> variants,safelyCopiedVariants; QMap<QString, QVariant> minimum, maximum; QMap<QString, QString> _info; QMap<QString, PropertyFlags> io_flags; QMap<QString, PropertyLinkFlags> link_flags; QList<QString> insertion_order; static uint maxIdent; static uint getNewIdent() { return ++maxIdent; } // static QVPropertyContainerInformer globalInformer; QReadWriteLock RWLock; class QVPropertyContainerLink { public: QVPropertyContainerLink(QVPropertyContainer *_qvp_orig,QString _prop_orig,QVPropertyContainer *_qvp_dest,QString _prop_dest,LinkType _link_type) : qvp_orig(_qvp_orig), prop_orig(_prop_orig), qvp_orig_name(_qvp_orig->getName()), qvp_orig_id(_qvp_orig->getId()), qvp_dest(_qvp_dest), prop_dest(_prop_dest), qvp_dest_name(_qvp_dest->getName()), qvp_dest_id(_qvp_dest->getId()), link_type(_link_type), markedForDeletion(FALSE) { // SyncSemaphoreIn value must initially be 1: SyncSemaphoreIn.release(); // SyncSemaphoreOut is simply initialized with 0 (default value). }; QVPropertyContainer *qvp_orig; QString prop_orig, qvp_orig_name; uint qvp_orig_id; QVPropertyContainer *qvp_dest; QString prop_dest, qvp_dest_name; uint qvp_dest_id; LinkType link_type; QSemaphore SyncSemaphoreIn,SyncSemaphoreOut; bool markedForDeletion; }; QMap<QString, QVPropertyContainerLink* > inputLinks; QMap<QString, QList<QVPropertyContainerLink*> > outputLinks; const QMap<QString, QVPropertyContainerLink* > getInputLinks() const { return inputLinks; } void addInputLink(QString prop_dest, QVPropertyContainerLink *link); void toDeleteLink(QVPropertyContainerLink* link); QVPropertyContainer *master; // the QVPropertyContainer that have been choose has his master for sequential links (if haven't sequential links itselve) int deepLevel; // the sequential links subgraph deep level, 0 for root QVPropertyContainer // process a posible sequential link, they must be done after the link process. Return false if the link will generate a sequential links cicle bool ProcessPosibleSequentialLink(QVPropertyContainer *destCont); // Update the current deep level to the maxim of origDeep and its predecessors deep level plus 1. It update its successors too void updateDeep(int origDeep); // process a sequential unlink, they must be done before the unlink process. They update the masters and deep levels void ProcessSequentialUnlink(QVPropertyContainer *origCont, QVPropertyContainer *destCont); // Indicate if they have destCont has a sequential precursor (not only a direct sequential preursor) bool haveSyncPrecursor(QVPropertyContainer *precursor); // Propagate resourcefuly a master change to his predecesors (and they propagate it to his predecesors and successors). The change must be done previously void propagateBackwardMasterChange(QVPropertyContainer *newMaster); // Propagate resourcefuly a master change to his successors (and they propagate it to his predecesors and successors). The change must be done previously void propagateForwardMasterChange(QVPropertyContainer *newMaster); // change its master void changeMaster(QVPropertyContainer *newMaster); // get the list of QVPropertyContainers that has successors of it and have been linked sequentialy QList<QVPropertyContainer *> getDestinySequentialContainers(const QString name) const; template <class Type> bool setPropertyRange(const QString name, const Type & minimum, const Type & maximum) { if(not checkExists(name,"QVPropertyContainer::setPropertyRange()")) return FALSE; if(minimum <= getPropertyValue<Type>(name) and maximum >= getPropertyValue<Type>(name)) { this->minimum[name] = QVariant::fromValue(minimum); this->maximum[name] = QVariant::fromValue(maximum); return TRUE; } else { QString str = "QVPropertyContainer::setPropertyRange(): property " + name + " in holder " + getName() + " has value " + QString("%1").arg(getPropertyValue<Type>(name)) + ", which is not valid for the range [" + QString("%1,%2").arg(minimum).arg(maximum) + "]." ; setLastError(str); if(qvApp->isRunning()) { std::cerr << qPrintable("Warning: " + str + "\n"); } // Otherwise, qApp will show the error and won't start the program. return FALSE; } } template <class Type> bool setPropertyFromArguments(QString propertyName) { QStringList arguments = qvApp->arguments(); QMutableStringListIterator iterator(arguments); while (iterator.hasNext()) { QString argument = iterator.next(); // Only if the name of the property holder is the same as defined in // the argument, in the form --name:property=value, (with name: // optional) the value will be intended to be applied to the property: if (argument.contains(QRegExp("^--"))) { QString propertyContainerName(argument), parameter(argument), value(argument); // Checks whether in the argument string there is a name for // restricting the application of the value to a variable of // a specific property holder. if (argument.contains(QRegExp("^--[^=]+:"))) { propertyContainerName.remove(QRegExp("^--")).remove(QRegExp(":.*")); if(propertyContainerName != getName()) continue; parameter.remove(QRegExp("^--[^=]+:")).remove(QRegExp("=.*$")); } else { parameter.remove(QRegExp("^--")).remove(QRegExp("=.*$")); } if(parameter != propertyName) continue; // If we get here, then we must assign the value to the property: value.remove(QRegExp("^--[^=]*=")); if(parseArgument<Type>(parameter,value)) { if(not isInput(propertyName)) { QString str = QString("QVPropertyContainer::setPropertyFromArguments():") + QString(" property ") + propertyName + QString(" in holder ") + getName() + QString(" is not of Input type, and cannot be parsed."); setLastError(str); //qApp will show the error and won't start the program. } qvApp->setArgumentAsUsed(argument); return TRUE; } } } // If we get here, then we did not parse any value for the property: return FALSE; } bool correctRange(const QString name, const double & value) const; // Any type inference ambiguity resolved with this: // 1. For int values: bool correctRange(const char *name, const int & value) const; bool correctRange(QString name, const int & value) const; // 2. Rest of types have no range, so we always return true: template <typename T> bool correctRange(const QString parameter, const T & value) { Q_UNUSED(parameter); Q_UNUSED(value); return TRUE; } bool checkExists(const QString name, const QString methodname) const; bool checkIsNewProperty(const QString name, const QString methodname) const; }; template <class Type> bool QVPropertyContainer::parseArgument(const QString parameter, const QString value) { // Float parms will be parsed just as doubles: bool ok,ok2; ok2 = isType<float>(parameter,&ok); if(ok and ok2) return parseArgument<double>(parameter, value); // Otherwise: errorString = "QVPropertyContainer::parseArgument(): holder " + getName() + ": parameter " + parameter + " has an unknown type to command line parser " + QString("(trying to parse value %1)").arg(value) ; return FALSE; } template <> bool QVPropertyContainer::parseArgument<bool>(const QString parameter, const QString value); template <> bool QVPropertyContainer::parseArgument<int>(const QString parameter, const QString value); template <> bool QVPropertyContainer::parseArgument<float>(const QString parameter, const QString value); template <> bool QVPropertyContainer::parseArgument<double>(const QString parameter, const QString value); template <> bool QVPropertyContainer::parseArgument<QString>(const QString parameter, const QString value); Q_DECLARE_OPERATORS_FOR_FLAGS(QVPropertyContainer::PropertyFlags) Q_DECLARE_OPERATORS_FOR_FLAGS(QVPropertyContainer::PropertyLinkFlags) #endif

---

QVision framework. PARP research group. Copyright © 2007, 2008, 2009, 2010, 2011.