Swarm::AbstractFunction Class Reference

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

#include <AbstractFunction.h>

Inheritance diagram for Swarm::AbstractFunction:

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

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

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 15 of file AbstractFunction.h.

Constructor & Destructor Documentation

AbstractFunction()

AbstractFunction::AbstractFunction

(

const PString &

name

)

Default constructor of AbstractFunction.

Parameters

name	: name of the function

Definition at line 14 of file AbstractFunction.cpp.

                                                      {
        initialisationAbstractFunction(name);
}

References initialisationAbstractFunction().

Referenced by Swarm::FunctionCall< _Callable >::FunctionCall().

Here is the call graph for this function:

Here is the caller graph for this function:

~AbstractFunction()

AbstractFunction::~AbstractFunction ( )

virtual

Destructor of AbstractFunction.

Definition at line 19 of file AbstractFunction.cpp.

                                   {
        
}

Member Function Documentation

call()

virtual bool Swarm::AbstractFunction::call ( PLog & log, Swarm::Data & outputResult, const Swarm::Data & parameter )

pure virtual

Implemented in Swarm::FunctionCall< _Callable >.

getName()

const PString & AbstractFunction::getName

(

)

const

Name of the function.

Returns

name of the function

Definition at line 33 of file AbstractFunction.cpp.

                                               {
        return p_name;
}

References p_name.

getPrototype()

const PString & AbstractFunction::getPrototype

(

)

const

Get the prototype of the current function.

Returns

prototype of the current function

Definition at line 47 of file AbstractFunction.cpp.

                                                    {
        return p_prototype;
}

References p_prototype.

initialisationAbstractFunction()

void AbstractFunction::initialisationAbstractFunction ( const PString & name )

private

Initialisation function of the class AbstractFunction.

Parameters

name	: name of the function

Definition at line 54 of file AbstractFunction.cpp.

                                                                         {
        p_name = name;
}

References p_name.

Referenced by AbstractFunction().

Here is the caller graph for this function:

setName()

void AbstractFunction::setName

(

const PString &

name

)

Set the name of the function.

Parameters

name	: name of the function

Definition at line 26 of file AbstractFunction.cpp.

                                                  {
        p_name = name;
}

References p_name.

setPrototype()

void AbstractFunction::setPrototype

(

const PString &

prototype

)

Set the prototype of the current function.

Parameters

prototype

: prototype of the current function

Definition at line 40 of file AbstractFunction.cpp.

                                                            {
        p_prototype = prototype;
}

References p_prototype.

Referenced by Swarm::FunctionCall< _Callable >::FunctionCall().

Here is the caller graph for this function:

Member Data Documentation

p_name

PString Swarm::AbstractFunction::p_name

private

Name of the function.

Definition at line 32 of file AbstractFunction.h.

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

p_prototype

PString Swarm::AbstractFunction::p_prototype

private

Prototype of the function.

Definition at line 34 of file AbstractFunction.h.

Referenced by getPrototype(), and setPrototype().

---

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

• /builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixSwarm/src/Function/AbstractFunction.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixSwarm/src/Function/AbstractFunction.cpp