Privacy
An open-source, flexible 3D physical simulation framework
Public Member Functions | List of all members
mars::data_broker::ReceiverInterface Class Referenceabstract

Interface for classes that want to receive data from the DataBroker. More...

#include <ReceiverInterface.h>

Public Member Functions

 ReceiverInterface ()
 
virtual ~ReceiverInterface ()
 
virtual void receiveData (const DataInfo &info, const DataPackage &dataPackage, int callbackParam)=0
 The DataBroker will call this method to notify the receiver of whenever the condition for which the receiver registered occur. More...
 

Detailed Description

Interface for classes that want to receive data from the DataBroker.

Definition at line 48 of file ReceiverInterface.h.

Constructor & Destructor Documentation

◆ ReceiverInterface()

mars::data_broker::ReceiverInterface::ReceiverInterface ( )
inline

Definition at line 51 of file ReceiverInterface.h.

◆ ~ReceiverInterface()

virtual mars::data_broker::ReceiverInterface::~ReceiverInterface ( )
inlinevirtual

Definition at line 52 of file ReceiverInterface.h.

Member Function Documentation

◆ receiveData()

virtual void mars::data_broker::ReceiverInterface::receiveData ( const DataInfo &  info,
const DataPackage &  dataPackage,
int  callbackParam 
)
pure virtual

The DataBroker will call this method to notify the receiver of whenever the condition for which the receiver registered occur.

Parameters
infoInformation about the DataPackage.
dataPackageThe DataPackage containing all the data.
callbackParamThe int the receiver passed during registration. The default (the receiver didn't provide a callbackParam) is 0. This can be used to easily distinguish different registrations.

Implemented in mars::sim::Simulator, mars::sim::SimMotor, mars::sim::RotatingRaySensor, mars::sim::CameraSensor, mars::plugins::Plot3D::Plot3D, mars::sim::ScanningSonar, mars::plugins::PythonMars::PythonMars, mars::data_broker_gui::DataConnWidget, mars::sim::HapticFieldSensor, mars::log_console::MainConsole, mars::plugins::Text3D::Text3D, mars::viz::Viz, mars::sim::RaySensor, mars::sim::Joint6DOFSensor, mars::gui::CameraConfig, mars::data_broker_gui::DataWidget, mars::plugins::obstacle_generator::ObstacleGenerator, data_broker_plotter2::DataBrokerPlotter, mars::plugins::connectors::Connectors, mars::plugins::EntityView::EntityView, mars::plugins::__namespace__::__classname__, mars::plugin::SkyDomePlugin::SkyDomePlugin, mars::plugins::__namespace__::__classname__, mars::plugins::Plot3D::MotorPlot, mars::sim::MultiLevelLaserRangeFinder, data_broker_plotter::DataBrokerPlotter, mars::gui::BlenderExportGUI, mars::sim::MotorPositionSensor, mars::sim::NodeArraySensor, mars::sim::JointArraySensor, mars::sim::MotorCurrentSensor, mars::sim::RayGridSensor, mars::sim::JointAVGTorqueSensor, mars::sim::JointLoadSensor, mars::sim::NodeContactSensor, mars::sim::NodeContactForceSensor, mars::sim::NodeRotationSensor, mars::sim::NodeAngularVelocitySensor, mars::sim::NodePositionSensor, mars::sim::NodeVelocitySensor, VizPlugin, mars::sim::JointTorqueSensor, mars::sim::JointVelocitySensor, and mars::sim::JointPositionSensor.

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