: Rejects rays which have traveled a distance greater than a given length More...

#include <LengthSelector.h>

Inheritance diagram for LengthSelector< T >:

Collaboration diagram for LengthSelector< T >:

Public Member Functions
	LengthSelector (double _maxLength=2000, OPERATOR _op=LESS_OR_EQUAL)
	Default 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, unsigned long long &replace)
	Keep the ray. More...

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

double	getMaximumLength ()
	Get the maximal length. More...

void	setMaximumLength (double _maximumLength)
	Set the maximal length. 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...

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

Protected Attributes
double	maxLength
	Maximal length criteria. More...

OPERATOR	op
	OPERATOR used (by default LESS_OR_EQUAL, which means this Selector keeps only ray with travelled distance<=maximalLength) 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 LengthSelector< T >

: Rejects rays which have traveled a distance greater than a given length

Definition at line 25 of file LengthSelector.h.

Constructor & Destructor Documentation

◆ LengthSelector()

template<typename T >

LengthSelector< T >::LengthSelector	(	double	_maxLength = `2000`,
		OPERATOR	_op = `LESS_OR_EQUAL`
	)

inline

Default constructor.

Definition at line 29 of file LengthSelector.h.

Here is the caller graph for this function:

Member Function Documentation

◆ canBeInserted()

template<typename T >

virtual SELECTOR_RESPOND LengthSelector< 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 38 of file LengthSelector.h.

◆ Copy()

template<typename T >

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

inlinevirtual

Copy Selector.

Reimplemented from Selector< T >.

Definition at line 30 of file LengthSelector.h.

Here is the call graph for this function:

◆ getMaximumLength()

template<typename T >

double LengthSelector< T >::getMaximumLength ( )

inline

Get the maximal length.

Definition at line 120 of file LengthSelector.h.

◆ getOperator()

template<typename T >

OPERATOR LengthSelector< T >::getOperator ( )

inline

Get the OPERATOR of this Selector.

Definition at line 130 of file LengthSelector.h.

◆ getSelectorName()

template<typename T >

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

inlinevirtual

Return the class type of the selector.

Reimplemented from Selector< T >.

Definition at line 140 of file LengthSelector.h.

◆ insert()

template<typename T >

virtual void LengthSelector< T >::insert	(	T *	r,
		unsigned long long &	replace
	)

inlinevirtual

Keep the ray.

Definition at line 77 of file LengthSelector.h.

◆ insertWithTest()

template<typename T >

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

inlinevirtual

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

Reimplemented from Selector< T >.

Definition at line 79 of file LengthSelector.h.

◆ setMaximumLength()

template<typename T >

void LengthSelector< T >::setMaximumLength ( double _maximumLength )

inline

Set the maximal length.

Definition at line 125 of file LengthSelector.h.

◆ setOperator()

template<typename T >

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

inline

Set the OPERATOR of this Selector.

Definition at line 135 of file LengthSelector.h.

Here is the caller graph for this function:

Member Data Documentation

◆ maxLength

template<typename T >

double LengthSelector< T >::maxLength

protected

Maximal length criteria.

Definition at line 145 of file LengthSelector.h.

◆ op

template<typename T >

OPERATOR LengthSelector< T >::op

protected

OPERATOR used (by default LESS_OR_EQUAL, which means this Selector keeps only ray with travelled distance<=maximalLength)

Definition at line 146 of file LengthSelector.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/codetympan/checkouts/latest/Tympan/geometric_methods/AcousticRaytracer/Tools/LengthSelector.h

Public Member Functions

Protected Attributes

Detailed Description

template<typename T> class LengthSelector< T >

Constructor & Destructor Documentation

◆ LengthSelector()

Member Function Documentation

◆ canBeInserted()

◆ Copy()

◆ getMaximumLength()

◆ getOperator()

◆ getSelectorName()

◆ insert()

◆ insertWithTest()

◆ setMaximumLength()

◆ setOperator()

Member Data Documentation

◆ maxLength

◆ op

template<typename T>
class LengthSelector< T >