com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib
Enum MessageParameterType

java.lang.Object
  java.lang.Enum<MessageParameterType>
      com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib.MessageParameterType

All Implemented Interfaces:

Serializable, Comparable<MessageParameterType>

public enum MessageParameterType
extends Enum<MessageParameterType>

Defines the parameter types accepted by a message.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Enum Constant Summary

BLOB
ByteArray parameter.

BLOBNamed
ByteArray parameter.

Double
Double parameter.

DoubleArray
Double array.

DoubleArrayNamed
Double array.

DoubleNamed
Double parameter.

Integer
Integer parameter.

IntegerArray
Integer array.

IntegerArrayNamed
Integer array.

IntegerNamed
Integer parameter.

String
String parameter.

StringNamed
String parameter.

Unknown
Unknown parameter.

Method Summary

static MessageParameterType	fromId(int id) Creates a message parameter type out of the given id.
int	getId() Gets the id of the message parameter type.
boolean	isNamed() true if type is named.
static MessageParameterType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageParameterType[]	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

String

public static final MessageParameterType String

String parameter.

Integer

public static final MessageParameterType Integer

Integer parameter.

Double

public static final MessageParameterType Double

Double parameter.

BLOB

public static final MessageParameterType BLOB

ByteArray parameter.

IntegerArray

public static final MessageParameterType IntegerArray

Integer array.

DoubleArray

public static final MessageParameterType DoubleArray

Double array.

StringNamed

public static final MessageParameterType StringNamed

String parameter.

IntegerNamed

public static final MessageParameterType IntegerNamed

Integer parameter.

DoubleNamed

public static final MessageParameterType DoubleNamed

Double parameter.

BLOBNamed

public static final MessageParameterType BLOBNamed

ByteArray parameter.

IntegerArrayNamed

public static final MessageParameterType IntegerArrayNamed

Integer array.

DoubleArrayNamed

public static final MessageParameterType DoubleArrayNamed

Double array.

Unknown

public static final MessageParameterType Unknown

Unknown parameter.

Method Detail

values

public static MessageParameterType[] 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 (MessageParameterType c : MessageParameterType.values())
    System.out.println(c);

Returns:

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

valueOf

public static MessageParameterType 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

getId

public int getId()

Gets the id of the message parameter type.

Returns:

The id of the message parameter type.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

fromId

public static MessageParameterType fromId(int id)

Creates a message parameter type out of the given id.

Parameters:

id - The id of the message parameter.

Returns:

The mapped message parameter type or Unknown if id is not known.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

isNamed

public boolean isNamed()

true if type is named.

Returns:

true if type is named

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.