Itasca C++ Interface
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Types | Public Member Functions | List of all members
pfc::IModuleClump Class Referenceabstract

Interface for the Clump module. This is the interface for the Clump module. More...

#include <imoduleclump.h>

Public Types

typedef Signal2< const QString &, const QVariant & > prop_signal
 Signal emitted when a property is created or modified.
 

Public Member Functions

virtual TType getClumpType () const =0
 Clump TType for type casting.
 
virtual TType getPebbleType () const =0
 Pebble TType for type casting.
 
virtual TType getClumpTemplateType () const =0
 ClumpTemplate TType for type casting.
 
virtual TType getGhostPebbleType () const =0
 GhostPebble TType for type casting.
 
virtual uint getClumpGeometryNotice () const =0
 Clump geometry notice unsigned integer.
 
virtual uint getClumpPropertyNotice () const =0
 Clump property notice unsigned integer.
 
virtual uint getClumpVelocityNotice () const =0
 Clump velocity notice unsigned integer.
 
virtual uint getClumpCycleNotice () const =0
 Clump cycle notice unsigned integer.
 
virtual uint getClumpExtraNotice () const =0
 Clump extra notice unsigned integer.
 
virtual uint getClumpGroupNotice () const =0
 Clump group notice unsigned integer.
 
virtual uint getClumpCleanNotice () const =0
 Clump clean notice unsigned integer.
 
virtual uint getClumpRotationNotice () const =0
 Clump rotation notice unsigned integer.
 
virtual uint getPebbleExtraNotice () const =0
 Pebble extra velocity notice unsigned integer.
 
virtual uint getPebbleGroupNotice () const =0
 Pebble group notice unsigned integer.
 
virtual const IContainergetIContainerClump () const =0
 const access to the Clump container
 
virtual IContainergetIContainerClump ()=0
 access to the Clump container
 
virtual const IContainergetIContainerClumpTemplate () const =0
 const access to the ClumpTemplate container
 
virtual IContainergetIContainerClumpTemplate ()=0
 access to the ClumpTemplate container
 
virtual const IContainergetIContainerClumpTemplateClumps () const =0
 
virtual IContainergetIContainerClumpTemplateClumps ()=0
 
virtual const IContainergetIContainerClumpTemplatePebbles () const =0
 
virtual IContainergetIContainerClumpTemplatePebbles ()=0
 
virtual const IContainergetIContainerPebble () const =0
 
virtual IContainergetIContainerPebble ()=0
 
virtual const IContainergetIContainerBasePebble () const =0
 
virtual IContainergetIContainerBasePebble ()=0
 
virtual const IContainergetIContainerGhostPebble () const =0
 
virtual IContainergetIContainerGhostPebble ()=0
 
virtual const IContainerContactgetIContainerPebblePebbleContact () const =0
 
virtual IContainerContactgetIContainerPebblePebbleContact ()=0
 
virtual const IContainerContactgetIContainerDomainPebbleContact () const =0
 
virtual IContainerContactgetIContainerDomainPebbleContact ()=0
 
virtual const ICellSpacegetICellSpacePebble () const =0
 
virtual ICellSpacegetICellSpacePebble ()=0
 
virtual const IClumpfindClumpWithID (quint64 id) const =0
 
virtual IClumpfindClumpWithID (quint64 id)=0
 
virtual const IClumpfindClumpClosestTo (const DVect &v, const double &radius=limits< double >::max()) const =0
 
virtual IClumpfindClumpClosestTo (const DVect &v, const double &radius=limits< double >::max())=0
 
virtual const IClumpfindClumpContaining (const DVect &v, QSet< quint64 > *skip=nullptr) const =0
 
virtual IClumpfindClumpContaining (const DVect &v, QSet< quint64 > *skip=nullptr)=0
 
virtual const IPebblefindPebbleWithID (quint64 id) const =0
 
virtual IPebblefindPebbleWithID (quint64 id)=0
 
virtual const IPebblefindPebbleClosestTo (const DVect &v, const double &radius=limits< double >::max()) const =0
 
virtual IPebblefindPebbleClosestTo (const DVect &v, const double &radius=limits< double >::max())=0
 
virtual const IPebblefindPebbleContaining (const DVect &v, QSet< quint64 > *skip=nullptr) const =0
 
virtual IPebblefindPebbleContaining (const DVect &v, QSet< quint64 > *skip=nullptr)=0
 
virtual const IClumpTemplatefindClumpTemplateWithID (quint64 id) const =0
 
virtual IClumpTemplatefindClumpTemplateWithID (quint64 id)=0
 
virtual const IClumpTemplatefindClumpTemplateWithName (const QString &) const =0
 
virtual IClumpTemplatefindClumpTemplateWithName (const QString &)=0
 
virtual const IPebblefindClumpTemplatePebbleWithID (quint64 id) const =0
 
virtual IPebblefindClumpTemplatePebbleWithID (quint64 id)=0
 
virtual const IGhostPebblefindGhostPebbleWithID (quint64 id) const =0
 
virtual IGhostPebblefindGhostPebbleWithID (quint64 id)=0
 
virtual void validate ()=0
 
virtual const IEnergyMapgetIClumpEnergies () const =0
 
virtual const IEnergyMapgetIContactPebblePebbleEnergies () const =0
 
virtual void getClumpInBoxList (const DExtent &d, FArray< IClump * > *ret, bool intersect=true)=0
 Return the clumps in a box.
 
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
 Return the pebbles in a box.
 
virtual void getPebbleInBoxList (const DExtent &d, FArray< const IPebble * > *ret, bool intersect=true)=0
 
virtual void populateAttributeSets (QStringList *scalarAtts, FArray< uint > *scalarNotices, QStringList *stringAtts, FArray< uint > *stringNotices, QStringList *vectorAtts, FArray< uint > *vectorNotices) const =0
 
virtual void populatePieceAttributeSets (QStringList *valueAtts, QStringList *labelAtts, QStringList *vectorAtts) const =0
 Populates sets of piece property names based on their type.
 
virtual void populatePropertySets (QStringList *scalarProps, QStringList *stringProps, QStringList *vectorProps) const =0
 Populates sets of property names based on their type.
 
virtual prop_signalgetPropertySignal () const =0
 Return the signal associated with the addition of a new property.
 
virtual IClumpTemplatecreateFromClump (const IClump &c, const QString &name)=0
 
virtual void threadedCallbackObjectClump (Callback4< void, IClump *, quint32, quint32, void * > &callback, void *v=nullptr, bool useThreads=true) const =0
 Object for creation of multithreaded loop over clumps.
 
template<class S , void(S::*)(IClump *, quint32, quint32, void *) MFP>
void threadedCallbackMethodClump (S *s, void *v=nullptr, bool useThreads=true) const
 Implementation of the multithreaded loop using the threadedCallbackObjectClump.
 
virtual void threadedCallbackObjectPebble (Callback4< void, IPebble *, quint32, quint32, void * > &callback, void *v=nullptr, bool useThreads=true) const =0
 Object for creation of multithreaded loop over pebbles.
 
template<class S , void(S::*)(IPebble *, quint32, quint32, void *) MFP>
void threadedCallbackMethodPebble (S *s, void *v=nullptr, bool useThreads=true) const
 Implementation of the multithreaded loop using the threadedCallbackObjectPebble.
 

Detailed Description

Interface for the Clump module. This is the interface for the Clump module.

Member Function Documentation

◆ createFromClump()

virtual IClumpTemplate* pfc::IModuleClump::createFromClump ( const IClump c,
const QString &  name 
)
pure virtual

Create a clump template from a clump, add it to the clump template container, and return a pointer


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