Functor for a global function with 5 parameters and return value. More...

#include <ArFunctor.h>

Inherits ArRetFunctor5< Ret, P1, P2, P3, P4, P5 >.

Public Member Functions
	ArGlobalRetFunctor5 ()
	Constructor.

	ArGlobalRetFunctor5 (Ret(*func)(P1, P2, P3, P4, P5))
	Constructor - supply function pointer. More...

	ArGlobalRetFunctor5 (Ret(*func)(P1, P2, P3, P4, P5), P1 p1)
	Constructor - supply function pointer, default parameters. More...

	ArGlobalRetFunctor5 (Ret(*func)(P1, P2, P3, P4, P5), P1 p1, P2 p2)
	Constructor - supply function pointer, default parameters. More...

	ArGlobalRetFunctor5 (Ret(*func)(P1, P2, P3, P4, P5), P1 p1, P2 p2, P3 p3)
	Constructor - supply function pointer, default parameters. More...

	ArGlobalRetFunctor5 (Ret(*func)(P1, P2, P3, P4, P5), P1 p1, P2 p2, P3 p3, P4 p4)
	Constructor - supply function pointer, default parameters. More...

	ArGlobalRetFunctor5 (Ret(*func)(P1, P2, P3, P4, P5), P1 p1, P2 p2, P3 p3, P4 p4, P5 p5)

virtual Ret	invokeR (void)
	Invokes the functor with return value.

virtual Ret	invokeR (P1 p1)
	Invokes the functor with return value. More...

virtual Ret	invokeR (P1 p1, P2 p2)
	Invokes the functor with return value. More...

virtual Ret	invokeR (P1 p1, P2 p2, P3 p3)
	Invokes the functor with return value. More...

virtual Ret	invokeR (P1 p1, P2 p2, P3 p3, P4 p4)
	Invokes the functor with return value. More...

virtual Ret	invokeR (P1 p1, P2 p2, P3 p3, P4 p4, P5 p5)
	Invokes the functor with return value. More...

virtual void	setP1 (P1 p1)
	Set the default parameter. More...

virtual void	setP2 (P2 p2)
	Set the default 2nd parameter. More...

virtual void	setP3 (P3 p3)
	Set the default third parameter. More...

virtual void	setP4 (P4 p4)
	Set the default fourth parameter. More...

virtual void	setP5 (P5 p5)
	Set the default fifth parameter. More...

virtual	~ArGlobalRetFunctor5 ()
	Destructor.

Public Member Functions inherited from ArRetFunctor5< Ret, P1, P2, P3, P4, P5 >
virtual	~ArRetFunctor5 ()
	Destructor.

Public Member Functions inherited from ArRetFunctor4< Ret, P1, P2, P3, P4 >
virtual	~ArRetFunctor4 ()
	Destructor.

Public Member Functions inherited from ArRetFunctor3< Ret, P1, P2, P3 >
virtual	~ArRetFunctor3 ()
	Destructor.

Public Member Functions inherited from ArRetFunctor2< Ret, P1, P2 >
virtual	~ArRetFunctor2 ()
	Destructor.

Public Member Functions inherited from ArRetFunctor1< Ret, P1 >
virtual	~ArRetFunctor1 ()
	Destructor.

Public Member Functions inherited from ArRetFunctor< Ret >
virtual void	invoke (void)
	Invokes the functor.

virtual	~ArRetFunctor ()
	Destructor.

Public Member Functions inherited from ArFunctor
virtual const char *	getName (void)
	Gets the name of the functor.

virtual void	setName (const char *name)
	Sets the name of the functor.

virtual void	setNameVar (const char *name,...)
	Sets the name of the functor with formatting. More...

virtual	~ArFunctor ()
	Destructor.

Protected Attributes
Ret(*	myFunc )(P1, P2, P3, P4, P5)

P1	myP1

P2	myP2

P3	myP3

P4	myP4

P5	myP5

Protected Attributes inherited from ArFunctor
std::string	myName

Detailed Description

template<class Ret, class P1, class P2, class P3, class P4, class P5>
class ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >

Functor for a global function with 5 parameters and return value.

This is a class for global functions which take 5 parameters and return a value. This ties a C style function pointer into the functor class hierarchy as a convience. Code that has a reference to this class and treat it as an ArFunctor can use it like any other functor.

For an overall description of functors, see ArFunctor.

Constructor & Destructor Documentation

◆ ArGlobalRetFunctor5() [1/6]

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::ArGlobalRetFunctor5 ( Ret(*)(P1, P2, P3, P4, P5) func )

inline

Constructor - supply function pointer.

Parameters

func	global function pointer

◆ ArGlobalRetFunctor5() [2/6]

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::ArGlobalRetFunctor5	(	Ret(*)(P1, P2, P3, P4, P5)	func,
		P1	p1
	)

inline

Constructor - supply function pointer, default parameters.

Parameters

func	global function pointer
p1	default first parameter

◆ ArGlobalRetFunctor5() [3/6]

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::ArGlobalRetFunctor5	(	Ret(*)(P1, P2, P3, P4, P5)	func,
		P1	p1,
		P2	p2
	)

inline

Constructor - supply function pointer, default parameters.

Parameters

func	global function pointer
p1	default first parameter
p2	default second parameter

◆ ArGlobalRetFunctor5() [4/6]

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::ArGlobalRetFunctor5	(	Ret(*)(P1, P2, P3, P4, P5)	func,
		P1	p1,
		P2	p2,
		P3	p3
	)

inline

Constructor - supply function pointer, default parameters.

Parameters

func	global function pointer
p1	default first parameter
p2	default second parameter
p3	default third parameter

◆ ArGlobalRetFunctor5() [5/6]

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::ArGlobalRetFunctor5	(	Ret(*)(P1, P2, P3, P4, P5)	func,
		P1	p1,
		P2	p2,
		P3	p3,
		P4	p4
	)

inline

Constructor - supply function pointer, default parameters.

Parameters

func	global function pointer
p1	default first parameter
p2	default second parameter
p3	default third parameter
p4	default fourth parameter

◆ ArGlobalRetFunctor5() [6/6]

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::ArGlobalRetFunctor5	(	Ret(*)(P1, P2, P3, P4, P5)	func,
		P1	p1,
		P2	p2,
		P3	p3,
		P4	p4,
		P5	p5
	)

inline

Parameters

func	global function pointer
p1	default first parameter
p2	default second parameter
p3	default third parameter
p4	default fourth parameter
p5	default fifth parameter

Member Function Documentation

◆ invokeR() [1/5]

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

virtual Ret ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::invokeR ( P1 p1 )

inlinevirtual

Invokes the functor with return value.

Parameters

p1	first parameter

Implements ArRetFunctor5< Ret, P1, P2, P3, P4, P5 >.

◆ invokeR() [2/5]

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

virtual Ret ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::invokeR	(	P1	p1,
		P2	p2
	)

inlinevirtual

Invokes the functor with return value.

Parameters

p1	first parameter
p2	second parameter

Implements ArRetFunctor5< Ret, P1, P2, P3, P4, P5 >.

◆ invokeR() [3/5]

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

virtual Ret ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::invokeR	(	P1	p1,
		P2	p2,
		P3	p3
	)

inlinevirtual

Invokes the functor with return value.

Parameters

p1	first parameter
p2	second parameter
p3	third parameter

Implements ArRetFunctor5< Ret, P1, P2, P3, P4, P5 >.

◆ invokeR() [4/5]

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

virtual Ret ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::invokeR	(	P1	p1,
		P2	p2,
		P3	p3,
		P4	p4
	)

inlinevirtual

Invokes the functor with return value.

Parameters

p1	first parameter
p2	second parameter
p3	third parameter
p4	fourth parameter

Implements ArRetFunctor5< Ret, P1, P2, P3, P4, P5 >.

◆ invokeR() [5/5]

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

virtual Ret ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::invokeR	(	P1	p1,
		P2	p2,
		P3	p3,
		P4	p4,
		P5	p5
	)

inlinevirtual

Invokes the functor with return value.

Parameters

p1	first parameter
p2	second parameter
p3	third parameter
p4	fourth parameter
p5	fifth parameter

Implements ArRetFunctor5< Ret, P1, P2, P3, P4, P5 >.

◆ setP1()

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

virtual void ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::setP1 ( P1 p1 )

inlinevirtual

Set the default parameter.

Parameters

p1	default first parameter

◆ setP2()

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

virtual void ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::setP2 ( P2 p2 )

inlinevirtual

Set the default 2nd parameter.

Parameters

p2	default second parameter

◆ setP3()

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

virtual void ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::setP3 ( P3 p3 )

inlinevirtual

Set the default third parameter.

Parameters

p3	default third parameter

◆ setP4()

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

virtual void ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::setP4 ( P4 p4 )

inlinevirtual

Set the default fourth parameter.

Parameters

p4	default fourth parameter

◆ setP5()

template<class Ret , class P1 , class P2 , class P3 , class P4 , class P5 >

virtual void ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >::setP5 ( P5 p5 )

inlinevirtual

Set the default fifth parameter.

Parameters

p4	default fifth parameter

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

ArFunctor.h

Public Member Functions

Protected Attributes

Detailed Description

template<class Ret, class P1, class P2, class P3, class P4, class P5> class ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >

Constructor & Destructor Documentation

◆ ArGlobalRetFunctor5() [1/6]

◆ ArGlobalRetFunctor5() [2/6]

◆ ArGlobalRetFunctor5() [3/6]

◆ ArGlobalRetFunctor5() [4/6]

◆ ArGlobalRetFunctor5() [5/6]

◆ ArGlobalRetFunctor5() [6/6]

Member Function Documentation

◆ invokeR() [1/5]

◆ invokeR() [2/5]

◆ invokeR() [3/5]

◆ invokeR() [4/5]

◆ invokeR() [5/5]

◆ setP1()

◆ setP2()

◆ setP3()

◆ setP4()

◆ setP5()

template<class Ret, class P1, class P2, class P3, class P4, class P5>
class ArGlobalRetFunctor5< Ret, P1, P2, P3, P4, P5 >