Itasca C++ Interface
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
irblockmodule.h
1 #pragma once
2 #include "base/src/farray.h"
3 #include "utility/interface/isignalbase.h"
4 #include "base/src/callback.h"
5 
6 namespace itasca {
7  class IContainer;
8  class IEnergyMap;
9 }
10 
11 namespace itascaxd {
12  class IContact;
13  class ICellSpace;
14  class IContainerContact;
15 }
16 
17 namespace rblock {
18  using namespace itasca;
19  using namespace itascaxd;
20 
21  class IRBlock;
22  class IGhostRBlock;
23  class IRBlockTemplate;
24 
25  class IRBlockModule {
26  public:
28  typedef Signal2<const QString &,const QVariant &> prop_signal;
29 
31  virtual TType getRBlockType() const=0;
33  virtual TType getRBlockTemplateType() const=0;
35  virtual TType getGhostRBlockType() const=0;
37  virtual uint getRBlockGeometryNotice() const=0;
39  virtual uint getRBlockHideNotice() const=0;
41  virtual uint getRBlockSelectNotice() const=0;
43  virtual uint getRBlockCycleNotice() const=0;
45  virtual uint getRBlockFixNotice() const=0;
47  virtual uint getRBlockPropertyNotice() const=0;
49  virtual uint getRBlockExtraNotice() const=0;
51  virtual uint getRBlockGroupNotice() const=0;
53  virtual const IContainer * getIContainerRBlock() const=0;
55  virtual IContainer * getIContainerRBlock()=0;
57  virtual const IContainer * getIContainerRBlockTemplate() const=0;
59  virtual IContainer * getIContainerRBlockTemplate()=0;
61  virtual const IContainer * getIContainerGhostRBlock() const=0;
63  virtual IContainer * getIContainerGhostRBlock()=0;
65  virtual const IContainerContact * getIContainerRBlockRBlock() const=0;
67  virtual IContainerContact * getIContainerRBlockRBlock()=0;
68 
70  virtual const ICellSpace * getRBlockCellSpace() const=0;
72  virtual ICellSpace * getRBlockCellSpace()=0;
74  virtual const IRBlock * findIRBlockWithID(quint64 id) const=0;
76  virtual IRBlock * findIRBlockWithID(quint64 id) =0;
78  virtual const IRBlockTemplate * findIRBlockTemplateWithID(quint64 id) const=0;
80  virtual IRBlockTemplate * findIRBlockTemplateWithID(quint64 id) =0;
82  virtual const IRBlockTemplate * findIRBlockTemplateWithName(const QString &s) const=0;
84  virtual IRBlockTemplate * findIRBlockTemplateWithName(const QString &s) =0;
86  virtual const IGhostRBlock * findIGhostRBlockWithID(quint64 id) const=0;
88  virtual IGhostRBlock * findIGhostRBlockWithID(quint64 id) =0;
90  virtual const IRBlock * findIRBlockClosestTo(const DVect &v,const double &radius=limits<double>::max()) const=0;
92  virtual IRBlock * findIRBlockClosestTo(const DVect &v,const double &radius=limits<double>::max())=0;
94  virtual const IRBlock * findIRBlockContaining(const DVect &v,QSet<quint64> *skip=nullptr) const=0;
96  virtual IRBlock * findIRBlockContaining(const DVect &v,QSet<quint64> *skip=nullptr)=0;
98  virtual bool collide(IRBlock *rb1, IRBlock *rb2) const = 0;
99 
101  virtual const IEnergyMap * getIRBlockEnergies() const=0;
102 
104  virtual void getIRBlocksInBoxList(const DExtent &d,FArray<IRBlock *> *ret,bool intersect=true)=0;
105  virtual void getIRBlocksInBoxList(const DExtent &d,FArray<const IRBlock *> *ret,bool intersect=true)=0;
106 
108  virtual void populateAttributeSets(QStringList *scalarAtts,FArray<uint> *scalarNotices,QStringList *stringAtts,FArray<uint> *stringNotices,QStringList *vectorAtts,FArray<uint> *vectorNotices) const=0;
110  virtual void populatePropertySets(QStringList *valueProps,QStringList *labelProps,QStringList *vectorProps)const=0;
112  virtual prop_signal * getPropertySignal() const = 0;
113 
115  virtual void threadedCallbackObject(Callback4<void,IRBlock *,quint32,quint32,void *> &callback,void *v=nullptr,bool useThreads=true) const=0;
116 
118  template <class S,void (S::*MFP)(IRBlock *,quint32,quint32,void *)>
119  void threadedCallbackMethod(S *s,void *v=nullptr,bool useThreads=true) const {
120  Callback4Method<void,IRBlock *,quint32,quint32,void *,S,MFP> callback(s);
121  threadedCallbackObject(callback,v,useThreads);
122  }
123  };
124 } // namespace rblock
125 // EoF
Callback4
Definition: callback.h:30
itasca
namespace Itasca
Definition: basememory.cpp:9
itasca::Signal2
Definition of a Signal2 object, holding a list of ISlot2 objects.
Definition: isignalbase.h:76
rblock::IRBlockModule
Definition: irblockmodule.h:25
isignalbase.h
Interface for the small-granularity callback utility.
farray.h
An array class that attempts to minimize unnecessary heap access.
itascaxd::IContainerContact
Contact container class.
Definition: icontainercontact.h:28
limits
debug checked shorthand for std::numeric_limits<T>::
Definition: limit.h:25
rblock::IRBlockTemplate
Definition: irblocktemplate.h:11
rblock::IRBlockModule::prop_signal
Signal2< const QString &, const QVariant & > prop_signal
Typedef for the small granularity signal used to indicate to the gui that a propery has been added.
Definition: irblockmodule.h:28
TType
unsigned int TType
class type indicator
Definition: basedef.h:41
DExtent
DExtent3 DExtent
A DExtent2 in 2D, a DExtent3 in 3D.
Definition: dim.h:149
Callback4Method
Definition: callback.h:122
rblock::IGhostRBlock
Definition: ighostrblock.h:16
itascaxd
Itasca Library standard namespace, specific to 2D or 3D.
Definition: icontactmodule.h:4
rblock::IRBlock
Definition: irblock.h:25
FArray
An array class that attempts to minimize unnecessary heap access.
Definition: farray.h:27
itasca::IContainer
Interface for containers of IThings.
Definition: icontainer.h:23
DVect
DVect3 DVect
Vector of doubles, either 2D or 3D.
Definition: dim.h:145
itascaxd::ICellSpace
Interface to a "refining" cell space.
Definition: icellspace.h:24
rblock::IRBlockModule::threadedCallbackMethod
void threadedCallbackMethod(S *s, void *v=nullptr, bool useThreads=true) const
Implementation of the multithreaded loop using the threadedCallbackObjectRBlock.
Definition: irblockmodule.h:119
itasca::IEnergyMap
Interface to EnergyMap class.
Definition: ienergymap.h:15
Generated by   doxygen 1.8.15