PlayerCc::FiducialProxy Class Reference

The FiducialProxy class is used to control fiducial devices. More...

#include <playerc++.h>

Inheritance diagram for PlayerCc::FiducialProxy:
Collaboration diagram for PlayerCc::FiducialProxy:

List of all members.

Detailed Description

The FiducialProxy class is used to control fiducial devices.

The latest set of detected beacons is stored in the beacons array.

Public Member Functions

 FiducialProxy (PlayerClient *aPc, uint32_t aIndex=0)
 ~FiducialProxy ()
uint32_t GetCount () const
 The number of beacons detected.
player_fiducial_item_t GetFiducialItem (uint32_t aIndex) const
 Get detected beacon description.
player_pose3d_t GetSensorPose () const
 The pose of the sensor.
player_bbox3d_t GetSensorSize () const
 The size of the sensor.
player_bbox2d_t GetFiducialSize () const
 The size of the most recently detected fiducial.
void RequestGeometry ()
 Get the sensor's geometry configuration.
player_fiducial_item_t operator[] (uint32_t aIndex) const
 FiducialProxy data access operator.

Private Member Functions

void Subscribe (uint32_t aIndex)
void Unsubscribe ()

Private Attributes


Member Function Documentation

player_fiducial_item_t PlayerCc::FiducialProxy::operator[] ( uint32_t  aIndex) const [inline]

FiducialProxy data access operator.

This operator provides an alternate way of access the actuator data. For example, given a FiducialProxy named fp, the following expressions are equivalent: fp.GetFiducialItem[0] and fp[0].

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