com.kuka.roboticsAPI.capabilities.ledStrip.userEffects
Class BlinkingLedStripUserEffect

java.lang.Object
  com.kuka.roboticsAPI.capabilities.ledStrip.userEffects.BlinkingLedStripUserEffect

All Implemented Interfaces:

ILedStripUserEffect

public class BlinkingLedStripUserEffect
extends Object
implements ILedStripUserEffect

A class representing a blinking effect (50% rectangle with one color).

Constructor Summary

BlinkingLedStripUserEffect(SegmentColor color, long period, boolean forceOffColor)
Creates a BlinkingLedStripUserEffect instance.

Method Summary

SegmentColor	getColor() Method to get the segment color.
long	getPeriod() Method to get the period.
boolean	isForceOffColor() Method to get if the segments shall be off.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlinkingLedStripUserEffect

public BlinkingLedStripUserEffect(SegmentColor color,
                                  long period,
                                  boolean forceOffColor)

Creates a BlinkingLedStripUserEffect instance.

Parameters:

color - Color of the segments while effect is in ON period.

period - Length of the period [ms].

forceOffColor - true, if the segments shall be switched off in OFF period, false, if the segments shall display the color of the active state in OFF period.

Method Detail

getColor

public SegmentColor getColor()

Method to get the segment color.

Returns:

Color of the segments while effect is in ON period.

getPeriod

public long getPeriod()

Method to get the period.

Returns:

Length of the period [ms].

isForceOffColor

public boolean isForceOffColor()

Method to get if the segments shall be off.

Returns:

true, if the segments shall be switched off in OFF period, false, if the segments shall display the color of the active state in OFF period.