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

Interface to the list of all IParticleTraces being taken by the particle trace logic. More...

#include <iparticletracelist.h>

Public Member Functions

virtual IContainergetIContainer ()=0
 Returns a pointer to the container class representing a list of particle traces.
 
virtual uint32 getNumberRegistered () const =0
 Returns the number of distinct types of IParticleTraces available.
 
virtual const IParticleTracegetRegistered (uint32 index) const =0
 
virtual const IParticleTracegetFirst () const =0
 
virtual const IParticleTracelookupWithName (QString name) const =0
 Find the IParticleTrace object with Name name, or 0 if no match is found.
 
virtual uint32 getNStep () const =0
 
virtual qint64 getData (qint64 start, QVector< DVect > *pos=0, QVector< DVect > *vel=0, QVector< bool > *valid=0, int *step=0) const =0
 
virtual uint32 getNotice () const =0
 Returns the NoticeManager ID for particle traces added/removed from the list, or additional records taken.
 
virtual uint32 getParticleTraceGeneralType () const =0
 Returns the general type for an IParticleTrace.
 

Detailed Description

Interface to the list of all IParticleTraces being taken by the particle trace logic.

Member Function Documentation

◆ getData()

virtual qint64 itascaxd::IParticleTraceList::getData ( qint64 start,
QVector< DVect > * pos = 0,
QVector< DVect > * vel = 0,
QVector< bool > * valid = 0,
int * step = 0 ) const
pure virtual

Retrieves particle trace data. start is a file position that is assumed to be value (first is always 0).
Fills the position array, the velocity array and the valid array with the particle traces in that record.
Also returns the step number of the record in *step. Returns the file position after retrieving the data (can be used as start to get next record).

◆ getFirst()

virtual const IParticleTrace * itascaxd::IParticleTraceList::getFirst ( ) const
pure virtual

Returns the first particle trace in the list.
Use IParticleTrace::getNext() to iterate through the entire list.

◆ getNStep()

virtual uint32 itascaxd::IParticleTraceList::getNStep ( ) const
pure virtual

Indicates at what interval particle traces should be stored.
For instance if getNStep() = 10 then particle traces will be stored every 10 steps.

◆ getRegistered()

virtual const IParticleTrace * itascaxd::IParticleTraceList::getRegistered ( uint32 index) const
pure virtual

Returns the base IParticleTrace class registered in index.
Assumes index<getNumberRegistered().


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