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

Interface for a clump template. This is the interface for a clump template. A clump template is composed of a clump, a surface description, and a reference orientation. More...

#include <iclumptemplate.h>

Public Member Functions

virtual IThinggetIThing ()=0
 Return an IThing interface for this object.
 
virtual const IThinggetIThing () const =0
 Return a const IThing interface for this object.
 
virtual IClumpgetClump ()=0
 Return the clump.
 
virtual const IClumpgetClump () const =0
 Return the const clump.
 
virtual double getMoiComp (int) const =0
 
virtual DAVect getMoi () const =0
 Return the inertia tensor in principal axis form.
 
virtual double getVolume () const =0
 
virtual void setVolume (const double &d)=0
 
virtual const double & getOrigOrientation () const =0
 Get the double corresponding to the orientation relative to the clump template orientation.
 
virtual QString getClumpTemplateName () const =0
 Return the clump template name.
 
virtual bool getIsReferredTo () const =0
 Indicate whether or not a clump in the model domain refers to this clump template.
 
virtual IClumpTemplatecloneAll (const QString &name=QString(), bool add=true) const =0
 Clone this template completely, not adding it to any container.
 
virtual void doDecNumReferenced ()=0
 Decrement the number of times this is referenced.
 
virtual void doIncNumReferenced ()=0
 Increment the number of times this is referenced.
 
virtual void setMoiComp (const double &, int)=0
 
virtual void setMoi (const DAVect &)=0
 Set the inertia tensor in principal axis form.
 
virtual DVect getOrigPosition () const =0
 Get the original position of the clump template centroid.
 
virtual void setOrigPosition (const DVect &p)=0
 Set the original position of the clump template centroid.
 
virtual DVect getPebblePosition (const IPebble *) const =0
 Return the position of the pebble.
 

Static Public Attributes

static const TType type_ = 0x4ebdb825
 TType for type casting.
 

Detailed Description

Interface for a clump template. This is the interface for a clump template. A clump template is composed of a clump, a surface description, and a reference orientation.

Member Function Documentation

◆ getMoiComp()

virtual double pfc::IClumpTemplate::getMoiComp ( int ) const
pure virtual

Return a component of the inertia tensor. In 2D just the value is returned. In 3D the components are returned. Admissible values are: 11,12,13,22,23,33 in 3D. This is as the clump template has been imported

◆ setMoiComp()

virtual void pfc::IClumpTemplate::setMoiComp ( const double & ,
int  )
pure virtual

Set a component of the inertia tensor. Admissible values are: 11,12,13,22,23,33 in 3D.


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