com.ur.urcap.api.domain.payload

Enum Payload.ParametersWarning

java.lang.Object

java.lang.Enum<Payload.ParametersWarning>

com.ur.urcap.api.domain.payload.Payload.ParametersWarning

All Implemented Interfaces:

Serializable, Comparable<Payload.ParametersWarning>

Enclosing interface:

Payload

public static enum Payload.ParametersWarning
extends Enum<Payload.ParametersWarning>

This enum represents the different types of warnings that the parameters of a payload can have.

A payload can be usable, but may have a value for a payload parameter or may have a combination of (some of the) payload parameters, that could affect performance of the robot, if the payload is used (i.e., if the parameters are applied).

Enum Constant Summary

Enum Constants

Enum Constant and Description
MASS_0KG The payload has a mass of 0 kg which is most likely not intended/valid.
MASS_AND_CENTER_OF_GRAVITY_EXCEEDED The combination of the mass and the center of gravity could affect the performance of the robot, if the payload is used.
NO_WARNING None of the parameters of the payload or the combination of payload parameters has any warnings.
RATED_MASS_EXCEEDED The mass of the payload exceeds the rated maximum supported payload mass of the robot.

Method Summary

Modifier and Type	Method and Description
static Payload.ParametersWarning	valueOf(String name) Returns the enum constant of this type with the specified name.
static Payload.ParametersWarning[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_WARNING

public static final Payload.ParametersWarning NO_WARNING

None of the parameters of the payload or the combination of payload parameters has any warnings.

MASS_0KG

public static final Payload.ParametersWarning MASS_0KG

The payload has a mass of 0 kg which is most likely not intended/valid. Note that the value for the payload mass should be the total mass of the payload attached to the tool output flange of the robot.

RATED_MASS_EXCEEDED

public static final Payload.ParametersWarning RATED_MASS_EXCEEDED

The mass of the payload exceeds the rated maximum supported payload mass of the robot. Using the payload could affect performance of the robot.

MASS_AND_CENTER_OF_GRAVITY_EXCEEDED

public static final Payload.ParametersWarning MASS_AND_CENTER_OF_GRAVITY_EXCEEDED

The combination of the mass and the center of gravity could affect the performance of the robot, if the payload is used.

Method Detail

values

public static Payload.ParametersWarning[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Payload.ParametersWarning c : Payload.ParametersWarning.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Payload.ParametersWarning valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null