com.kuka.nav.honk
Class HonkAction

java.lang.Object
  com.kuka.nav.command.AbstractParameterizable
      com.kuka.nav.command.AbstractCommand<T,E>
          com.kuka.nav.command.Action<HonkAction,ActionContainer<HonkAction,NavExecutionResult>>
              com.kuka.nav.honk.HonkAction

All Implemented Interfaces:

com.kuka.command.ICommand<HonkAction,ActionContainer<HonkAction,NavExecutionResult>>, com.kuka.command.IParameterizableCommand<HonkAction,ActionContainer<HonkAction,NavExecutionResult>>, com.kuka.parameters.IParameterizable

public final class HonkAction
extends Action<HonkAction,ActionContainer<HonkAction,NavExecutionResult>>
implements com.kuka.command.ICommand<HonkAction,ActionContainer<HonkAction,NavExecutionResult>>

Action that can be used to honk with the vehicle.

Constructor Summary

HonkAction(HonkCommand honkCommand)
Creates a new instant of an HonkAction that can be executed on a robot to honk.

Method Summary

HonkAction	copy()
boolean	getContinuous() Get if the honking sound is set to continuous.
long	getHonkDurationTime() Get the time duration of honkig.
boolean	getHonkEnabled() Get if the honking is enabled.
HonkAction	setContinuous(boolean isContinuous) Set the honk sound continuous or alternating.
HonkAction	setHonkTimeDuration(long honkTime) Set the duration of the honk.

Methods inherited from class com.kuka.nav.command.Action

getTimeout, setTimeout

Methods inherited from class com.kuka.nav.command.AbstractCommand

getDescription, self, setDescription

Methods inherited from class com.kuka.nav.command.AbstractParameterizable

getParameters, paramHelper

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kuka.command.ICommand

getDescription, setDescription

Methods inherited from interface com.kuka.parameters.IParameterizable

getParameters

Constructor Detail

HonkAction

public HonkAction(HonkCommand honkCommand)

Creates a new instant of an HonkAction that can be executed on a robot to honk.

Parameters:

honkCommand - the command for the honk

Method Detail

setContinuous

public HonkAction setContinuous(boolean isContinuous)

Set the honk sound continuous or alternating.

Parameters:

isContinuous - true = continuous, false = alternating

Returns:

HonkAction instance

setHonkTimeDuration

public HonkAction setHonkTimeDuration(long honkTime)

Set the duration of the honk. If not set a default value is used for a short honking.

Parameters:

honkTime - the duration of the honk time in milli sec.

Returns:

HonkAction instance

getHonkDurationTime

public long getHonkDurationTime()

Get the time duration of honkig.

Returns:

the time duration of honking in milli sec.

getContinuous

public boolean getContinuous()

Get if the honking sound is set to continuous.

Returns:

true if the honking sound is set to continuous, false if it is set to alternating

getHonkEnabled

public boolean getHonkEnabled()

Get if the honking is enabled.

Returns:

if the honking is enabled

copy

public HonkAction copy()

Specified by:

copy in interface com.kuka.command.ICommand<HonkAction,ActionContainer<HonkAction,NavExecutionResult>>

Specified by:

copy in class AbstractCommand<HonkAction,ActionContainer<HonkAction,NavExecutionResult>>