ItemFamily.h

Go to the documentation of this file.

/****************************************************************************

Copyright (c) 2008 Deepak Chandran
Contact: Deepak Chandran (dchandran1@gmail.com)
See COPYRIGHT.TXT

This is one of the main classes in Tinkercell
This file defines the ItemFamily, NodeFamily, and ConnectionFamily classes.
Each item in Tinkercell has an associated family.


****************************************************************************/

#ifndef TINKERCELL_FAMILY_H
#define TINKERCELL_FAMILY_H

#include <QColor>
#include <QPair>
#include <QList>
#include <QStringList>
#include <QHash>
#include <QUndoCommand>
#include <QGraphicsItem>

#ifndef TINKERCELLCOREEXPORT
#ifdef Q_WS_WIN
#   if defined(TC_EXPORTS) || defined(TinkerCellCore_EXPORTS)
#       define TINKERCELLCOREEXPORT __declspec(dllexport)
#   else
#       define TINKERCELLCOREEXPORT __declspec(dllimport)
#   endif
#else
#    define TINKERCELLCOREEXPORT
#endif
#endif

namespace Tinkercell
{
        class Tool;
        class TextGraphicsItem;
        class ItemHandle;
        class NodeHandle;
        class ConnectionHandle;
        class NodeGraphicsItem;
        class ArrowHeadItem;
        class ConnectionGraphicsItem;
        class NodeFamily;
        class ConnectionFamily;
        
        class TINKERCELLCOREEXPORT Unit
        {
        public:
                QString property; //e.g. "distance"
                QString name; //e.g. m in "km"
                Unit();
                Unit(const QString& property, const QString& name);
                bool operator == (const Unit&) const;
        };

        class TINKERCELLCOREEXPORT ItemFamily
        {
        public:
                QString description;
                QStringList synonyms;
                QStringList restrictions;
                QList<Unit> measurementUnitOptions;
                Unit measurementUnit;
                QHash<QString,qreal> numericalAttributes;
                QHash<QString,QString> textAttributes;
                QList<QGraphicsItem*> graphicsItems;
                QPixmap pixmap;
                virtual QString name() const;
                virtual void setName(const QString&);
                virtual bool isA(const QString& ) const;
                virtual bool isA(const ItemFamily*) const;
                virtual bool isParentOf(const QString& ) const;
                virtual bool isParentOf(const ItemFamily*) const;
                virtual ItemFamily * root() const;
                virtual bool isRelatedTo(const ItemFamily *) const;
                virtual ItemFamily* parent() const;
                virtual int depth() const;
                virtual QList<ItemFamily*> parents() const;
                virtual QList<ItemFamily*> children() const;
                virtual QList<ItemFamily*> allChildren() const;
                virtual ~ItemFamily();
                ItemFamily(const QString& name = QString());
        protected:
                int type;
                virtual bool isA(int ID) const;
                QString _name;
                int ID;
                static QStringList ALLNAMES;
                static QList<const ItemFamily*> ALLFAMILIES;
                static QHash<QString,int> NAMETOID;
                
                friend class NodeFamily;
                friend class ConnectionFamily;
        };

        class TINKERCELLCOREEXPORT NodeFamily: public ItemFamily
        {
                static int TYPE;
        public:
                static NodeFamily * cast(ItemFamily*);
                static QList<NodeFamily*> cast(const QList<ItemFamily*>&);
                virtual ItemFamily* parent() const;
                virtual QList<ItemFamily*> parents() const;
                virtual QList<ItemFamily*> children() const;
                virtual void setParent(NodeFamily*);
                virtual ~NodeFamily();
                NodeFamily(const QString& name = QString());
                virtual bool isA(const QString& ) const;
                virtual bool isA(const ItemFamily*) const;
        protected:
                virtual bool isA(int) const;
                QList<NodeFamily*> parentFamilies;
                QList<NodeFamily*> childFamilies;
                
                friend class ConnectionFamily;
        };

        class TINKERCELLCOREEXPORT ConnectionFamily: public ItemFamily
        {
                static int TYPE;
        public:
                static ConnectionFamily * cast(ItemFamily*);
                static QList<ConnectionFamily*> cast(const QList<ItemFamily*>&);
                
                virtual ItemFamily* parent() const;
                virtual QList<ItemFamily*> parents() const;
                virtual QList<ItemFamily*> children() const;
                virtual void setParent(ConnectionFamily*);
                virtual ~ConnectionFamily();
                ConnectionFamily(const QString& name = QString());
                virtual bool isA(const QString& ) const;
                virtual bool isA(const ItemFamily*) const;
                
                virtual bool addParticipant(const QString& role, const QString& family);                
                virtual QString participantFamily(const QString& role) const;
                virtual QStringList participantRoles() const;
                virtual QStringList participantTypes() const;

                virtual bool isValidSet(const QList<NodeHandle*>& nodes, bool checkFull=true);
                virtual QList<ItemFamily*> findValidChildFamilies(const QList<NodeHandle*>&, bool checkFull=true);              
                virtual int numberOfIdenticalNodesFamilies(ConnectionFamily *) const;
                virtual QStringList synonymsForRole(const QString& role) const;
        protected:
                virtual bool isA(int) const;
                static bool checkRestrictions(const QString & restriction, const QList<NodeHandle*>&, bool checkFull=true);
                QList<ConnectionFamily*> parentFamilies;
                QList<ConnectionFamily*> childFamilies;
                QList< QPair<int,int> > nodeRoles;
                static QHash<QString,int> ROLEID;
                static QStringList ALLROLENAMES;
        };

}

#endif