Itasca C++ Interface
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
pfc::IModuleWall Class Referenceabstract

Interface for the wall module. More...

#include <imodulewall.h>

Public Types

using prop_signal = shared::Signal<const QString &,const QVariant &>
 Typedef for the small granularity signal used to indicate to the gui that a propery has been added.
 

Public Member Functions

virtual TType getFWallType () const =0
 Return the FWall TType.
 
virtual TType getFacetType () const =0
 Return the HalfFacetBase TType.
 
virtual TType getVertexType () const =0
 Return the HalfVertexBase TType.
 
virtual uint32 getFWallGeometryNotice () const =0
 Return the FWall geometry notice.
 
virtual uint32 getFWallCycleNotice () const =0
 Return the FWall cycle notice.
 
virtual uint32 getFWallVelocityNotice () const =0
 Return the FWall velocity notice.
 
virtual uint32 getFWallDisplacementNotice () const =0
 Return the FWall displacement notice.
 
virtual uint32 getFWallPropertyNotice () const =0
 Return the FWall property notice.
 
virtual uint32 getFWallExtraNotice () const =0
 Return the FWall extra notice.
 
virtual uint32 getFWallGroupNotice () const =0
 Return the FWall group notice.
 
virtual uint32 getFWallFacetExtraNotice () const =0
 Return the FWallFacet extra notice.
 
virtual uint32 getFWallFacetGroupNotice () const =0
 Return the FWallFacet group notice.
 
virtual uint32 getFWallCleanNotice () const =0
 Return the FWall clean notice.
 
virtual const IContainer * getIContainerFWall () const =0
 Return the const IContainer of the FWalls.
 
virtual IContainer * getIContainerFWall ()=0
 Return the IContainer of the FWalls.
 
virtual IContainer * getIContainerFacet ()=0
 Return the IContainer of the Facets.
 
virtual const IContainer * getIContainerFacet () const =0
 Return the const IContainer of the Facets.
 
virtual IContainer * getIContainerVertex ()=0
 Return the IContainer of the Vertices.
 
virtual const IContainer * getIContainerVertex () const =0
 Return the const IContainer of the Vertices.
 
virtual const ICellSpace * getFWallCellSpace () const =0
 Return a const ICellSpace pointer to the FWall cell space.
 
virtual ICellSpace * getFWallCellSpace ()=0
 Return an ICellSpace pointer to the FWall cell space.
 
virtual const IWall * findWallWithID (uint64 id) const =0
 Find the const IWall with ID id;.
 
virtual IWall * findWallWithID (uint64 id)=0
 Find the IWall with ID id.
 
virtual const IFWall * findFWallWithID (uint64 id) const =0
 Find the const IFWall with ID id;.
 
virtual IFWall * findFWallWithID (uint64 id)=0
 Find the IFWall with ID id.
 
virtual const IWall * findWallWithName (const QString &name) const =0
 Find the const IWall with name name.
 
virtual IWall * findWallWithName (const QString &name)=0
 Find the IWall with name name.
 
virtual const IFWall * findFWallWithName (const QString &name) const =0
 Find the const IWall with name name.
 
virtual IFWall * findFWallWithName (const QString &name)=0
 Find the IWall with name name.
 
virtual const IFWall * findFWallClosestTo (const DVect &v, const double &radius=limits< double >::max()) const =0
 Find the const FWall closest to v.
 
virtual IFWall * findFWallClosestTo (const DVect &v, const double &radius=limits< double >::max())=0
 Find the FWall closest to v.
 
virtual IFWall * createIFWall (QString name, uint64 id=0)=0
 Create a faceted wall with name name and ID id.
 
virtual const IHalfFacet * findFacetWithID (uint64 id, IFWall *w=0) const =0
 Find the const IHalfFacet with ID id;.
 
virtual IHalfFacet * findFacetWithID (uint64 id, IFWall *w=0)=0
 Find the IHalfFacet with ID id.
 
virtual IHalfFacet * findFacetAloneWithID (uint64 id)=0
 Find the IHalfFacet with ID id.
 
virtual const IHalfFacet * findFacetClosestTo (const DVect &v, const double &radius=limits< double >::max()) const =0
 Find the const IHalfFacet closest to v.
 
virtual IHalfFacet * findFacetClosestTo (const DVect &v, const double &radius=limits< double >::max())=0
 Find the IHalfFacet closest to v.
 
virtual IFWall * removeIHalfFacet (IHalfFacet *fac)=0
 Remove the facet fac from its faceted wall.
 
virtual const IHalfVertex * findVertexWithID (uint64 id, IFWall *w=0) const =0
 Find the const IHalfVertex with ID id;.
 
virtual IHalfVertex * findVertexWithID (uint64 id, IFWall *w=0)=0
 Find the IHalfVertex with ID id.
 
virtual IHalfVertex * findVertexAloneWithID (uint64 id)=0
 Find the IHalfVertex with ID id.
 
virtual const IHalfVertex * findVertexClosestTo (const DVect &v, const double &radius=limits< double >::max()) const =0
 Find the const IHalfVertex closest to v.
 
virtual IHalfVertex * findVertexClosestTo (const DVect &v, const double &radius=limits< double >::max())=0
 Find the IHalfVertex closest to v.
 
virtual void getWallList (FArray< IWall * > *ret)=0
 Return a list of IWalls.
 
virtual void eraseIWall (IWall *w)=0
 Erase the IWall - could be of any type.
 
virtual const IEnergyMap * getIWallEnergies () const =0
 Return the EnergyMap attached to the walls.
 
virtual void getWallInBoxList (const DExtent &d, FArray< IFWall * > *ret, bool intersect=true)=0
 Return the Walls in a box.
 
virtual void getWallInBoxList (const DExtent &d, FArray< const IFWall * > *ret, bool intersect=true)=0
 
virtual void getFacetInBoxList (const DExtent &d, FArray< IHalfFacet * > *ret, bool intersect=true)=0
 Return the Facets in a box.
 
virtual void getFacetInBoxList (const DExtent &d, FArray< const IHalfFacet * > *ret, bool intersect=true)=0
 
virtual void getVertexInBoxList (const DExtent &d, FArray< IHalfVertex * > *ret, bool intersect=true)=0
 Return the Vertices in a box.
 
virtual void getVertexInBoxList (const DExtent &d, FArray< const IHalfVertex * > *ret, bool intersect=true)=0
 
virtual void populateAttributeSets (QStringList *scalarAtts, FArray< uint32 > *scalarNotices, QStringList *stringAtts, FArray< uint32 > *stringNotices, QStringList *vectorAtts, FArray< uint32 > *vectorNotices) const =0
 Populates sets of property names based on their type.
 
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 *valueProps, QStringList *labelProps, QStringList *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 void threadedCallbackObjectWall (Callback4< void, IFWall *, uint32, uint32, void * > &callback, void *v=nullptr, bool useThreads=true) const =0
 Object for creation of multithreaded loop over walls.
 
template<class S , void(S::*)(IFWall *, uint32, uint32, void *) MFP>
void threadedCallbackMethodWall (S *s, void *v=nullptr, bool useThreads=true) const
 Implementation of the multithreaded loop using the threadedCallbackObjectFWall

 
virtual void threadedCallbackObjectFacet (Callback4< void, IHalfFacet *, uint32, uint32, void * > &callback, void *v=nullptr, bool useThreads=true) const =0
 Object for creation of multithreaded loop over facets.
 
template<class S , void(S::*)(IHalfFacet *, uint32, uint32, void *) MFP>
void threadedCallbackMethodFacet (S *s, void *v=nullptr, bool useThreads=true) const
 Implementation of the multithreaded loop using the threadedCallbackObjectFacet

 
virtual void threadedCallbackObjectVertex (Callback4< void, IHalfVertex *, uint32, uint32, void * > &callback, void *v=nullptr, bool useThreads=true) const =0
 Object for creation of multithreaded loop over vertices.
 
template<class S , void(S::*)(IHalfFacet *, uint32, uint32, void *) MFP>
void threadedCallbackMethodVertex (S *s, void *v=nullptr, bool useThreads=true) const
 Implementation of the multithreaded loop using the threadedCallbackObjectVertex

 

Detailed Description

Interface for the wall module.

This is the interface for the wall module. The outside world accesses information about walls through this interface. Right now only faceted walls have been implemented and this interface reflects that fact. It is anticipated that there will be parallel methods to access the information for other wall types that are added to this module (point walls, line walls, etc.). The intention is that all walls of any type will have unique ids so that the findWallWithID method will find any IWall with the appropriate id.


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