PhoenixSwarm  3.5.0
Library to ease communication between daemons
Loading...
Searching...
No Matches
AbstractFunction Class Referenceabstract

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

#include <AbstractFunction.h>

+ Inheritance diagram for AbstractFunction:

Public Member Functions

 AbstractFunction (const PString &name)
 Default constructor of AbstractFunction.
 
virtual bool call (PLog &log, Data &outputResult, const 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 14 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 15 of file AbstractFunction.cpp.

15 {
17}
void initialisationAbstractFunction(const PString &name)
Initialisation function of the class AbstractFunction.

References initialisationAbstractFunction().

Referenced by 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 20 of file AbstractFunction.cpp.

20 {
21
22}

Member Function Documentation

◆ call()

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

Implemented in FunctionCall< _Callable >.

◆ getName()

const PString & AbstractFunction::getName ( ) const

Name of the function.

Returns
name of the function

Definition at line 34 of file AbstractFunction.cpp.

34 {
35 return p_name;
36}
PString p_name
Name of the function.

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 48 of file AbstractFunction.cpp.

48 {
49 return p_prototype;
50}
PString p_prototype
Prototype of the function.

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 55 of file AbstractFunction.cpp.

55 {
56 p_name = name;
57}

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 27 of file AbstractFunction.cpp.

27 {
28 p_name = name;
29}

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 41 of file AbstractFunction.cpp.

41 {
42 p_prototype = prototype;
43}

References p_prototype.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ p_name

PString AbstractFunction::p_name
private

Name of the function.

Definition at line 31 of file AbstractFunction.h.

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

◆ p_prototype

PString AbstractFunction::p_prototype
private

Prototype of the function.

Definition at line 33 of file AbstractFunction.h.

Referenced by getPrototype(), and setPrototype().


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