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::Power Interface Reference
[PowerPower]

Access to a robot's power subsystem. More...

Inherited by orcaifaceimpl::PowerI.

List of all members.

Public Member Functions

idempotent PowerData getData () throws DataNotExistException, HardwareFailedException
void subscribe (PowerConsumer *subscriber) throws SubscriptionFailedException
idempotent void unsubscribe (PowerConsumer *subscriber)


Detailed Description

Access to a robot's power subsystem.


Member Function Documentation

idempotent PowerData orca::Power::getData  )  throws DataNotExistException, HardwareFailedException
 

Returns the latest data. Raises DataNotExistException if data is not available. Raises HardwareFailedException there is a problem with the underlying hardware.

void orca::Power::subscribe PowerConsumer subscriber  )  throws SubscriptionFailedException
 

Mimics IceStorm's subscribe() but without QoS, for now. The implementation may choose to implement the data push internally or use IceStorm. This choice is transparent to the subscriber.

Parameters:
subscriber The subscriber's proxy.
See also:
unsubscribe

idempotent void orca::Power::unsubscribe PowerConsumer subscriber  ) 
 

Unsubscribe the given [subscriber].

Parameters:
subscriber The proxy of an existing subscriber.
See also:
subscribe


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

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


Generated for Orca Robotics by  doxygen 1.4.5