NRP Core  1.4.1
nest_engine_datapack_controller.h
Go to the documentation of this file.
1 /* * NRP Core - Backend infrastructure to synchronize simulations
2  *
3  * Copyright 2020-2023 NRP Team
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * This project has received funding from the European Union’s Horizon 2020
18  * Framework Programme for Research and Innovation under the Specific Grant
19  * Agreement No. 945539 (Human Brain Project SGA3).
20  */
21 
22 #ifndef NEST_ENGINE_DATAPACK_CONTROLLER_H
23 #define NEST_ENGINE_DATAPACK_CONTROLLER_H
24 
27 #include "python/python_module.h"
28 
29 #include <boost/python.hpp>
30 
31 
33  : public JsonDataPackController
34 {
35  public:
36  NestEngineJSONDataPackController(const DataPackIdentifier & devID, boost::python::object nodeCollection, boost::python::dict nest);
37 
38  void handleDataPackData(const nlohmann::json &data) override;
39  virtual nlohmann::json * getDataPackInformation() override;
40 
46  void setNestID(boost::python::dict nest, boost::python::object nodeCollection);
47 
48  protected:
49 
53  boost::python::dict _nest;
54 
58  boost::python::object _nodeCollection;
59 
64  boost::python::list getStatusFromNest();
65 
72  static boost::python::list getStatusFromNest(boost::python::dict &nest, const boost::python::object &nodeCollection);
73 };
74 
75 #endif // NEST_ENGINE_DATAPACK_CONTROLLER_H
json_datapack_controller.h
JsonDataPackController
Base controller class for JSON datapacks.
Definition: json_datapack_controller.h:43
NestEngineJSONDataPackController::handleDataPackData
void handleDataPackData(const nlohmann::json &data) override
Handle received datapack data.
Definition: nest_engine_datapack_controller.cpp:37
json_datapack.h
NestEngineJSONDataPackController::getDataPackInformation
virtual nlohmann::json * getDataPackInformation() override
Get datapack information to be forwarded to the NRP.
Definition: nest_engine_datapack_controller.cpp:44
NestEngineJSONDataPackController::_nodeCollection
boost::python::object _nodeCollection
Nest GID of model managed by this controller.
Definition: nest_engine_datapack_controller.h:58
NestEngineJSONDataPackController
Definition: nest_engine_datapack_controller.h:32
DataPackIdentifier
Identifies a single datapack.
Definition: datapack_interface.h:38
NestEngineJSONDataPackController::NestEngineJSONDataPackController
NestEngineJSONDataPackController(const DataPackIdentifier &devID, boost::python::object nodeCollection, boost::python::dict nest)
Definition: nest_engine_datapack_controller.cpp:29
NestEngineJSONDataPackController::_nest
boost::python::dict _nest
Currently running Nest instance.
Definition: nest_engine_datapack_controller.h:53
NestEngineJSONDataPackController::setNestID
void setNestID(boost::python::dict nest, boost::python::object nodeCollection)
Set Nest properties.
Definition: nest_engine_datapack_controller.cpp:59
python_module.h
NestEngineJSONDataPackController::getStatusFromNest
boost::python::list getStatusFromNest()
Retrieves datapack status from Nest.
Definition: nest_engine_datapack_controller.cpp:67
json
nlohmann::json json
Definition: engine_json_server.cpp:31