DtVrfMemberLineOfSightFunctor< T > Class Template Reference

template<typename T>
class DtVrfMemberLineOfSightFunctor< T >

DtVrfMemberLineOfSightFuncto provides an implementation of the DtVrfLineOfSightFunctor which wraps a single member function call.

Inheritance diagram for DtVrfMemberLineOfSightFunctor< T >:

Public Types
typedef bool(T::*	CheckLineOfSightFunction )(const DtVrfLineOfSightCheckParams &params) const

Public Member Functions
	DtVrfMemberLineOfSightFunctor (T *object, CheckLineOfSightFunction function)
virtual	~DtVrfMemberLineOfSightFunctor () override
virtual bool	operator() (const DtVrfLineOfSightCheckParams &params) override
Public Member Functions inherited from DtVrfLineOfSightFunctor
virtual	~DtVrfLineOfSightFunctor ()

Protected Attributes
T *	myObject
CheckLineOfSightFunction	myFunction

Member Typedef Documentation

template<typename T >

typedef bool(T::* DtVrfMemberLineOfSightFunctor< T >::CheckLineOfSightFunction)(const DtVrfLineOfSightCheckParams &params) const

The CheckLineOfSight Function signature.

Constructor & Destructor Documentation

template<typename T >

DtVrfMemberLineOfSightFunctor< T >::DtVrfMemberLineOfSightFunctor	(	T *	object,
		CheckLineOfSightFunction	function
	)

The Constructor. Creates a functor which will call the member function using the object passed in.

Parameters

Input
object	The object who will call its member function.
function	The member function of object to call.

Precondition

The object passed in must be valid.

Postcondition

<what will="" be="" true="" as="" a="" result="" of="" this="" function>="">

Warning

The lifetime of the object is not assured. It is safest to embed the functor in the host object itself or it's parent who can ensure it's life.

template<typename T >

virtual DtVrfMemberLineOfSightFunctor< T >::~DtVrfMemberLineOfSightFunctor ( )

overridevirtual

The Destructor.

Member Function Documentation

template<typename T >

virtual bool DtVrfMemberLineOfSightFunctor< T >::operator() ( const DtVrfLineOfSightCheckParams &  params )

overridevirtual

Function call operator which calls this stored object's stored member function.

Implements DtVrfLineOfSightFunctor.

Member Data Documentation

template<typename T >

T* DtVrfMemberLineOfSightFunctor< T >::myObject

protected

Pointer to my object.

template<typename T >

CheckLineOfSightFunction DtVrfMemberLineOfSightFunctor< T >::myFunction

protected

My function to call.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjcore/vrfLineOfSightFunctor.h