Code_TYMPAN  4.2.0
Industrial site acoustic simulation
Public Member Functions | List of all members
FermatSelector< T > Class Template Reference

: Rays can be seen as long cones that get thicker as their length increases based on their associated solidAngle. This selector rejects rays if the receptor they hit does not lie in the thickness of the ray. (depending on the number of rays launched by the source and the distance covered by the ray). More...

#include <FermatSelector.h>

Inheritance diagram for FermatSelector< T >:
Inheritance graph
[legend]
Collaboration diagram for FermatSelector< T >:
Collaboration graph
[legend]

Public Member Functions

 FermatSelector ()
 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...
 
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...
 

Additional Inherited Members

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

: Rays can be seen as long cones that get thicker as their length increases based on their associated solidAngle. This selector rejects rays if the receptor they hit does not lie in the thickness of the ray. (depending on the number of rays launched by the source and the distance covered by the ray).

Definition at line 27 of file FermatSelector.h.

Constructor & Destructor Documentation

◆ FermatSelector()

template<typename T >
FermatSelector< T >::FermatSelector ( )
inline

Constructor.

Definition at line 31 of file FermatSelector.h.

Here is the caller graph for this function:

Member Function Documentation

◆ canBeInserted()

template<typename T >
virtual SELECTOR_RESPOND FermatSelector< 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 39 of file FermatSelector.h.

◆ Copy()

template<typename T >
virtual Selector<T>* FermatSelector< T >::Copy ( )
inlinevirtual

Copy Selector.

Reimplemented from Selector< T >.

Definition at line 32 of file FermatSelector.h.

Here is the call graph for this function:

◆ getSelectorName()

template<typename T >
virtual const char* FermatSelector< T >::getSelectorName ( )
inlinevirtual

Return the class type of the selector.

Reimplemented from Selector< T >.

Definition at line 92 of file FermatSelector.h.

◆ insert()

template<typename T >
virtual void FermatSelector< T >::insert ( T *  r,
unsigned long long &  replace 
)
inlinevirtual

Keep the ray.

Definition at line 63 of file FermatSelector.h.

◆ insertWithTest()

template<typename T >
virtual bool FermatSelector< T >::insertWithTest ( T *  r)
inlinevirtual

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

Reimplemented from Selector< T >.

Definition at line 65 of file FermatSelector.h.


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