: To disable the rays which have a number of reflection events greater than a given threshold or reflecting on the ground if it is disabled. More...

#include <ReflectionSelector.h>

Inheritance diagram for ReflectionSelector< T >:

[legend]

Collaboration diagram for ReflectionSelector< T >:

[legend]

Public Member Functions
	ReflectionSelector (int _maxReflectionOrder=1, bool _acceptGround=false, 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	getMaximumReflectionOrder ()
	Get the reflection maximal number. More...

void	setMaximumReflectionOrder (int _maxReflectionOrder)
	Set the reflection maximal number. More...

bool	isGroundAccepted ()
	Return true if ground reflection is accepted. More...

void	setGroundAccepted (bool _acceptGround)
	Set flag acceptGround. More...

OPERATOR	getOperator ()
	Get the OPERATOR of this Selector. More...

void	setOperator (OPERATOR _op)
	Set the OPERATOR of 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	maxReflectionOrder
	Reflection maximal number for this Selector criteria. More...

bool	acceptGround
	Flag to accept or not the reflection on the ground. More...

OPERATOR	op
	OPERATOR being used for the criteria (by default, LESS_OR_EQUAL) More...

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 ReflectionSelector< T >

: To disable the rays which have a number of reflection events greater than a given threshold or reflecting on the ground if it is disabled.

Definition at line 27 of file ReflectionSelector.h.

Constructor & Destructor Documentation

◆ ReflectionSelector()

template<typename T >

ReflectionSelector< T >::ReflectionSelector	(	int	_maxReflectionOrder = `1`,
		bool	_acceptGround = `false`,
		OPERATOR	_op = `LESS_OR_EQUAL`
	)

inline

Constructor.

Definition at line 31 of file ReflectionSelector.h.

Here is the caller graph for this function:

Member Function Documentation

◆ canBeInserted()

template<typename T >

virtual SELECTOR_RESPOND ReflectionSelector< 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 47 of file ReflectionSelector.h.

Here is the call graph for this function:

◆ Copy()

template<typename T >

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

inlinevirtual

Copy Selector.

Reimplemented from Selector< T >.

Definition at line 39 of file ReflectionSelector.h.

Here is the call graph for this function:

◆ getMaximumReflectionOrder()

template<typename T >

int ReflectionSelector< T >::getMaximumReflectionOrder ( )

inline

Get the reflection maximal number.

Definition at line 167 of file ReflectionSelector.h.

◆ getOperator()

template<typename T >

OPERATOR ReflectionSelector< T >::getOperator ( )

inline

Get the OPERATOR of this Selector.

Definition at line 199 of file ReflectionSelector.h.

◆ getSelectorName()

template<typename T >

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

inlinevirtual

Return the class type of the selector.

Reimplemented from Selector< T >.

Definition at line 215 of file ReflectionSelector.h.

◆ insert()

template<typename T >

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

inlinevirtual

Select the ray.

Reimplemented from Selector< T >.

Definition at line 103 of file ReflectionSelector.h.

◆ insertWithTest()

template<typename T >

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

inlinevirtual

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

Reimplemented from Selector< T >.

Definition at line 108 of file ReflectionSelector.h.

Here is the call graph for this function:

◆ isGroundAccepted()

template<typename T >

bool ReflectionSelector< T >::isGroundAccepted ( )

inline

Return true if ground reflection is accepted.

Definition at line 183 of file ReflectionSelector.h.

◆ setGroundAccepted()

template<typename T >

void ReflectionSelector< T >::setGroundAccepted ( bool _acceptGround )

inline

Set flag acceptGround.

Definition at line 191 of file ReflectionSelector.h.

◆ setMaximumReflectionOrder()

template<typename T >

void ReflectionSelector< T >::setMaximumReflectionOrder ( int _maxReflectionOrder )

inline

Set the reflection maximal number.

Definition at line 175 of file ReflectionSelector.h.

◆ setOperator()

template<typename T >

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

inline

Set the OPERATOR of this Selector.

Definition at line 207 of file ReflectionSelector.h.

Here is the caller graph for this function:

Member Data Documentation

◆ acceptGround

template<typename T >

bool ReflectionSelector< T >::acceptGround

protected

Flag to accept or not the reflection on the ground.

Definition at line 222 of file ReflectionSelector.h.

◆ maxReflectionOrder

template<typename T >

int ReflectionSelector< T >::maxReflectionOrder

protected

Reflection maximal number for this Selector criteria.

Definition at line 221 of file ReflectionSelector.h.

◆ op

template<typename T >

OPERATOR ReflectionSelector< T >::op

protected

OPERATOR being used for the criteria (by default, LESS_OR_EQUAL)

Definition at line 223 of file ReflectionSelector.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/ReflectionSelector.h

Public Member Functions

Protected Attributes

Detailed Description

template<typename T> class ReflectionSelector< T >

Constructor & Destructor Documentation

◆ ReflectionSelector()

Member Function Documentation

◆ canBeInserted()

◆ Copy()

◆ getMaximumReflectionOrder()

◆ getOperator()

◆ getSelectorName()

◆ insert()

◆ insertWithTest()

◆ isGroundAccepted()

◆ setGroundAccepted()

◆ setMaximumReflectionOrder()

◆ setOperator()

Member Data Documentation

◆ acceptGround

◆ maxReflectionOrder

◆ op

template<typename T>
class ReflectionSelector< T >