com.kuka.roboticsAPI.capabilities.honk
Class HonkCapabilityImpl

java.lang.Object
  com.kuka.roboticsAPI.capabilities.honk.HonkCapabilityImpl

All Implemented Interfaces:

IHonkCapability, ICapability

public class HonkCapabilityImpl
extends Object
implements IHonkCapability

This class implements the honk capability for a mobile platform.

Constructor Summary

HonkCapabilityImpl(com.kuka.roboticsAPI.ioModel.Output honkOutput)
Creates the honk capability for the platform.

Method Summary

void	cancelHonkTimer() Cancels the honk timer.
void	honk() Honk the platform for a short time.
void	honk(long timeout) Honk the platform for the given timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HonkCapabilityImpl

public HonkCapabilityImpl(com.kuka.roboticsAPI.ioModel.Output honkOutput)

Creates the honk capability for the platform.

Parameters:

honkOutput - the IO Output of the honk.

Method Detail

honk

public void honk()

Description copied from interface: IHonkCapability

Honk the platform for a short time. Please note that this command is asynchronous.

Specified by:

honk in interface IHonkCapability

honk

public void honk(long timeout)

Description copied from interface: IHonkCapability

Honk the platform for the given timeout. Negative or 0 timeout will instantly switch of any honk already in progress. If a second honk command is given while the previous is still active the new will overwrite the remaining timeout. Please note that this command is asynchronous.

Specified by:

honk in interface IHonkCapability

Parameters:

timeout - the honk time in ms.

cancelHonkTimer

public void cancelHonkTimer()

Description copied from interface: IHonkCapability

Cancels the honk timer.

Specified by:

cancelHonkTimer in interface IHonkCapability