TYAbstractReflectionPathFinder Class Reference

Interface for multiple reflection paths computation algorithms. More...

#include <TYReflectionPathFinder.h>

Inheritance diagram for TYAbstractReflectionPathFinder:

Public Member Functions
virtual	~TYAbstractReflectionPathFinder ()=default
virtual std::unique_ptr< TYAbstractReflectionPathFinder >	instanciate () const =0
	Instanciate a new reflection path finder of the same type. More...
virtual bool	setup (size_t maxOrder, const std::deque< TYSIntersection > &tabIntersect, const OPoint3D &source, const OPoint3D &receptor)=0
	Set the scene to be treated by the path finder. More...
virtual bool	remainingPaths () const =0
	Tell if some paths remain in the set of remaining paths. More...
virtual TYReflectionPath	popPath ()=0
	Give the last computed reflection path, and remove it from the set of remaining paths. More...

Protected Member Functions
	TYAbstractReflectionPathFinder ()=default

Detailed Description

Interface for multiple reflection paths computation algorithms.

Definition at line 39 of file TYReflectionPathFinder.h.

Constructor & Destructor Documentation

~TYAbstractReflectionPathFinder()

virtual TYAbstractReflectionPathFinder::~TYAbstractReflectionPathFinder ( )

virtualdefault

TYAbstractReflectionPathFinder()

TYAbstractReflectionPathFinder::TYAbstractReflectionPathFinder ( )

protecteddefault

Member Function Documentation

instanciate()

virtual std::unique_ptr<TYAbstractReflectionPathFinder> TYAbstractReflectionPathFinder::instanciate ( ) const

pure virtual

Instanciate a new reflection path finder of the same type.

Implemented in TYReflectionPathFinderART.

popPath()

virtual TYReflectionPath TYAbstractReflectionPathFinder::popPath ( )

pure virtual

Give the last computed reflection path, and remove it from the set of remaining paths.

Returns

a reflection path

Implemented in TYReflectionPathFinderART.

remainingPaths()

virtual bool TYAbstractReflectionPathFinder::remainingPaths ( ) const

pure virtual

Tell if some paths remain in the set of remaining paths.

Returns

true if at least one path can be obtained from popPath

Implemented in TYReflectionPathFinderART.

setup()

virtual bool TYAbstractReflectionPathFinder::setup ( size_t  maxOrder, const std::deque< TYSIntersection > &  tabIntersect, const OPoint3D &  source, const OPoint3D &  receptor  )

pure virtual

Set the scene to be treated by the path finder.

Parameters

maxOrder	maximum order of the reflection paths to find
tabIntersect	set of intersecting segments of the scene
source	source point from which reflection paths must start
receptor	receptor point to which reflection paths must end

Returns

true if setup succeeded

Implemented in TYReflectionPathFinderART.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/code-tympan/checkouts/issue_1033/Tympan/solvers/9613/9613Solver2024/TYReflectionPathFinder.h