Kernel.h File Reference

Interface to the Kernel functions. More...

#include <string>
#include <vector>
#include <map>
#include <libpf/user/Handle.h>
#include <libpf/user/CaseDescriptor.h>
#include <libpf/core/Enumerator.h>
Include dependency graph for Kernel.h:

Go to the source code of this file.

Classes

struct  Libpf::User::KernelImplementation
 Describes the capabilities of a service / standalone kernel for a specific simulation domain. More...
 

Namespaces

namespace  Libpf
 
namespace  Libpf::Persistency
 
namespace  Libpf::User
 

Enumerations

enum  Libpf::User::ErrorCode { Libpf::User::ERROR_OK = 0 , Libpf::User::ERROR_COMMUNICATION = -91 , Libpf::User::ERROR_ARGUMENT = -92 , Libpf::User::ERROR_SERVER = -93 }
 

Functions

void Libpf::User::initializeKernel (void)
 
void Libpf::User::uninitializeKernel (void)
 
void Libpf::User::addLocale (const std::string &locale)
 
void Libpf::User::addEnumerator (const Libpf::Utility::EnumeratorInterface &ei)
 
const std::string & Libpf::User::name (void)
 
const std::string & Libpf::User::uuid (void)
 
const std::string & Libpf::User::description (void)
 
const std::string & Libpf::User::license (void)
 
const std::string & Libpf::User::version (void)
 
const std::string & Libpf::User::apiVersion (int &error)
 query the Model User API version More...
 
const std::string & Libpf::User::defaultType (void)
 query the default type More...
 
const std::vector< std::string > & Libpf::User::supportedLocales (int &error)
 query the locales supported by the server side derived classes can re-implement this method to override the default list provided by the library More...
 
int Libpf::User::setLocale (const std::string &locale)
 sets the locale for internationalization; the default value is en More...
 
int Libpf::User::activate (void)
 performs activation of the server side More...
 
const std::vector< Libpf::Persistency::TypeDescriptor > & Libpf::User::listTypes (int &error)
 queries the available types More...
 
std::string Libpf::User::jsonListTypes (int &error)
 queries the available types More...
 
const std::vector< Libpf::Core::Enumerator > & Libpf::User::listEnumerators (int &error)
 queries the available enumerators More...
 
std::string Libpf::User::jsonListEnumerators (int &error)
 
const Libpf::Persistency::TypeDescriptor * Libpf::User::typeDescriptor (std::string name, int &error)
 
std::string Libpf::User::jsonTypeDescriptor (std::string name, int &error)
 queries a specific type More...
 
const Libpf::Core::Enumerator * Libpf::User::enumerator (const std::string &name, int &error)
 queries a specific enumerator More...
 
Libpf::User::Handle Libpf::User::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)
 creates a new case instance More...
 
Libpf::User::Handle Libpf::User::createCase (const std::string &jcd, int &error)
 creates a new case instance More...
 
Libpf::User::Handle Libpf::User::createCase (const std::string &type, const std::string &tag, const std::string &description, const std::string &jcd, int &error)
 creates a new case instance More...
 
int Libpf::User::remove (Libpf::User::Handle handle)
 remove an existing case instance More...
 
Libpf::User::Handle Libpf::User::duplicate (Libpf::User::Handle handle, const std::string &tag, const std::string &description, int &error)
 duplicate an existing case instance More...
 
int Libpf::User::purge (void)
 remove all existing case instances More...
 
std::string Libpf::User::errorMessage (int error)
 
void Libpf::User::setVerbosityGlobal (int verbosity)
 

Detailed Description

Interface to the Kernel functions.

This file is part of LIBPF All rights reserved; do not distribute without permission.

Author
(C) Copyright 2013-2023 Paolo Greppi simevo s.r.l.