DataPackController< DATA_TYPE > Class Template Reference

Helper class to handle DataPacks on the Engine Server side. More...

#include <datapack_controller.h>

Public Member Functions
	DataPackController ()=default
	Constructor. More...
virtual	~DataPackController ()=default
virtual DATA_TYPE *	getDataPackInformation ()=0
	Get datapack information to be forwarded to the NRP. More...
virtual void	handleDataPackData (const DATA_TYPE &data)=0
	Handle received datapack data. More...

Detailed Description

template<class DATA_TYPE>
class DataPackController< DATA_TYPE >

Helper class to handle DataPacks on the Engine Server side.

As a general policy DataDataPackController is not supposed to take ownership of DATA_TYPE objects which receives or returns. This must be consider for each DataDataPackController specialization.

Template Parameters

DATA_TYPE

Object type that this controller handles

Constructor & Destructor Documentation

DataPackController()

template<class DATA_TYPE >

DataPackController< DATA_TYPE >::DataPackController ( )

default

Constructor.

~DataPackController()

template<class DATA_TYPE >

virtual DataPackController< DATA_TYPE >::~DataPackController ( )

virtualdefault

Member Function Documentation

getDataPackInformation()

template<class DATA_TYPE >

virtual DATA_TYPE* DataPackController< DATA_TYPE >::getDataPackInformation ( )

pure virtual

Get datapack information to be forwarded to the NRP.

Returns

Returns a DATA_TYPE pointer containing requested data

Implemented in gazebo::ModelGrpcDataPackController, gazebo::JointDataPackController, gazebo::JointGrpcDataPackController, gazebo::CameraGrpcDataPackController, gazebo::LinkDataPackController, gazebo::LinkGrpcDataPackController, gazebo::CameraDataPackController, NestEngineJSONDataPackController, and NestKernelDataPackController.

handleDataPackData()

template<class DATA_TYPE >

virtual void DataPackController< DATA_TYPE >::handleDataPackData ( const DATA_TYPE &  data )

pure virtual

Handle received datapack data.

Parameters

data	Data to be processed

Implemented in gazebo::JointDataPackController, gazebo::LinkDataPackController, gazebo::CameraDataPackController, NestEngineJSONDataPackController, NestKernelDataPackController, gazebo::CameraGrpcDataPackController, gazebo::ModelGrpcDataPackController, gazebo::LinkGrpcDataPackController, and gazebo::JointGrpcDataPackController.

---

The documentation for this class was generated from the following file:

• nrp_general_library/nrp_general_library/engine_interfaces/datapack_controller.h