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

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

#include <AbstractDataFunction.h>

+ Inheritance diagram for AbstractDataFunction:

Public Member Functions

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

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

References initialisationAbstractDataFunction().

Referenced by DataFunctionCall< _Data >::DataFunctionCall(), and 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 20 of file AbstractDataFunction.cpp.

20 {
21
22}

Member Function Documentation

◆ call()

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

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

Referenced by BaseDaemon::processData(), and 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 34 of file AbstractDataFunction.cpp.

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

References p_name.

Referenced by DataFunctionCall< _Data >::call(), and 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 48 of file AbstractDataFunction.cpp.

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

References p_prototype.

Referenced by DataFunctionCall< _Data >::call(), and 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 55 of file AbstractDataFunction.cpp.

55 {
56 p_name = name;
57 p_prototype = name;
58}

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

27 {
28 p_name = name;
29}

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

41 {
42 p_prototype = prototype;
43}

References p_prototype.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ p_name

PString AbstractDataFunction::p_name
private

Name of the function.

Definition at line 32 of file AbstractDataFunction.h.

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

◆ p_prototype

PString AbstractDataFunction::p_prototype
private

Prototype of the function.

Definition at line 34 of file AbstractDataFunction.h.

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


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