ESyS-Particle  2.3.4
esys::lsm::ParticleFitter Class Referenceabstract

#include <ParticleFitter.h>

Inheritance diagram for esys::lsm::ParticleFitter:
Collaboration diagram for esys::lsm::ParticleFitter:

Public Types

typedef RandomBlockGenerator::ParticleVector ParticleVector
 

Public Member Functions

 ParticleFitter (RandomBlockGenerator &blockGenerator)
 
virtual ~ParticleFitter ()
 
virtual SimpleParticle getFitParticle (const SimpleParticle &particle, const ParticleVector &neighbours, const Plane3D &plane)=0
 
void incrGetFit ()
 
void incrFailedFit ()
 
void incrSuccessfulFit ()
 
virtual std::string getName () const =0
 
void write (std::ostream &oStream) const
 
std::string toString () const
 
virtual bool particleFits (const SimpleParticle &particle) const
 

Static Public Attributes

static const SimpleParticle INVALID = SimpleParticle(Vec3::ZERO, 0.0, -1, -1)
 

Protected Member Functions

RandomBlockGeneratorgetGenerator ()
 
const RandomBlockGeneratorgetGenerator () const
 

Private Attributes

RandomBlockGeneratorm_pGenerator
 
int m_successfulFitCount
 
int m_getFitCount
 
int m_failedFitCount
 

Member Typedef Documentation

◆ ParticleVector

Constructor & Destructor Documentation

◆ ParticleFitter()

esys::lsm::ParticleFitter::ParticleFitter ( RandomBlockGenerator blockGenerator)
inline

◆ ~ParticleFitter()

virtual esys::lsm::ParticleFitter::~ParticleFitter ( )
inlinevirtual

Member Function Documentation

◆ getFitParticle()

virtual SimpleParticle esys::lsm::ParticleFitter::getFitParticle ( const SimpleParticle particle,
const ParticleVector neighbours,
const Plane3D plane 
)
pure virtual

◆ getGenerator() [1/2]

RandomBlockGenerator& esys::lsm::ParticleFitter::getGenerator ( )
inlineprotected

References m_pGenerator.

Referenced by particleFits().

Here is the caller graph for this function:

◆ getGenerator() [2/2]

const RandomBlockGenerator& esys::lsm::ParticleFitter::getGenerator ( ) const
inlineprotected

References m_pGenerator.

◆ getName()

virtual std::string esys::lsm::ParticleFitter::getName ( ) const
pure virtual

◆ incrFailedFit()

◆ incrGetFit()

◆ incrSuccessfulFit()

◆ particleFits()

virtual bool esys::lsm::ParticleFitter::particleFits ( const SimpleParticle particle) const
inlinevirtual

◆ toString()

std::string esys::lsm::ParticleFitter::toString ( ) const
inline

References write().

Here is the call graph for this function:

◆ write()

void esys::lsm::ParticleFitter::write ( std::ostream &  oStream) const
inline

References getName(), m_failedFitCount, m_getFitCount, and m_successfulFitCount.

Referenced by esys::lsm::operator<<(), and toString().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ INVALID

◆ m_failedFitCount

int esys::lsm::ParticleFitter::m_failedFitCount
private

Referenced by incrFailedFit(), and write().

◆ m_getFitCount

int esys::lsm::ParticleFitter::m_getFitCount
private

Referenced by incrGetFit(), and write().

◆ m_pGenerator

RandomBlockGenerator* esys::lsm::ParticleFitter::m_pGenerator
private

Referenced by getGenerator().

◆ m_successfulFitCount

int esys::lsm::ParticleFitter::m_successfulFitCount
private

Referenced by incrSuccessfulFit(), and write().


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