This class is a cxFunction that is templated to take 2 pointers of specific types. More...

#include <cxFunction.h>

Inheritance diagram for cx::cxFunction2Templated< T1, T2 >:

Collaboration diagram for cx::cxFunction2Templated< T1, T2 >:

Public Types
using	FuncPtr = std::string()(T1 , T2 *)

Public Member Functions
	cxFunction2Templated (FuncPtr pFuncPtr=nullptr, T1 pParam1=nullptr, T2 pParam2=nullptr, bool pUseReturnVal=false, bool pExitAfterRun=false, bool pRunOnLeaveFunction=true)
	Default constructor. All parameters have default values.

virtual	~cxFunction2Templated ()

virtual bool	functionIsSet () const override

void	setFunction (FuncPtr pFuncPtr)

FuncPtr	getFunction () const
	Accessor for the internal function pointer.

void	setParams (T1 pParam1, T2 pParam2)

void	setParam1 (T1 *pParam)

void	setParam2 (T2 *pParam)

T1 *	getParam1 () const

T2 *	getParam2 () const

virtual std::string	runFunction () const override

virtual void *	getFuncPtr () const override

virtual std::string	cxTypeStr () const override
	Returns the name of the cxWidgets class, "cxFunction2Templated". This can be.

Public Member Functions inherited from cx::cxFunction
	cxFunction (bool pUseReturnVal, bool pExitAfterRun, bool pRunOnLeaveFunction)
	Constructor.

virtual	~cxFunction ()

virtual bool	getUseReturnVal () const
	Accessor for whether the caller should use the return value.

virtual void	setUseReturnVal (bool pUseReturnVal)
	Setter for whether or not the caller should make use of the return value.

virtual bool	getExitAfterRun () const
	Accessor for whether the caller should exit after the function.

virtual void	setExitAfterRun (bool pExitAfterRun)
	Setter for whether or not the caller should quit what.

virtual bool	getRunOnLeaveFunction () const
	Accessor for whether the caller should run its onLeave function.

virtual void	setRunOnLeaveFunction (bool pRunOnLeaveFunction)
	Setter for whether or not the caller should run its.

Static Public Member Functions
static std::shared_ptr< cxFunction2Templated< T1, T2 > >	create (FuncPtr pFuncPtr, T1 pParam1, T2 pParam2, bool pUseReturnVal=false, bool pExitAfterRun=false, bool pRunOnLeaveFunction=true)
	Static create method for cxFunction2Templated. This is the recommended way to create a cxFunction2Templated, as it returns a shared pointer to the created object.

Detailed Description

template<typename T1, typename T2>
class cx::cxFunction2Templated< T1, T2 >

This class is a cxFunction that is templated to take 2 pointers of specific types.

Member Typedef Documentation

◆ FuncPtr

template<typename T1 , typename T2 >

using cx::cxFunction2Templated< T1, T2 >::FuncPtr = std::string (*)(T1 *, T2 *)

Constructor & Destructor Documentation

◆ cxFunction2Templated()

template<typename T1 , typename T2 >

cx::cxFunction2Templated< T1, T2 >::cxFunction2Templated	(	FuncPtr	pFuncPtr = `nullptr`,
		T1 *	pParam1 = `nullptr`,
		T2 *	pParam2 = `nullptr`,
		bool	pUseReturnVal = `false`,
		bool	pExitAfterRun = `false`,
		bool	pRunOnLeaveFunction = `true`
	)

inlineexplicit

Default constructor. All parameters have default values.

available. Note that function must have this signature:

string func(void*, void*)

Parameters

pFuncPtr	Pointer to the function to be run. Defaults to nullptr.
pParam1	The first parameter to pass to the function when it's run - This is a void pointer.
pParam2	The second parameter to pass to the function when it's run - This is a void pointer.
pUseReturnVal	Indicates whether caller will make use of return value. Defaults to false
pExitAfterRun	Whether or not the caller should exit from its input loop once the function is done. Defaults to false.
pRunOnLeaveFunction	Whether or not the caller should run its onLeave function when it exits (useful if pExitAfterRun is true). This defaults to true.

◆ ~cxFunction2Templated()

template<typename T1 , typename T2 >

virtual cx::cxFunction2Templated< T1, T2 >::~cxFunction2Templated ( )

inlinevirtual

Destructor

Member Function Documentation

◆ create()

template<typename T1 , typename T2 >

static std::shared_ptr< cxFunction2Templated< T1, T2 > > cx::cxFunction2Templated< T1, T2 >::create	(	FuncPtr	pFuncPtr,
		T1 *	pParam1,
		T2 *	pParam2,
		bool	pUseReturnVal = `false`,
		bool	pExitAfterRun = `false`,
		bool	pRunOnLeaveFunction = `true`
	)

inlinestatic

Static create method for cxFunction2Templated. This is the recommended way to create a cxFunction2Templated, as it returns a shared pointer to the created object.

◆ cxTypeStr()

template<typename T1 , typename T2 >

virtual std::string cx::cxFunction2Templated< T1, T2 >::cxTypeStr ( ) const

inlineoverridevirtual

Returns the name of the cxWidgets class, "cxFunction2Templated". This can be.

used to determine the type of cxWidgets object that deriving

classes derive from in applications.

Returns: The name of the cxWidgets class ("cxFunction2Templated").

Implements cx::cxFunction.

◆ functionIsSet()

template<typename T1 , typename T2 >

virtual bool cx::cxFunction2Templated< T1, T2 >::functionIsSet ( ) const

inlineoverridevirtual

Returns whether the internal funtion pointer is set.

Returns: Returns true if the internal function pointer is set (not null), or false otherwise.

Implements cx::cxFunction.

◆ getFuncPtr()

template<typename T1 , typename T2 >

virtual void * cx::cxFunction2Templated< T1, T2 >::getFuncPtr ( ) const

inlineoverridevirtual

Implements cx::cxFunction.

◆ getFunction()

template<typename T1 , typename T2 >

FuncPtr cx::cxFunction2Templated< T1, T2 >::getFunction ( ) const

inline

Accessor for the internal function pointer.

Returns: The internal function pointer

◆ getParam1()

template<typename T1 , typename T2 >

T1 * cx::cxFunction2Templated< T1, T2 >::getParam1 ( ) const

inline

Accessor for the first function parameter

Returns: Returns pointer to first parameter

◆ getParam2()

template<typename T1 , typename T2 >

T2 * cx::cxFunction2Templated< T1, T2 >::getParam2 ( ) const

inline

Accessor for the second function parameter

Returns: Returns pointer to second parameter

◆ runFunction()

template<typename T1 , typename T2 >

virtual std::string cx::cxFunction2Templated< T1, T2 >::runFunction ( ) const

inlineoverridevirtual

If function pointer is not null, runs the function and returns its return value; If function pointer is nullptr, returns empty string

Returns: Returns return value of function pointed to if pointer is not null, otherwise returns empty string

Implements cx::cxFunction.

◆ setFunction()

template<typename T1 , typename T2 >

void cx::cxFunction2Templated< T1, T2 >::setFunction ( FuncPtr pFuncPtr )

inline

Sets the internal function pointer

Parameters

pFuncPtr The function to which to point

◆ setParam1()

template<typename T1 , typename T2 >

void cx::cxFunction2Templated< T1, T2 >::setParam1 ( T1 * pParam )

inline

Sets the first parameter

Parameters

pParam First parameter to pass to function

◆ setParam2()

template<typename T1 , typename T2 >

void cx::cxFunction2Templated< T1, T2 >::setParam2 ( T2 * pParam )

inline

Sets the second parameter

Parameters

pParam Second parameter to pass to function

◆ setParams()

template<typename T1 , typename T2 >

void cx::cxFunction2Templated< T1, T2 >::setParams	(	T1 *	pParam1,
		T2 *	pParam2
	)

inline

Sets the parameters to pass to the function.

Parameters

pParam1	First parameter to pass to function
pParam2	Second parameter to pass to function

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

/home/erico/projects/cxWidgets/src/cxFunction.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ FuncPtr

Constructor & Destructor Documentation

◆ cxFunction2Templated()

◆ ~cxFunction2Templated()

Member Function Documentation

◆ create()

◆ cxTypeStr()

◆ functionIsSet()

◆ getFuncPtr()

◆ getFunction()

◆ getParam1()

◆ getParam2()

◆ runFunction()

◆ setFunction()

◆ setParam1()

◆ setParam2()

◆ setParams()