User manual

old releases - latest release - trunk

SensorProxy Class Reference

Inheritance diagram for SensorProxy:
Collaboration diagram for SensorProxy:

List of all members.


Detailed Description

Proxy class used to manipulate sensors, and update their sensor readings, in particular.

The sensor proxy accumulates sensor data locally in a SenorProxyBase::SensorData object. When all needed data has been accumulated to update the sensor, use update() to send the data and update the sensor.

Usage example:

 peekabot::SensorProxy p;
 p.assign(client, "root.laser_scanner");
 float d[361];
 ...
 peekabot::SensorProxy::SensorData reading;
 reading.write(d, 361);
 p.update(reading); // Send data and update the sensor

Public Member Functions

 SensorProxy (const SensorProxyBase &p)
SensorProxyoperator= (const SensorProxyBase &p) throw ()
DelayedDispatch assign (const ObjectProxyBase &p)
DelayedDispatch assign (PeekabotClient &client, const std::string &path)
DelayedDispatch assign (const ObjectProxyBase &parent, const std::string &rel_path)

Member Function Documentation

DelayedDispatch assign ( const ObjectProxyBase p  ) 

Upcast and assign from another proxy.

If the object pointed to by p is not of compatible type, the assignment will fail and subsequent operations performed on the proxy will fail.

DelayedDispatch assign ( PeekabotClient client,
const std::string &  path 
)

Assign the proxy to the object with the given path.

Parameters:
client The client to use for this proxy.
path The path of the object in the peeakbot scene.

DelayedDispatch assign ( const ObjectProxyBase parent,
const std::string &  rel_path 
)

Assign the proxy to the object with the given parent and name.

Parameters:
parent The parent of the object referred to by name.
rel_path The path of the object, relative the parent object, to assign this proxy to.


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