AbstractFunction.hpp
Go to the documentation of this file.
virtual std::vector< std::string > getPrototypeParam() const =0
Get the list of type of the parameter.
this is for service instance call
void setType(enum type _type)
Set the type of the call that must be done for this function.
enum type getType() const
Get the tyope of the call that is needed to do.
This call a service function (global function like "srv.xxx")
This is a global function.
enum type m_type
Type of the subCall (to permit to call many type of call)
Definition: AbstractFunction.hpp:47
Interface to store a function and call it after with a zeus::Buffer.
Definition: AbstractFunction.hpp:23
std::string getPrototype() const
Get the prototype of the function with the parameter name and type.
void setParam(int32_t _idParam, const std::string &_name, const std::string &_desc)
Set the parameter name and description.
bool checkOrderFunctionParameter()
virtual void execute(ememory::SharedPtr< zeus::WebServer > _interfaceClient, ememory::SharedPtr< zeus::BufferCall > _obj, void *_class=nullptr)=0
Execute the function with all parameter properties.
std::string m_returnDescription
Return description of the Function.
Definition: AbstractFunction.hpp:97
std::string m_name
name of the function
Definition: AbstractFunction.hpp:60
std::string m_description
description of the function
Definition: AbstractFunction.hpp:68
virtual std::string getSignature() const
Get the signature of the function.
const std::string & getDescription() const
Get the description of the function.
void addParam(const std::string &_name, const std::string &_desc)
Set the parameter name and description of the last parameter not set (increment id every element) ...
virtual std::string getPrototypeReturn() const =0
Get the string of the type of the return value.
void setReturn(const std::string &_desc)
Set the return description of the Function.
virtual ~AbstractFunction()=default
generic virtual destructor
void setDescription(const std::string &_desc)
Set a new description of the function.
This is a local fucntion.
Does not know the type of the call.
std::vector< std::pair< std::string, std::string > > m_paramsDescription
List of the parameter descriptions.
Definition: AbstractFunction.hpp:81