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

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

All Implemented Interfaces:

Serializable, Comparable<MessageType>

public enum MessageType
extends Enum<MessageType>

Contains the message type enumeration. Each message has a certain type identified by a member of this enum.

This enum represents a default set of message types. As the type is only an integer, each system may introduce it's own MessageType enum which reflects it's used message types.

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

CmdAnswer
This message is a answer to a command message.

Command
Message containing a command for Sunrise (like update or cancel).

CompoundEvent
Asynchronous event message from a Sunrise compound.

CompoundIOConfig
Message containing the return value order for a SPR.

CompoundIOValues
Message containing compound IO values.

CompoundReply
ANswer to a async compound request.

CompoundRequest
Async compound request.

Error
Error message.

Event
Indicates an asynchronous event message from Sunrise.

KeepAlive
This message type is used for a keep-alive message.

List
Message containing a list of messages.

Register
This message type is used for an registration message.

ReturnState
Message containing return value data for a SPR.

SPR
Message containing a SPR.

SSR
Message containing a SSR.

State
Message containing a state for a SPR.

Stop
Message containing a stop message, used inside KREML.

Unknown
Unknown message type.

Update
Message containing an update message, used inside KREML.

Method Summary

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

Error

public static final MessageType Error

Error message.

SPR

public static final MessageType SPR

Message containing a SPR.

SSR

public static final MessageType SSR

Message containing a SSR.

State

public static final MessageType State

Message containing a state for a SPR.

CmdAnswer

public static final MessageType CmdAnswer

This message is a answer to a command message.

Command

public static final MessageType Command

Message containing a command for Sunrise (like update or cancel).

CompoundIOConfig

public static final MessageType CompoundIOConfig

Message containing the return value order for a SPR.

CompoundIOValues

public static final MessageType CompoundIOValues

Message containing compound IO values.

Event

public static final MessageType Event

Indicates an asynchronous event message from Sunrise.

List

public static final MessageType List

Message containing a list of messages.

ReturnState

public static final MessageType ReturnState

Message containing return value data for a SPR.

Update

public static final MessageType Update

Message containing an update message, used inside KREML.

Stop

public static final MessageType Stop

Message containing a stop message, used inside KREML.

KeepAlive

public static final MessageType KeepAlive

This message type is used for a keep-alive message.

Register

public static final MessageType Register

This message type is used for an registration message.

CompoundRequest

public static final MessageType CompoundRequest

Async compound request.

CompoundReply

public static final MessageType CompoundReply

ANswer to a async compound request.

CompoundEvent

public static final MessageType CompoundEvent

Asynchronous event message from a Sunrise compound.

Unknown

public static final MessageType Unknown

Unknown message type.

Method Detail

values

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

Returns:

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

valueOf

public static MessageType 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 type.

Returns:

The id of the message 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 MessageType fromId(int id)

Creates a message type out of the given id.

Parameters:

id - The id of the message.

Returns:

The mapped message 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.