Privacy
An open-source, flexible 3D physical simulation framework
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
mars::sim::NodeArraySensor Class Reference

#include <NodeArraySensor.h>

Public Member Functions

 NodeArraySensor (interfaces::ControlCenter *control, IDListConfig config, bool initArray=true, bool registerReceiver=true)
 
virtual ~NodeArraySensor (void)
 
virtual int getAsciiData (char *data) const
 
virtual int getSensorData (interfaces::sReal **data) const
 
virtual void receiveData (const data_broker::DataInfo &info, const data_broker::DataPackage &package, int callbackParam)
 The DataBroker will call this method to notify the receiver of whenever the condition for which the receiver registered occur. More...
 
virtual configmaps::ConfigMap createConfig () const
 
- Public Member Functions inherited from mars::interfaces::SensorInterface
 SensorInterface (ControlCenter *center)
 
virtual ~SensorInterface ()
 
- Public Member Functions inherited from mars::interfaces::BaseSensor
 BaseSensor ()
 
virtual ~BaseSensor ()
 
 BaseSensor (unsigned long id, std::string name)
 
unsigned long getID () const
 
const std::string getName () const
 
void getCoreExchange (core_objects_exchange *obj) const
 
- Public Member Functions inherited from mars::data_broker::ReceiverInterface
 ReceiverInterface ()
 
virtual ~ReceiverInterface ()
 

Static Public Member Functions

static interfaces::BaseConfig * parseConfig (interfaces::ControlCenter *control, configmaps::ConfigMap *config)
 
- Static Public Member Functions inherited from mars::interfaces::BaseSensor
static BaseConfig * parseConfig (ControlCenter *control, configmaps::ConfigMap *config)
 

Protected Attributes

std::string typeName
 
int countIDs
 
std::vector< double > doubleArray
 
IDListConfig config
 
- Protected Attributes inherited from mars::interfaces::SensorInterface
ControlCenter * control
 

Additional Inherited Members

- Public Attributes inherited from mars::interfaces::BaseSensor
unsigned long id
 
std::string name
 
unsigned long updateRate
 

Detailed Description

Definition at line 45 of file NodeArraySensor.h.

Constructor & Destructor Documentation

◆ NodeArraySensor()

mars::sim::NodeArraySensor::NodeArraySensor ( interfaces::ControlCenter *  control,
IDListConfig  config,
bool  initArray = true,
bool  registerReceiver = true 
)

Definition at line 70 of file NodeArraySensor.cpp.

◆ ~NodeArraySensor()

mars::sim::NodeArraySensor::~NodeArraySensor ( void  )
virtual

Definition at line 102 of file NodeArraySensor.cpp.

Member Function Documentation

◆ createConfig()

ConfigMap mars::sim::NodeArraySensor::createConfig ( ) const
virtual

Reimplemented from mars::interfaces::BaseSensor.

Definition at line 53 of file NodeArraySensor.cpp.

◆ getAsciiData()

int mars::sim::NodeArraySensor::getAsciiData ( char *  data) const
virtual

Reimplemented from mars::interfaces::BaseSensor.

Reimplemented in mars::sim::NodeContactForceSensor, mars::sim::NodeRotationSensor, mars::sim::NodeAngularVelocitySensor, mars::sim::NodePositionSensor, mars::sim::NodeVelocitySensor, and mars::sim::NodeCOMSensor.

Definition at line 110 of file NodeArraySensor.cpp.

◆ getSensorData()

int mars::sim::NodeArraySensor::getSensorData ( interfaces::sReal **  data) const
virtual

Reimplemented from mars::interfaces::BaseSensor.

Reimplemented in mars::sim::NodeContactForceSensor, mars::sim::NodeRotationSensor, mars::sim::NodeAngularVelocitySensor, mars::sim::NodePositionSensor, mars::sim::NodeVelocitySensor, and mars::sim::NodeCOMSensor.

Definition at line 125 of file NodeArraySensor.cpp.

◆ parseConfig()

BaseConfig * mars::sim::NodeArraySensor::parseConfig ( interfaces::ControlCenter *  control,
configmaps::ConfigMap *  config 
)
static

Definition at line 46 of file NodeArraySensor.cpp.

◆ receiveData()

virtual void mars::sim::NodeArraySensor::receiveData ( const data_broker::DataInfo &  info,
const data_broker::DataPackage &  dataPackage,
int  callbackParam 
)
inlinevirtual

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.

Implements mars::data_broker::ReceiverInterface.

Reimplemented in mars::sim::NodeContactForceSensor, mars::sim::NodeRotationSensor, mars::sim::NodeAngularVelocitySensor, mars::sim::NodePositionSensor, and mars::sim::NodeVelocitySensor.

Definition at line 57 of file NodeArraySensor.h.

Member Data Documentation

◆ config

IDListConfig mars::sim::NodeArraySensor::config
protected

Definition at line 69 of file NodeArraySensor.h.

◆ countIDs

int mars::sim::NodeArraySensor::countIDs
protected

Definition at line 67 of file NodeArraySensor.h.

◆ doubleArray

std::vector<double> mars::sim::NodeArraySensor::doubleArray
protected

Definition at line 68 of file NodeArraySensor.h.

◆ typeName

std::string mars::sim::NodeArraySensor::typeName
protected

Definition at line 66 of file NodeArraySensor.h.

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