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::Properties Interface Reference
[PropertiesProperties]

Interface to Properties information. More...

Inherited by orcaifaceimpl::PropertiesI.

List of all members.

Public Member Functions

idempotent PropertiesData getData () throws DataNotExistException
 Get current Properties state. Raises DataNotExistException if data is not available.
void setData (PropertiesData data)
void subscribe (PropertiesConsumer *subscriber) throws SubscriptionFailedException
idempotent void unsubscribe (PropertiesConsumer *subscriber)


Detailed Description

Interface to Properties information.


Member Function Documentation

void orca::Properties::setData PropertiesData  data  ) 
 

Allow remote clients to set new properties. These will be merged with the working property set:

  • new properties are added to the set.
  • properties which already exist in the set are over-written.

void orca::Properties::subscribe PropertiesConsumer 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::Properties::unsubscribe PropertiesConsumer 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:
  • properties.ice
 

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


Generated for Orca Robotics by  doxygen 1.4.5