Kernel.h

Go to the documentation of this file.

 
// Documentation for the doxygen main page
/*====================================================================================================================*/
/*==  Guards, Includes  ==============================================================================================*/
/*====================================================================================================================*/
 
// INCLUDE GUARDS
//
#ifndef LIBPF_USER_KERNEL_H
#define LIBPF_USER_KERNEL_H
 
/* SYSTEM INCLUDES */
//
#include <string>
#include <vector>
#include <map>
 
/* PROJECT INCLUDES */
//
 
/* LOCAL INCLUDES */
//
#include <libpf/user/Handle.h>
#ifndef SWIG
#include <libpf/user/CaseDescriptor.h>
#include <libpf/core/Enumerator.h>
#endif
 
/* FORWARD REFERENCES */
//
namespace Libpf {
namespace Persistency {
struct TypeDescriptor;
} // namespace User
} // namespace Libpf
 
/* FUNCTIONS */
//
 
namespace Libpf {
namespace User {
 
enum ErrorCode { ERROR_OK = 0, 
  ERROR_COMMUNICATION = -91,   
  ERROR_ARGUMENT = -92,        
  ERROR_SERVER = -93           
}; // enum ErrorCode
 
void initializeKernel(void);
 
void uninitializeKernel(void);
 
#ifndef SWIG
void addLocale(const std::string &locale); // to be called by derived classes only  
void addEnumerator(const Libpf::Utility::EnumeratorInterface& ei); // to be called by derived classes only  
#endif // ifndef SWIG
 
const std::string &name(void);
 
const std::string &uuid(void);
 
const std::string &description(void);
 
const std::string &license(void);
 
const std::string &version(void);
 
const std::string &apiVersion(int &error);
 
const std::string &defaultType(void);
 
const std::vector<std::string> &supportedLocales(int &error);
 
int setLocale(const std::string &locale);
 
int activate(void);
 
#ifndef SWIG
const std::vector<Libpf::Persistency::TypeDescriptor> &listTypes(int &error);
#endif
 
std::string jsonListTypes(int &error);
 
#ifndef SWIG
const std::vector<Libpf::Core::Enumerator> &listEnumerators(int &error);
#endif
std::string jsonListEnumerators(int &error);
 
#ifndef SWIG
const Libpf::Persistency::TypeDescriptor *typeDescriptor(std::string name, int&error);
#endif
 
std::string jsonTypeDescriptor(std::string name, int &error);
 
#ifndef SWIG
const Libpf::Core::Enumerator *enumerator(const std::string &name, int &error);
#endif
 
 
Libpf::User::Handle createCase(const std::string &type, const std::string &tag, const std::string &description, 
  const std::map<std::string, std::string> &stringOptions, 
  const std::map<std::string, int> &integerOptions,    
  int &error);
 
Libpf::User::Handle createCase(const std::string &jcd, int &error);
 
 
Libpf::User::Handle createCase(const std::string &type, const std::string &tag, const std::string &description, 
                            const std::string &jcd, int &error);
 
int remove(Libpf::User::Handle handle);
 
Libpf::User::Handle duplicate(Libpf::User::Handle handle, const std::string &tag, const std::string &description, int &error);
 
int purge(void);
 
std::string errorMessage(int error);
 
void setVerbosityGlobal(int verbosity);
 
/*====================================================================================================================*/
/*==  struct KernelImplementation declaration  =======================================================================*/
/*====================================================================================================================*/
 
struct KernelImplementation {
  std::string name_;        
  std::string description_; 
  std::string license_;     
  std::string version_;     
  std::string apiVersion_;  
  std::string defaultType_; 
  std::string uuid_;
  
  bool valid_;   //< every Kernel method must check this attribute before execution
 
  std::map<Libpf::User::Handle, Libpf::User::CaseDescriptor> handleMap_;
 
  std::vector<std::string> supportedLocales_;
  std::string locale_;
 
  std::vector<Libpf::Core::Enumerator> enumerators_;
 
  KernelImplementation(std::string name, std::string description, std::string license, std::string version, std::string defaultType, std::string uuid);
}; // struct KernelImplementation
 
} // namespace User
} // namespace Libpf
 
#endif // LIBPF_USER_KERNEL_H