DtVrfMemberLineOfSightFunctor< T > Class Template Reference

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

Inheritance diagram for DtVrfMemberLineOfSightFunctor< T >:

Public Types
typedef bool(T::*	CheckLineOfSightFunction )(const DtVrfLineOfSightCheckParams &params) const
	The CheckLineOfSight Function signature. More...

Public Member Functions
	DtVrfMemberLineOfSightFunctor (T *object, CheckLineOfSightFunction function)
	The Constructor. More...
virtual	~DtVrfMemberLineOfSightFunctor ()
	The Destructor. More...
virtual bool	operator() (const DtVrfLineOfSightCheckParams &params)
	Function call operator which calls this stored object's stored member function. More...
Public Member Functions inherited from DtVrfLineOfSightFunctor
virtual	~DtVrfLineOfSightFunctor ()
	Virtual Destructor which does nothing. More...

Protected Attributes
T *	myObject
	Pointer to my object. More...
CheckLineOfSightFunction	myFunction
	My function to call. More...

Detailed Description

template<typename T>
class DtVrfMemberLineOfSightFunctor< T >

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

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

virtual

The Destructor.

Member Function Documentation

template<typename T >

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

virtual

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.vrf4-10-branch/include/vrfobjcore/vrfLineOfSightFunctor.h