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

: To keep only one from two or more rays which have the same history (events on the same primitive) More...

#include <FaceSelector.h>

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

Public Member Functions

 FaceSelector (TYPEHISTORY _modeHistory=HISTORY_FACE)
 Constructor. More...
 
virtual ~FaceSelector ()
 Destructor. More...
 
virtual Selector< T > * Copy ()
 Copy Selector. More...
 
virtual void reset ()
 Reset (clear the data) of this Selector. More...
 
TYPEHISTORY getModeHistory ()
 Get the TYPEHISTORY of this Selector. More...
 
void setModeHistory (TYPEHISTORY _modeHistory)
 Set the TYPEHISTORY of this 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...
 
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...
 
bool isDeletable ()
 Return true if the Selector may be deleted. More...
 
void setIsDeletable (bool _isDeletable)
 Set deletable flag. More...
 

Protected Attributes

std::map< std::vector< unsigned int >, T *, CompareToKeyselectedPath
 Histories of all selected rays so far. More...
 
TYPEHISTORY modeHistory
 TYPEHISTORY used by this Selector (by default, HISTORY_FACE) 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 FaceSelector< T >

: To keep only one from two or more rays which have the same history (events on the same primitive)

Definition at line 35 of file FaceSelector.h.

Constructor & Destructor Documentation

◆ FaceSelector()

template<typename T >
FaceSelector< T >::FaceSelector ( TYPEHISTORY  _modeHistory = HISTORY_FACE)
inline

Constructor.

Definition at line 39 of file FaceSelector.h.

Here is the caller graph for this function:

◆ ~FaceSelector()

template<typename T >
virtual FaceSelector< T >::~FaceSelector ( )
inlinevirtual

Destructor.

Definition at line 41 of file FaceSelector.h.

Member Function Documentation

◆ canBeInserted()

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

◆ Copy()

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

Copy Selector.

Reimplemented from Selector< T >.

Definition at line 43 of file FaceSelector.h.

Here is the call graph for this function:

◆ getModeHistory()

template<typename T >
TYPEHISTORY FaceSelector< T >::getModeHistory ( )
inline

Get the TYPEHISTORY of this Selector.

Definition at line 54 of file FaceSelector.h.

◆ getSelectorName()

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

Return the class type of the selector.

Reimplemented from Selector< T >.

Definition at line 192 of file FaceSelector.h.

◆ insert()

template<typename T >
virtual void FaceSelector< T >::insert ( T *  r)
inlinevirtual

Select the ray.

Reimplemented from Selector< T >.

Definition at line 110 of file FaceSelector.h.

◆ insertWithTest()

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

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

Reimplemented from Selector< T >.

Definition at line 147 of file FaceSelector.h.

◆ reset()

template<typename T >
virtual void FaceSelector< T >::reset ( )
inlinevirtual

Reset (clear the data) of this Selector.

Reimplemented from Selector< T >.

Definition at line 49 of file FaceSelector.h.

◆ setModeHistory()

template<typename T >
void FaceSelector< T >::setModeHistory ( TYPEHISTORY  _modeHistory)
inline

Set the TYPEHISTORY of this Selector.

Definition at line 59 of file FaceSelector.h.

Member Data Documentation

◆ modeHistory

template<typename T >
TYPEHISTORY FaceSelector< T >::modeHistory
protected

TYPEHISTORY used by this Selector (by default, HISTORY_FACE)

Definition at line 198 of file FaceSelector.h.

◆ selectedPath

template<typename T >
std::map<std::vector<unsigned int>, T*, CompareToKey> FaceSelector< T >::selectedPath
protected

Histories of all selected rays so far.

Definition at line 197 of file FaceSelector.h.


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