itascaxd::IParticleTrace Class Reference

Interface to a particular particle trace being taken by the particle trace logic. More...

#include <iparticletrace.h>

Public Member Functions
virtual const IThing *	getIThing () const =0
	Get IThing interface for the particle trace.
virtual quint64	getID () const =0
	Unique ID associated with the particle trace.
virtual QString	getName () const =0
	Name of the particle trace - generally type and location. This name is assigned by the code.
virtual QString	getLabel () const =0
virtual DVect	getPosition () const =0
virtual DVect	getVelocity () const =0
virtual bool	isValid () const =0
virtual qint64	getStartPosition () const =0
virtual int	getStorageIndex () const =0
virtual DExtent	getTraceExtent () const =0
	Returns the 3D region where the particle traces occured.
virtual double	getMaxVelocity () const =0
	Returns the maximum scalar velocity.
virtual const IParticleTrace *	getNext () const =0

Static Public Attributes
static const TType	type_ = 0x4c815b8d
	The type identification number for this class, for use in convert_cast() and convert_getcast().

Detailed Description

Interface to a particular particle trace being taken by the particle trace logic.

Member Function Documentation

getLabel()

virtual QString itascaxd::IParticleTrace::getLabel ( ) const

pure virtual

Label of the particle trace - to be displayed in plots.
If unassigned this will return the same as getName(). Otherwise it will return a label assigned by the user.

getNext()

virtual const IParticleTrace* itascaxd::IParticleTrace::getNext ( ) const

pure virtual

Returns the next Iparticle trace() object in the global list, or 0 if it is the last one.

getPosition()

virtual DVect itascaxd::IParticleTrace::getPosition ( ) const

pure virtual

Returns the current position of the object.
Returns (0,0,0) if the particle trace has a invalid position.

getStartPosition()

virtual qint64 itascaxd::IParticleTrace::getStartPosition ( ) const

pure virtual

This is the position in the particle trace temp file of the first record containing values from this particle trace.

getStorageIndex()

virtual int itascaxd::IParticleTrace::getStorageIndex ( ) const

pure virtual

This is the position in the particle trace record of the object.
Note that this is distinct from the ID() of the particle trace.

getVelocity()

virtual DVect itascaxd::IParticleTrace::getVelocity ( ) const

pure virtual

Returns a vector that contains the current velocity of the object.
Returns (0,0,0) if the particle trace has a invalid velocity.

isValid()

virtual bool itascaxd::IParticleTrace::isValid ( ) const

pure virtual

Returns TRUE if the particle trace is in a state to take more values.
Returns FALSE if not (for instance, a particle trace of a zone that has been deleted.)

---

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

• C:/Source/itasca-suite/common/module/interface/iparticletrace.h