orca-robotics


INTRODUCTION
Overview
Download and Install
Quick Start
Documentation
Publications

REPOSITORY
Interfaces
Components
Libraries
Utilities
Software Map

DEVELOPER
Tutorials
Examples
Dev Guide
Dashboard
Wiki
login/pass: orca/orca

PEOPLE
Contributors
Users

SourceForge.net Logo
Project
Download
Mailing lists

 

         

orca::RangeScanner2d Interface Reference
[RangeScanner2dRangeScanner2d]

Single-origin scanning range sensor. More...

Inherited by orca::LaserScanner2d, and orcaifaceimpl::RangeScanner2dI [virtual].

Inheritance diagram for orca::RangeScanner2d:

Inheritance graph
[legend]
List of all members.

Public Member Functions

idempotent RangeScanner2dData getData () throws DataNotExistException, HardwareFailedException
idempotent RangeScanner2dDescription getDescription ()
 Returns device description.
void subscribe (RangeScanner2dConsumer *subscriber) throws SubscriptionFailedException
idempotent void unsubscribe (RangeScanner2dConsumer *subscriber)

Detailed Description

Single-origin scanning range sensor.


Member Function Documentation

idempotent RangeScanner2dData orca::RangeScanner2d::getData  )  throws DataNotExistException, HardwareFailedException
 

Returns the latest data. May raise DataNotExistException if the requested information is not available. May raise HardwareFailedException if there is some problem with hardware.

Note:
In Orca1 this would be called ClientPull_Supplier interface.

void orca::RangeScanner2d::subscribe RangeScanner2dConsumer subscriber  )  throws SubscriptionFailedException
 

Mimics IceStorm's subscribe(). subscriber is typically a direct proxy to the consumer object. The implementation may choose to implement the push directly or use IceStorm. This choice is transparent to the subscriber. The case when the subscriber is already subscribed is quietly ignored.

See also:
unsubscribe

idempotent void orca::RangeScanner2d::unsubscribe RangeScanner2dConsumer subscriber  ) 
 

Unsubscribe an existing subscriber. The case when the subscriber is not subscribed is quietly ignored.

See also:
subscribe


The documentation for this interface was generated from the following file:
  • rangescanner2d.ice
 

Webmaster: Tobias Kaupp (tobasco at users.sourceforge.net)


Generated for Orca Robotics by  doxygen 1.4.5