Swarm::AbstractDataFunction Class Reference

Abstract function definition which will be callable in Daemon. More...

#include <AbstractDataFunction.h>

Inheritance diagram for Swarm::AbstractDataFunction:

Public Member Functions
	AbstractDataFunction (const PString &name)
	Default constructor of AbstractDataFunction.
virtual bool	call (PLog &log, const Swarm::Data &data)=0
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	~AbstractDataFunction ()
	Destructor of AbstractDataFunction.

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

Abstract function definition which will be callable in Daemon.

Definition at line 16 of file AbstractDataFunction.h.

Constructor & Destructor Documentation

AbstractDataFunction()

AbstractDataFunction::AbstractDataFunction

(

const PString &

name

)

Default constructor of AbstractDataFunction.

Parameters

name	: name of the function

Definition at line 14 of file AbstractDataFunction.cpp.

                                                              {
        initialisationAbstractDataFunction(name);
}

References initialisationAbstractDataFunction().

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

Here is the call graph for this function:

Here is the caller graph for this function:

~AbstractDataFunction()

AbstractDataFunction::~AbstractDataFunction ( )

virtual

Destructor of AbstractDataFunction.

Definition at line 19 of file AbstractDataFunction.cpp.

                                           {
        
}

Member Function Documentation

call()

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

pure virtual

Implemented in Swarm::DataFunctionCall< _Data >, and Swarm::DataFunctionClassCall< _Class, _Data >.

Referenced by Swarm::BaseDaemon::processData(), and Swarm::Daemon< _TBackend >::processInputMessage().

Here is the caller graph for this function:

getName()

const PString & AbstractDataFunction::getName

(

)

const

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

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 )

private

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:

setName()

void AbstractDataFunction::setName

(

const PString &

name

)

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

)

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_name

PString Swarm::AbstractDataFunction::p_name

private

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

private

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/AbstractDataFunction.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixSwarm/src/Function/AbstractDataFunction.cpp