Om: om::lang::Function< R(T1) > Class Template Reference

Om 1.0.0

A universal framework for multimedia simulation

Specialization of the function template class for a method with 1 parameter. More...

#include <omFunction.h>

Public Types
typedef R	ReturnType
	The return type of this function object. More...

typedef T1	ParameterType1
	The type of the first parameter of this function object. More...

Public Member Functions
	Function ()
	Create a new default function object with a NULL function pointer. More...

	Function (R(*functionPointer)(T1))
	Create a new function object that wraps the specified non-member function pointer. More...

template<typename ObjectType , typename ObjectType2 >
	Function (R(ObjectType2::functionPointer)(T1), ObjectType objectPointer)
	Create a new function object that wraps the specified object and member function pointer. More...

template<typename ObjectType , typename ObjectType2 >
	Function (R(ObjectType2::functionPointer)(T1) const, const ObjectType objectPointer)
	Create a new function object that wraps the specified object and const member function pointer. More...

ReturnType	operator() (T1 p1) const
	Call this function and return its return value. More...

Bool	operator== (const Function &other) const
	Return whether or not this function references the same function as another function object. More...

Bool	operator!= (const Function &other) const
	Return whether or not this function references a different function as onother function object. More...

Bool	isNull () const
	Return whether or not this function object has a function/object pointer that is NULL. More...

Bool	isSet () const
	Return whether or not this function object has a function/object pointer that is not NULL. More...

Bool	isMember () const
	Return whether or not this function object refers to a member function of a class object. More...

Detailed Description

template<typename R, typename T1>
class om::lang::Function< R(T1) >

Specialization of the function template class for a method with 1 parameter.

Member Typedef Documentation

template<typename R , typename T1 >

typedef R om::lang::Function< R(T1) >::ReturnType

The return type of this function object.

template<typename R , typename T1 >

typedef T1 om::lang::Function< R(T1) >::ParameterType1

The type of the first parameter of this function object.

Constructor & Destructor Documentation

template<typename R , typename T1 >

om::lang::Function< R(T1) >::Function ( )

inline

Create a new default function object with a NULL function pointer.

template<typename R , typename T1 >

om::lang::Function< R(T1) >::Function ( R(*)(T1) functionPointer )

inline

Create a new function object that wraps the specified non-member function pointer.

template<typename R , typename T1 >

template<typename ObjectType , typename ObjectType2 >

om::lang::Function< R(T1) >::Function	(	R(ObjectType2::*)(T1)	functionPointer,
		ObjectType *	objectPointer
	)

inline

Create a new function object that wraps the specified object and member function pointer.

template<typename R , typename T1 >

template<typename ObjectType , typename ObjectType2 >

om::lang::Function< R(T1) >::Function	(	R(ObjectType2::*)(T1) const	functionPointer,
		const ObjectType *	objectPointer
	)

inline

Create a new function object that wraps the specified object and const member function pointer.

Member Function Documentation

template<typename R , typename T1 >

ReturnType om::lang::Function< R(T1) >::operator() ( T1 p1 ) const

inline

Call this function and return its return value.

Calling a NULL function object will cause an assertion to be raised.

template<typename R , typename T1 >

Bool om::lang::Function< R(T1) >::operator== ( const Function< R(T1) > & other ) const

inline

Return whether or not this function references the same function as another function object.

template<typename R , typename T1 >

Bool om::lang::Function< R(T1) >::operator!= ( const Function< R(T1) > & other ) const

inline

Return whether or not this function references a different function as onother function object.

template<typename R , typename T1 >

Bool om::lang::Function< R(T1) >::isNull ( ) const

inline

Return whether or not this function object has a function/object pointer that is NULL.

If this method returns TRUE, calling the function will result in an assertion being raised.

template<typename R , typename T1 >

Bool om::lang::Function< R(T1) >::isSet ( ) const

inline

Return whether or not this function object has a function/object pointer that is not NULL.

If this method returns FALSE, calling the function will result in an assertion being raised.

template<typename R , typename T1 >

Bool om::lang::Function< R(T1) >::isMember ( ) const

inline

Return whether or not this function object refers to a member function of a class object.

Member Data Documentation

template<typename R , typename T1 >

void* om::lang::Function< R(T1) >::object

A pointer to the object that receives the member function call.

template<typename R , typename T1 >

R(* om::lang::Function< R(T1) >::staticFunctionPointer) (T1)

A non-member function pointer to use when the function object represents a non-member function.

template<typename R , typename T1 >

UByte om::lang::Function< R(T1) >::memberFunctionStorage[MEMBER_FUNCTION_STORAGE_SIZE]

A local buffer of bytes that stores an opaque member function.

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

omFunction.h