Itasca C++ Interface
Loading...
Searching...
No Matches
pfc::IModuleClump Class Referenceabstract
PFC interface specification » Clump module interface specification

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

#include <imoduleclump.h>

Public Types

using prop_signal = shared::Signal<const string &,const base::Property &>
 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 uint32 getClumpGeometryNotice () const =0
 Clump geometry notice unsigned integer.
virtual uint32 getClumpPropertyNotice () const =0
 Clump property notice unsigned integer.
virtual uint32 getClumpVelocityNotice () const =0
 Clump velocity notice unsigned integer.
virtual uint32 getClumpCycleNotice () const =0
 Clump cycle notice unsigned integer.
virtual uint32 getClumpExtraNotice () const =0
 Clump extra notice unsigned integer.
virtual uint32 getClumpGroupNotice () const =0
 Clump group notice unsigned integer.
virtual uint32 getClumpCleanNotice () const =0
 Clump clean notice unsigned integer.
virtual uint32 getClumpRotationNotice () const =0
 Clump rotation notice unsigned integer.
virtual uint32 getPebbleExtraNotice () const =0
 Pebble extra velocity notice unsigned integer.
virtual uint32 getPebbleGroupNotice () const =0
 Pebble group notice unsigned integer.
virtual const IContainer * getIContainerClump () const =0
 const access to the Clump container
virtual IContainer * getIContainerClump ()=0
 access to the Clump container
virtual const IContainer * getIContainerClumpTemplate () const =0
 const access to the ClumpTemplate container
virtual IContainer * getIContainerClumpTemplate ()=0
 access to the ClumpTemplate container
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
 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 (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
 Populates sets of piece property names based on their type.
virtual void populatePropertySets (StringList *scalarProps, StringList *stringProps, StringList *vectorProps) const =0
 Populates sets of property names based on their type.
virtual prop_signal * getPropertySignal () const =0
 Return the signal associated with the addition of a new property.
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
 Object for creation of multithreaded loop over clumps.
template<class S, void(S::*)(IClump *, uint32, uint32, 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 *, uint32, uint32, void * > &callback, void *v=nullptr, bool useThreads=true) const =0
 Object for creation of multithreaded loop over pebbles.
template<class S, void(S::*)(IPebble *, uint32, uint32, 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: