Swarm::DataFunctionCall< _Data > Class Template Reference

Function which can be called in a Daemon. More...

#include <DataFunctionCall.h>

Inheritance diagram for Swarm::DataFunctionCall< _Data >:

Collaboration diagram for Swarm::DataFunctionCall< _Data >:

Public Member Functions
virtual bool	call (PLog &log, const Swarm::Data &data)
	Call the function with parameter.
	DataFunctionCall (PUncastableBool(*function)(const _Data &), const PString &name)
	Default constructor of DataFunctionCall.
const PString &	getName () const
	Name of the function.
const PString &	getPrototype () const
	Get the prototype of the current function.
void	setName (const PString &name)
	Set the name of the function.
void	setPrototype (const PString &prototype)
	Set the prototype of the current function.
virtual	~DataFunctionCall ()
	Destructor of DataFunctionCall.

Protected Member Functions
void	initialisationDataFunctionCall ()
	Initialisation function of the class DataFunctionCall.

Protected Attributes
PUncastableBool(*	p_function )(const _Data &)
	Callable function of the DataFunctionCall.

Private Member Functions
void	initialisationAbstractDataFunction (const PString &name)
	Initialisation function of the class AbstractDataFunction.

Private Attributes
PString	p_name
	Name of the function.
PString	p_prototype
	Prototype of the function.

Detailed Description

template<typename _Data>
class Swarm::DataFunctionCall< _Data >

Function which can be called in a Daemon.

Definition at line 14 of file DataFunctionCall.h.

Constructor & Destructor Documentation

DataFunctionCall()

template<typename _Data>

DataFunctionCall::DataFunctionCall	(	PUncastableBool(*	function )(const _Data &),
		const PString &	name )

Default constructor of DataFunctionCall.

Parameters

function	: function to be called on a given data
name	: name of the function

Definition at line 21 of file DataFunctionCall_impl.h.

        :AbstractDataFunction(name), p_function(function)
{
        //The prototype is compose only of the given data which is normal for dispatching
        setPrototype(phoenix_getTypeToStr<_Data>());
        initialisationDataFunctionCall();
}

References Swarm::AbstractDataFunction::AbstractDataFunction(), initialisationDataFunctionCall(), p_function, and Swarm::AbstractDataFunction::setPrototype().

Here is the call graph for this function:

~DataFunctionCall()

template<typename _Data>

DataFunctionCall::~DataFunctionCall ( )

virtual

Destructor of DataFunctionCall.

Definition at line 31 of file DataFunctionCall_impl.h.

                                          {
        
}

Member Function Documentation

call()

template<typename _Data>

bool DataFunctionCall::call ( PLog & log, const Swarm::Data & data )

virtual

Call the function with parameter.

Parameters

[out]	log	: logger
	data	: data given to the function

Returns

true on success, false otherwise

Implements Swarm::AbstractDataFunction.

Definition at line 41 of file DataFunctionCall_impl.h.

                                                               {
        _Data value(phoenix_getValueFromData<_Data>(data));
        if(p_function(value) == UNCASTABLE_TRUE){
                log.getLogDebug() << "DataFunctionCall<_Data>::call : function 'bool '"<<getName()<<"(const "<<getPrototype()<<" &) success" << std::endl;
                return true;
        }else{
                log.getLogError() << "DataFunctionCall<_Data>::call : function 'bool '"<<getName()<<"(const "<<getPrototype()<<" &) failed" << std::endl;
                return false;
        }
}

References Swarm::AbstractDataFunction::getName(), Swarm::AbstractDataFunction::getPrototype(), p_function, and phoenix_getValueFromData().

Here is the call graph for this function:

getName()

const PString & AbstractDataFunction::getName ( ) const

inherited

Name of the function.

Returns

name of the function

Definition at line 33 of file AbstractDataFunction.cpp.

                                                   {
        return p_name;
}

References p_name.

Referenced by Swarm::DataFunctionCall< _Data >::call(), and Swarm::DataFunctionClassCall< _Class, _Data >::call().

Here is the caller graph for this function:

getPrototype()

const PString & AbstractDataFunction::getPrototype ( ) const

inherited

Get the prototype of the current function.

Returns

prototype of the current function

Definition at line 47 of file AbstractDataFunction.cpp.

                                                        {
        return p_prototype;
}

References p_prototype.

Referenced by Swarm::DataFunctionCall< _Data >::call(), and Swarm::DataFunctionClassCall< _Class, _Data >::call().

Here is the caller graph for this function:

initialisationAbstractDataFunction()

void AbstractDataFunction::initialisationAbstractDataFunction ( const PString & name )

privateinherited

Initialisation function of the class AbstractDataFunction.

Parameters

name	: name of the function

Definition at line 54 of file AbstractDataFunction.cpp.

                                                                                 {
        p_name = name;
        p_prototype = name;
}

References p_name, and p_prototype.

Referenced by AbstractDataFunction().

Here is the caller graph for this function:

initialisationDataFunctionCall()

template<typename _Data>

void DataFunctionCall::initialisationDataFunctionCall ( )

protected

Initialisation function of the class DataFunctionCall.

Definition at line 54 of file DataFunctionCall_impl.h.

                                                            {
        
}

Referenced by DataFunctionCall().

Here is the caller graph for this function:

setName()

void AbstractDataFunction::setName ( const PString & name )

inherited

Set the name of the function.

Parameters

name	: name of the function

Definition at line 26 of file AbstractDataFunction.cpp.

                                                      {
        p_name = name;
}

References p_name.

setPrototype()

void AbstractDataFunction::setPrototype ( const PString & prototype )

inherited

Set the prototype of the current function.

Parameters

prototype

: prototype of the current function

Definition at line 40 of file AbstractDataFunction.cpp.

                                                                {
        p_prototype = prototype;
}

References p_prototype.

Referenced by Swarm::DataFunctionCall< _Data >::DataFunctionCall().

Here is the caller graph for this function:

Member Data Documentation

p_function

template<typename _Data>

PUncastableBool(* Swarm::DataFunctionCall< _Data >::p_function) (const _Data &)

protected

Callable function of the DataFunctionCall.

Definition at line 25 of file DataFunctionCall.h.

Referenced by call(), and DataFunctionCall().

p_name

PString Swarm::AbstractDataFunction::p_name

privateinherited

Name of the function.

Definition at line 33 of file AbstractDataFunction.h.

Referenced by getName(), initialisationAbstractDataFunction(), and setName().

p_prototype

PString Swarm::AbstractDataFunction::p_prototype

privateinherited

Prototype of the function.

Definition at line 35 of file AbstractDataFunction.h.

Referenced by getPrototype(), initialisationAbstractDataFunction(), and setPrototype().

---

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

• /builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixSwarm/src/Function/DataFunctionCall.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixSwarm/src/Function/DataFunctionCall_impl.h