: To disable ray with a number of diffraction events greater than a threshold value More...

#include <DiffractionSelector.h>

Inheritance diagram for DiffractionSelector< T >:

Collaboration diagram for DiffractionSelector< T >:

Public Member Functions
	DiffractionSelector (int _maxDiffractionOrder=1, OPERATOR _op=LESS_OR_EQUAL)
	Constructor. More...

virtual Selector< T > *	Copy ()
	Copy Selector. More...

virtual SELECTOR_RESPOND	canBeInserted (T *r, unsigned long long &replace)
	Check if the ray respects the criteria of this Selector and return a SELECTOR_RESPOND. More...

virtual void	insert (T *r)
	Select the ray. More...

virtual bool	insertWithTest (T *r)
	Select the ray if it respects the criteria of this Selector. More...

int	getMaximumDiffractionOrder ()
	Get maxDiffractionOrder. More...

void	setMaximumDiffractionOrder (int _maxDiffractionOrder)
	Set maxDiffractionOrder. More...

OPERATOR	getOperator ()
	Get the Operator used by this Selector. More...

void	setOperator (OPERATOR _op)
	Set the Operator used by this Selector. More...

virtual const char *	getSelectorName ()
	Return the class type of the selector. More...

Public Member Functions inherited from Selector< T >
	Selector ()
	Base constructor. More...

virtual	~Selector ()
	Destructor. More...

virtual void	reset ()
	Reset (clear the data) of this Selector. More...

bool	isDeletable ()
	Return true if the Selector may be deleted. More...

void	setIsDeletable (bool _isDeletable)
	Set deletable flag. More...

Protected Attributes
int	maxDiffractionOrder
	Maximal number of possible diffractions. More...

OPERATOR	op

Protected Attributes inherited from Selector< T >
bool	deletable
	Flag to know if the selector may be deleted or not. More...

Detailed Description

template<typename T>
class DiffractionSelector< T >

: To disable ray with a number of diffraction events greater than a threshold value

Definition at line 24 of file DiffractionSelector.h.

Constructor & Destructor Documentation

◆ DiffractionSelector()

template<typename T >

DiffractionSelector< T >::DiffractionSelector	(	int	_maxDiffractionOrder = `1`,
		OPERATOR	_op = `LESS_OR_EQUAL`
	)

inline

Constructor.

Definition at line 28 of file DiffractionSelector.h.

Here is the caller graph for this function:

Member Function Documentation

◆ canBeInserted()

template<typename T >

virtual SELECTOR_RESPOND DiffractionSelector< T >::canBeInserted	(	T *	r,
		unsigned long long &	replace
	)

inlinevirtual

Check if the ray respects the criteria of this Selector and return a SELECTOR_RESPOND.

Reimplemented from Selector< T >.

Definition at line 43 of file DiffractionSelector.h.

◆ Copy()

template<typename T >

virtual Selector<T>* DiffractionSelector< T >::Copy ( )

inlinevirtual

Copy Selector.

Reimplemented from Selector< T >.

Definition at line 34 of file DiffractionSelector.h.

Here is the call graph for this function:

◆ getMaximumDiffractionOrder()

template<typename T >

int DiffractionSelector< T >::getMaximumDiffractionOrder ( )

inline

Get maxDiffractionOrder.

Definition at line 123 of file DiffractionSelector.h.

◆ getOperator()

template<typename T >

OPERATOR DiffractionSelector< T >::getOperator ( )

inline

Get the Operator used by this Selector.

Definition at line 133 of file DiffractionSelector.h.

◆ getSelectorName()

template<typename T >

virtual const char* DiffractionSelector< T >::getSelectorName ( )

inlinevirtual

Return the class type of the selector.

Reimplemented from Selector< T >.

Definition at line 146 of file DiffractionSelector.h.

◆ insert()

template<typename T >

virtual void DiffractionSelector< T >::insert ( T * r )

inlinevirtual

Select the ray.

Reimplemented from Selector< T >.

Definition at line 81 of file DiffractionSelector.h.

◆ insertWithTest()

template<typename T >

virtual bool DiffractionSelector< T >::insertWithTest ( T * r )

inlinevirtual

Select the ray if it respects the criteria of this Selector.

Reimplemented from Selector< T >.

Definition at line 85 of file DiffractionSelector.h.

◆ setMaximumDiffractionOrder()

template<typename T >

void DiffractionSelector< T >::setMaximumDiffractionOrder ( int _maxDiffractionOrder )

inline

Set maxDiffractionOrder.

Definition at line 128 of file DiffractionSelector.h.

◆ setOperator()

template<typename T >

void DiffractionSelector< T >::setOperator ( OPERATOR _op )

inline

Set the Operator used by this Selector.

Definition at line 138 of file DiffractionSelector.h.

Here is the caller graph for this function:

Member Data Documentation

◆ maxDiffractionOrder

template<typename T >

int DiffractionSelector< T >::maxDiffractionOrder

protected

Maximal number of possible diffractions.

Definition at line 152 of file DiffractionSelector.h.

◆ op

template<typename T >

OPERATOR DiffractionSelector< T >::op

protected

Operator selected (by default LESS_OR_EQUAL, so it keep rays with a number of diffractions less or equal to maxDiffractionOrder)

Definition at line 153 of file DiffractionSelector.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/code-tympan-fbessou/checkouts/latest/Tympan/geometric_methods/AcousticRaytracer/Tools/DiffractionSelector.h

Public Member Functions

Protected Attributes

Detailed Description

template<typename T> class DiffractionSelector< T >

Constructor & Destructor Documentation

◆ DiffractionSelector()

Member Function Documentation

◆ canBeInserted()

◆ Copy()

◆ getMaximumDiffractionOrder()

◆ getOperator()

◆ getSelectorName()

◆ insert()

◆ insertWithTest()

◆ setMaximumDiffractionOrder()

◆ setOperator()

Member Data Documentation

◆ maxDiffractionOrder

◆ op

template<typename T>
class DiffractionSelector< T >