yl::Advection::Visitor Class Reference

Abstract base class for advection visitors. More...

#include <highres-cortex/advection.hh>

Public Member Functions
	Visitor ()
virtual	~Visitor ()
virtual void	first (const Point3df &point)=0
	Called before visit() on the first point of the advection path.
virtual void	visit (const Point3df &point)=0
	Called for every point on the advection path, including the first.
virtual bool	move_on (const Point3df &point) const =0
	Predicate that decides if the advection will continue or stop.
virtual bool	aborted () const =0
	Indicates whether the Visitor encountered an error.
virtual void	finished (const Point3df &)
	Called after the advection is stopped by move_on()
virtual void	abort ()
	Called when the advection cannot finish successfully.
int	verbosity () const
void	set_verbose (int verbosity)
	Set the verbosity level (output to stderr)

Detailed Description

Abstract base class for advection visitors.

Definition at line 70 of file advection.hh.

Constructor & Destructor Documentation

Visitor()

yl::Advection::Visitor::Visitor ( )

inline

Definition at line 73 of file advection.hh.

~Visitor()

virtual yl::Advection::Visitor::~Visitor ( )

inlinevirtual

Definition at line 74 of file advection.hh.

Member Function Documentation

abort()

virtual void yl::Advection::Visitor::abort ( )

inlinevirtual

Called when the advection cannot finish successfully.

Definition at line 87 of file advection.hh.

aborted()

virtual bool yl::Advection::Visitor::aborted ( ) const

pure virtual

Indicates whether the Visitor encountered an error.

finished()

virtual void yl::Advection::Visitor::finished ( const Point3df & )

inlinevirtual

Called after the advection is stopped by move_on()

Definition at line 85 of file advection.hh.

first()

virtual void yl::Advection::Visitor::first ( const Point3df & point )

pure virtual

Called before visit() on the first point of the advection path.

move_on()

virtual bool yl::Advection::Visitor::move_on ( const Point3df & point ) const

pure virtual

Predicate that decides if the advection will continue or stop.

set_verbose()

void yl::Advection::Visitor::set_verbose ( int verbosity )

inline

Set the verbosity level (output to stderr)

0: silent (default on instance creation) 1: show errors

Definition at line 95 of file advection.hh.

References verbosity().

verbosity()

int yl::Advection::Visitor::verbosity ( ) const

inline

Definition at line 89 of file advection.hh.

Referenced by set_verbose().

visit()

virtual void yl::Advection::Visitor::visit ( const Point3df & point )

pure virtual

Called for every point on the advection path, including the first.

---

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

• highres-cortex/advection.hh