com.kuka.roboticsAPI.deviceModel
Class StatusTurnRedundancy

java.lang.Object
  com.kuka.roboticsAPI.geometricModel.redundancy.AbstractRedundancyCollection<StatusTurnRedundancy>
      com.kuka.roboticsAPI.deviceModel.StatusTurnRedundancy

All Implemented Interfaces:

IRedundancyCollection

Direct Known Subclasses:

LBRAlphaRedundancy, LBRE1Redundancy

public class StatusTurnRedundancy
extends AbstractRedundancyCollection<StatusTurnRedundancy>

Standard KUKA-Robot redundancy information with status and turn.

This is a data object for storing status and turn redundancy information. It is possible to set only one of the parameter (status or turn). It is possible to create the empty instance of the class using the default constructor StatusTurnRedundancy() and then use "builder pattern" to set the necessary parameters.

Nested Class Summary

static class	StatusTurnRedundancy.StatusParameter Parameter for status.
static class	StatusTurnRedundancy.TurnParameter Parameter for Turn.

Constructor Summary

StatusTurnRedundancy()
Creates an instance of the class.

StatusTurnRedundancy(int status, int turn)
Creates an instance of the class.

StatusTurnRedundancy(com.kuka.common.params.IParameterSet params)
Creates an instance of the class initialized from the specified parameter set.

StatusTurnRedundancy(IRedundancyCollection source)
Creates an instance of the class from the specified source redundancy.

Method Summary

StatusTurnRedundancy	copy() Creates and returns a deep copy of this redundancy collection.
int	getStatus() Gets the status-redundancy-value.
int	getTurn() Gets the turn-redundancy-value.
StatusTurnRedundancy	setStatus(int status) Sets the status-redundancy-value.
StatusTurnRedundancy	setTurn(int turn) Sets the turn-redundancy-value.

Methods inherited from class com.kuka.roboticsAPI.geometricModel.redundancy.AbstractRedundancyCollection

addParameter, equals, getAllParameters, hashCode, self, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StatusTurnRedundancy

public StatusTurnRedundancy()

Creates an instance of the class.

StatusTurnRedundancy

public StatusTurnRedundancy(int status,
                            int turn)

Creates an instance of the class.

Parameters:

status - status value

turn - turn value

StatusTurnRedundancy

public StatusTurnRedundancy(com.kuka.common.params.IParameterSet params)

Creates an instance of the class initialized from the specified parameter set.

Parameters:

params - parameter set with the initial values.

StatusTurnRedundancy

public StatusTurnRedundancy(IRedundancyCollection source)

Creates an instance of the class from the specified source redundancy.

Sets only the initial values of status and turn from the specified redundancy if these values are contained there.

Parameters:

source - source redundancy collection.

Method Detail

getStatus

public int getStatus()

Gets the status-redundancy-value.

Returns:

The status-redundancy value.

Throws:

IllegalStateException - if status is not set

setStatus

public StatusTurnRedundancy setStatus(int status)

Sets the status-redundancy-value.

Parameters:

status - The status-redundancy value.

Returns:

this object

getTurn

public int getTurn()

Gets the turn-redundancy-value.

Returns:

The turn-redundancy value.

Throws:

IllegalStateException - if turn is not set

setTurn

public StatusTurnRedundancy setTurn(int turn)

Sets the turn-redundancy-value.

Parameters:

turn - The turn-redundancy value.

Returns:

this object

copy

public StatusTurnRedundancy copy()

Description copied from interface: IRedundancyCollection

Creates and returns a deep copy of this redundancy collection.

Specified by:

copy in interface IRedundancyCollection

Specified by:

copy in class AbstractRedundancyCollection<StatusTurnRedundancy>

Returns:

a deep copy of this redundancy collection.