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 Project Download Mailing lists

orca::EStop Interface Reference Interface to e-stop. More... Inherited by orcaifaceimpl::EStopI [virtual]. List of all members. Public Member Functions idempotent void  activateEStop ()   Hit the stop button! idempotent void  keepAlive () throws EStopAlreadyTriggeredException idempotent double  getRequiredKeepAlivePeriodSec () idempotent void  setToOperatingMode () idempotent EStopData  getData () throws DataNotExistException   Returns the latest data. Raises DataNotExistException if data is not available. void  subscribe (EStopConsumer *subscriber) throws SubscriptionFailedException idempotent void  unsubscribe (EStopConsumer *subscriber) Detailed Description Interface to e-stop. Member Function Documentation idempotent double orca::EStop::getRequiredKeepAlivePeriodSec (   )    Returns the required keep-alive period, in seconds. If a keep-alive is not heard for longer than this, the e-stop will automatically be activated. A negative value indicates that keep-alives are not required: the e-stop can only be activated using 'activateEStop()'. idempotent void orca::EStop::keepAlive (   )  throws EStopAlreadyTriggeredException   Keep the thing alive: reset the keep-alive timer to zero. If the e-stop has been already triggered, keep-alives make no sense, so an EStopAlreadyTriggeredException is thrown. idempotent void orca::EStop::setToOperatingMode (   )    If the e-stop was activated, sets the vehicle back to the operating mode (ie un-sets the e-stop so the vehicle can move again), and resets the keep-alive timer to zero. If the vehicle was already in the operating mode, does nothing. void orca::EStop::subscribe (  EStopConsumer *  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::EStop::unsubscribe (  EStopConsumer *  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: estop.ice

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

---