gem-graph-server/include/model.h

//=-------------------------------------------------------------------------=//
//  Model definitions                                                        //
//                                                                           //
//  Copyright © 2021 The Gem-graph Project                                   //
//                                                                           //
//  This file is part of gem-graph.                                          //
//                                                                           //
//  This program is free software: you can redistribute it and/or modify     //
//  it under the terms of the GNU Affero General Public License as           //
//  published by the Free Software Foundation, either version 3 of the       //
//  License, or (at your option) any later version.                          //
//                                                                           //
//  This program is distributed in the hope that it will be useful,          //
//  but WITHOUT ANY WARRANTY; without even the implied warranty of           //
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            //
//  GNU Affero General Public License for more details.                      //
//                                                                           //
//  You should have received a copy of the GNU Affero General Public License //
//  along with this program.  If not, see <https://www.gnu.org/licenses/>.   //
//=-------------------------------------------------------------------------=//

#pragma once
#ifndef BASE_H
    #include "../include/base.h"
#endif

/* -------------------------------------------------------------------------- */

#define MODEL_STRING_SIZE 48
#define MAX_MODEL_NUMBER 1
#define MAX_MODEL_NAME_SIZE MODEL_STRING_SIZE
#define MAX_MODEL_FILENAME_SIZE MODEL_STRING_SIZE
#define MAX_OWNER_NAME_SIZE MODEL_STRING_SIZE
#define MAX_VERSION_SIZE MODEL_STRING_SIZE

#define ARROW_NUMBER 6
#define SITE_NUMBER 2
#define MAX_CYCLES 10
#define MAX_THREAD 0
#define XMAX 39
#define YMAX 0
#define ZMAX 0
#define SPACE_SIZE (XMAX+1) * (YMAX+1) * (ZMAX+1)

/* -------------------------------------------------------------------------- */

// -------------------------------------------------------------------------- //
// Model init function (and model discovery)                                  //
// -------------------------------------------------------------------------- //
void ModelSystemInit(Parameters_t *parameters);

// -------------------------------------------------------------------------- //
// Model stopping function                                                    //
// -------------------------------------------------------------------------- //
void ModelSystemDestroy(void);

// -------------------------------------------------------------------------- //
// Load a model ready to execute                                              //
// -------------------------------------------------------------------------- //
int ModelLoad(int id);

// -------------------------------------------------------------------------- //
// Unload a model                                                             //
// -------------------------------------------------------------------------- //
int ModelUnload(int id);

// -------------------------------------------------------------------------- //
// Add a model to the known model list                                        //
// -------------------------------------------------------------------------- //
void ModelAddToKnown(Model_t **newModel);

// -------------------------------------------------------------------------- //
// Print informations about all models (known and loaded) to the client       //
// -------------------------------------------------------------------------- //
void printModels(char *buf);

// -------------------------------------------------------------------------- //
// Launch a model execution                                                   //
// -------------------------------------------------------------------------- //
int ModelRun(int id);

// -------------------------------------------------------------------------- //
// Stop a model execution                                                     //
// -------------------------------------------------------------------------- //
int ModelStop(int id);

// -------------------------------------------------------------------------- //
// Stop and unload all loaded or running model                                //
// -------------------------------------------------------------------------- //
void ModelShutdown(void);