Specialization of FunctorMember with T = void. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/libraries/core/command/Functor.h>

Inheritance diagram for orxonox::FunctorMember< void >:

Public Member Functions
	FunctorMember (void *object=nullptr)
	Constructor: Stores the object-pointer. More...

virtual void *	getRawObjectPointer () const override
	Returns the object-pointer. More...

virtual Functor::Type	getType () const override
	Returns the type of the function: static or member. More...

virtual MultiType	operator() (void *object, const MultiType &param1=MultiType::Null, const MultiType &param2=MultiType::Null, const MultiType &param3=MultiType::Null, const MultiType &param4=MultiType::Null, const MultiType &param5=MultiType::Null)=0
	Calls the function-pointer with up to five arguments and an object. In case of a static-function, the object can be nullptr. More...

virtual MultiType	operator() (const MultiType &param1=MultiType::Null, const MultiType &param2=MultiType::Null, const MultiType &param3=MultiType::Null, const MultiType &param4=MultiType::Null, const MultiType &param5=MultiType::Null) override
	Calls the function-pointer with up to five arguments. In case of a member-function, the assigned object-pointer is used to call the function. More...

virtual void	setRawObjectPointer (void *) override
	Assigns an object-pointer to the functor which is used to execute a member-function. More...

virtual void	setSafeMode (bool) override
	Enables or disables the safe mode which causes the functor to change the object pointer to nullptr if the object is deleted (only member functors). More...

Public Member Functions inherited from orxonox::Functor
virtual	~Functor ()=default

virtual FunctorPtr	clone ()=0
	Creates a new instance of Functor with the same values like this (used instead of a copy-constructor) More...

virtual void	evaluateArgument (unsigned int index, MultiType &argument) const =0
	Converts a given argument to the type of the parameter with given index (the first parameter has index 0). More...

virtual const std::type_info &	getFullIdentifier () const =0
	Returns the full identifier of the function-pointer which is defined as typeid(F), where F is the type of the stored function-pointer. Used to compare functors. More...

virtual const std::type_info &	getHeaderIdentifier () const =0
	Returns an identifier of the header of the function (doesn't include the function's class). Used to compare functors. More...

virtual const std::type_info &	getHeaderIdentifier (unsigned int params) const =0
	Returns an identifier of the header of the function (doesn't include the function's class), but regards only the first params parameters. Used to compare functions if an Executor provides default-values for the other parameters. More...

virtual unsigned int	getParamCount () const =0
	Returns the number of parameters of the function. More...

virtual std::string	getTypenameParam (unsigned int index) const =0
	Returns the type-name of the parameter with given index (the first parameter has index 0). More...

virtual std::string	getTypenameReturnvalue () const =0
	Returns the type-name of the return-value. More...

virtual bool	hasReturnvalue () const =0
	Returns true if the function has a return-value. More...

Additional Inherited Members
Public Types inherited from orxonox::Functor
enum	Type { Type::Static, Type::Member }
	Defines the type of a function (static or member) More...

Detailed Description

template<>
class orxonox::FunctorMember< void >

Specialization of FunctorMember with T = void.

Constructor & Destructor Documentation

orxonox::FunctorMember< void >::FunctorMember ( void * object = nullptr )

inline

Constructor: Stores the object-pointer.

Member Function Documentation

virtual void* orxonox::FunctorMember< void >::getRawObjectPointer ( ) const

inlineoverridevirtual

Returns the object-pointer.

Implements orxonox::Functor.

virtual Functor::Type orxonox::FunctorMember< void >::getType ( ) const

inlineoverridevirtual

Returns the type of the function: static or member.

Implements orxonox::Functor.

virtual MultiType orxonox::FunctorMember< void >::operator()	(	void *	object,
		const MultiType &	param1 = `MultiType::Null`,
		const MultiType &	param2 = `MultiType::Null`,
		const MultiType &	param3 = `MultiType::Null`,
		const MultiType &	param4 = `MultiType::Null`,
		const MultiType &	param5 = `MultiType::Null`
	)

pure virtual

Calls the function-pointer with up to five arguments and an object. In case of a static-function, the object can be nullptr.

Returns: Returns the return-value of the function (if any; MultiType::Null otherwise)

virtual MultiType orxonox::FunctorMember< void >::operator()	(	const MultiType &	param1 = `MultiType::Null`,
		const MultiType &	param2 = `MultiType::Null`,
		const MultiType &	param3 = `MultiType::Null`,
		const MultiType &	param4 = `MultiType::Null`,
		const MultiType &	param5 = `MultiType::Null`
	)

inlineoverridevirtual

Calls the function-pointer with up to five arguments. In case of a member-function, the assigned object-pointer is used to call the function.

Returns: Returns the return-value of the function (if any; MultiType::Null otherwise)

Implements orxonox::Functor.

virtual void orxonox::FunctorMember< void >::setRawObjectPointer ( void * object )

inlineoverridevirtual

Assigns an object-pointer to the functor which is used to execute a member-function.

Implements orxonox::Functor.

virtual void orxonox::FunctorMember< void >::setSafeMode ( bool bSafeMode )

inlineoverridevirtual

Enables or disables the safe mode which causes the functor to change the object pointer to nullptr if the object is deleted (only member functors).

Implements orxonox::Functor.

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

libraries/core/command/Functor.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<> class orxonox::FunctorMember< void >

Constructor & Destructor Documentation

Member Function Documentation

template<>
class orxonox::FunctorMember< void >