Itasca C++ Interface
Toggle main menu visibility
Loading...
Searching...
No Matches
iparticletracelist.h
Go to the documentation of this file.
1
#pragma once
2
3
#include "
dim.h
"
4
#include "
iparticletrace.h
"
5
#include "
utility/interface/icontainer.h
"
6
11
namespace
itascaxd
{
12
using namespace
itasca;
15
class
IParticleTraceList
{
16
public
:
18
virtual
IContainer
*
getIContainer
()=0;
19
21
virtual
uint32
getNumberRegistered
()
const
=0;
22
25
virtual
const
IParticleTrace
*
getRegistered
(uint32 index)
const
=0;
26
29
virtual
const
IParticleTrace
*
getFirst
()
const
=0;
30
32
virtual
const
IParticleTrace
*
lookupWithName
(
string
name)
const
=0;
33
36
virtual
uint32
getNStep
()
const
=0;
37
42
virtual
int64
getData
(int64 start,std::vector<DVect> *pos=0,std::vector<DVect> *vel=0,std::vector<bool> *valid=0,
int
*step=0)
const
=0;
43
45
virtual
uint32
getNotice
()
const
=0;
46
48
virtual
uint32
getParticleTraceGeneralType
()
const
=0;
49
};
50
}
// namespace itascaxd
51
// EoF
itasca::IContainer
Interface for containers of IThings.
Definition
icontainer.h:21
itascaxd::IParticleTrace
Interface to a particular particle trace being taken by the particle trace logic.
Definition
iparticletrace.h:19
itascaxd::IParticleTraceList
Interface to the list of all IParticleTraces being taken by the particle trace logic.
Definition
iparticletracelist.h:15
itascaxd::IParticleTraceList::getIContainer
virtual IContainer * getIContainer()=0
Returns a pointer to the container class representing a list of particle traces.
itascaxd::IParticleTraceList::getFirst
virtual const IParticleTrace * getFirst() const =0
itascaxd::IParticleTraceList::getNumberRegistered
virtual uint32 getNumberRegistered() const =0
Returns the number of distinct types of IParticleTraces available.
itascaxd::IParticleTraceList::getNStep
virtual uint32 getNStep() const =0
itascaxd::IParticleTraceList::getRegistered
virtual const IParticleTrace * getRegistered(uint32 index) const =0
itascaxd::IParticleTraceList::getData
virtual int64 getData(int64 start, std::vector< DVect > *pos=0, std::vector< DVect > *vel=0, std::vector< bool > *valid=0, int *step=0) const =0
itascaxd::IParticleTraceList::getNotice
virtual uint32 getNotice() const =0
Returns the NoticeManager ID for particle traces added/removed from the list, or additional records t...
itascaxd::IParticleTraceList::getParticleTraceGeneralType
virtual uint32 getParticleTraceGeneralType() const =0
Returns the general type for an IParticleTrace.
itascaxd::IParticleTraceList::lookupWithName
virtual const IParticleTrace * lookupWithName(string name) const =0
Find the IParticleTrace object with Name name, or 0 if no match is found.
dim.h
DIM - Provides code portability between 2D and 3D codes.
icontainer.h
Interface for container of IThings.
iparticletrace.h
Interface to a particular particle trace being taken by the particle trace logic.
itascaxd
Itasca Library standard namespace, specific to 2D or 3D.
Definition
icontactmodule.h:6
common
module
interface
iparticletracelist.h
Generated by
1.18.0