imoduleclump.h

Go to the documentation of this file.

#pragma once
#include "shared/interface/signal.h"
#include "base/src/farray.h"
#include "base/src/callback.h"
 
namespace itasca {
    class IContainer;
    class IEnergyMap;
}
 
namespace itascaxd {
    class IContact;
    class ICellSpace;
    class IContainerContact;
}
 
namespace pfc {
    using namespace itasca;
    using namespace itascaxd;
 
    class IClump;
    class IPebble;
    class IGhostPebble;
    class IClumpTemplate;
 
    class IModuleClump {
    public:
        using prop_signal = shared::Signal<const string &,const base::Property &>;
 
        virtual TType                    getClumpType() const=0;
        virtual TType                    getPebbleType() const=0;
        virtual TType                    getClumpTemplateType() const=0;
        virtual TType                    getGhostPebbleType() const=0;
        virtual uint32                     getClumpGeometryNotice() const=0;
        virtual uint32                     getClumpPropertyNotice() const=0;
        virtual uint32                     getClumpVelocityNotice() const=0;
        virtual uint32                     getClumpCycleNotice() const=0;
        virtual uint32                     getClumpExtraNotice() const=0;
        virtual uint32                     getClumpGroupNotice() const=0;
        virtual uint32                     getClumpCleanNotice() const=0;
        virtual uint32                     getClumpRotationNotice() const=0;
        virtual uint32                     getPebbleExtraNotice() const=0;
        virtual uint32                     getPebbleGroupNotice() const=0;
 
        virtual const IContainer       * getIContainerClump() const=0;
        virtual IContainer *             getIContainerClump()=0;
        virtual const IContainer       * getIContainerClumpTemplate() const=0;
        virtual IContainer *             getIContainerClumpTemplate()=0;
        virtual const IContainer       * getIContainerClumpTemplateClumps() const=0;
        virtual IContainer *             getIContainerClumpTemplateClumps()=0;
        virtual const IContainer       * getIContainerClumpTemplatePebbles() const=0;
        virtual IContainer *             getIContainerClumpTemplatePebbles()=0;
        virtual const IContainer       * getIContainerPebble() const=0;
        virtual IContainer *             getIContainerPebble()=0;
        virtual const IContainer       * getIContainerBasePebble() const=0;
        virtual IContainer *             getIContainerBasePebble()=0;
        virtual const IContainer       * getIContainerGhostPebble() const=0;
        virtual IContainer *             getIContainerGhostPebble()=0;
        virtual const IContainerContact *getIContainerPebblePebbleContact() const=0;
        virtual IContainerContact *      getIContainerPebblePebbleContact()=0;
        virtual const IContainerContact *getIContainerDomainPebbleContact() const=0;
        virtual IContainerContact *      getIContainerDomainPebbleContact()=0;
        virtual const ICellSpace       * getICellSpacePebble() const=0;
        virtual ICellSpace *             getICellSpacePebble()=0;
        virtual const IClump *           findClumpWithID(uint64 id) const=0;
        virtual IClump *                 findClumpWithID(uint64 id) =0;
        virtual const IClump *           findClumpClosestTo(const DVect &v,const double &radius=limits<double>::max()) const=0;
        virtual IClump *                 findClumpClosestTo(const DVect &v,const double &radius=limits<double>::max())=0;
        virtual const IClump *           findClumpContaining(const DVect &v,std::set<uint64> *skip=nullptr) const=0;
        virtual IClump *                 findClumpContaining(const DVect &v,std::set<uint64> *skip=nullptr)=0;
        virtual const IPebble *          findPebbleWithID(uint64 id) const=0;
        virtual IPebble *                findPebbleWithID(uint64 id) =0;
        virtual const IPebble *          findPebbleClosestTo(const DVect &v,const double &radius=limits<double>::max()) const=0;
        virtual IPebble *                findPebbleClosestTo(const DVect &v,const double &radius=limits<double>::max())=0;
        virtual const IPebble *          findPebbleContaining(const DVect &v,std::set<uint64> *skip=nullptr) const=0;
        virtual IPebble *                findPebbleContaining(const DVect &v,std::set<uint64> *skip=nullptr)=0;
        virtual const IClumpTemplate *   findClumpTemplateWithID(uint64 id) const=0;
        virtual IClumpTemplate *         findClumpTemplateWithID(uint64 id) =0;
        virtual const IClumpTemplate *   findClumpTemplateWithName(const QString &) const=0;
        virtual IClumpTemplate *         findClumpTemplateWithName(const QString &) =0;
        virtual const IPebble *          findClumpTemplatePebbleWithID(uint64 id) const=0;
        virtual IPebble *                findClumpTemplatePebbleWithID(uint64 id) =0;
        virtual const IGhostPebble *     findGhostPebbleWithID(uint64 id) const=0;
        virtual IGhostPebble *           findGhostPebbleWithID(uint64 id) =0;
        virtual void                     validate()=0;
        virtual const IEnergyMap       * getIClumpEnergies() const=0;
        virtual const IEnergyMap       * getIContactPebblePebbleEnergies() const=0;
 
        virtual void getClumpInBoxList(const DExtent &d,FArray<IClump *> *ret,bool intersect=true)=0;
        virtual void getClumpInBoxList(const DExtent &d,FArray<const IClump *> *ret,bool intersect=true)=0;
 
        virtual void getPebbleInBoxList(const DExtent &d,FArray<IPebble *> *ret,bool intersect=true)=0;
        virtual void getPebbleInBoxList(const DExtent &d,FArray<const IPebble *> *ret,bool intersect=true)=0;
 
        // Populates sets of property names based on their type including the relevant notices
        virtual void  populateAttributeSets(StringList *scalarAtts,FArray<uint32> *scalarNotices,StringList *stringAtts,FArray<uint32> *stringNotices,StringList *vectorAtts,FArray<uint32> *vectorNotices)const=0;
        virtual void  populatePieceAttributeSets(StringList *valueAtts,StringList *labelAtts,StringList *vectorAtts)const=0;
        virtual void  populatePropertySets(StringList *scalarProps,StringList *stringProps,StringList *vectorProps)const=0;
 
        virtual prop_signal * getPropertySignal() const = 0;
 
        virtual IClumpTemplate * createFromClump(const IClump &c,const QString &name)=0;
 
        virtual void threadedCallbackObjectClump(Callback4<void,IClump *,uint32,uint32,void *> &callback,void *v=nullptr,bool useThreads=true) const=0;
 
        template <class S,void (S::*MFP)(IClump *,uint32,uint32,void *)>
            void threadedCallbackMethodClump(S *s,void *v=nullptr,bool useThreads=true) const {
                Callback4Method<void,IClump *,uint32,uint32,void *,S,MFP> callback(s);
                threadedCallbackObjectClump(callback,v,useThreads);
            }
 
        virtual void threadedCallbackObjectPebble(Callback4<void,IPebble *,uint32,uint32,void *> &callback,void *v=nullptr,bool useThreads=true) const=0;
 
        template <class S,void (S::*MFP)(IPebble *,uint32,uint32,void *)>
            void threadedCallbackMethodPebble(S *s,void *v=nullptr,bool useThreads=true) const {
                Callback4Method<void,IPebble *,uint32,uint32,void *,S,MFP> callback(s);
                threadedCallbackObjectPebble(callback,v,useThreads);
            }
 
    };
} // namespace pfc
// EoF