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

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

All Implemented Interfaces:

Serializable, Comparable<CommunicationMedium>

public enum CommunicationMedium
extends Enum<CommunicationMedium>

Available communication mediums for channels.

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

AfLocal
AfLocal socket medium.

AllMedia
Describing all available mediums.

NoMedium
No medium.

TcpIp
TcpIp socket medium.

Method Summary

com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib.Channel	createChannel(NameserverProxy proxy) Creates an empty, uninitialized channel fitting the given communication medium.
static CommunicationMedium	fromId(int id) Creates a communication medium out of a given id.
int	getId() Gets the id of the medium.
static CommunicationMedium	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommunicationMedium[]	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

NoMedium

public static final CommunicationMedium NoMedium

No medium. Default value.

AfLocal

public static final CommunicationMedium AfLocal

AfLocal socket medium.

TcpIp

public static final CommunicationMedium TcpIp

TcpIp socket medium.

AllMedia

public static final CommunicationMedium AllMedia

Describing all available mediums.

Method Detail

values

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

Returns:

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

valueOf

public static CommunicationMedium 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 medium.

Returns:

The id of the medium.

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 CommunicationMedium fromId(int id)

Creates a communication medium out of a given id.

Parameters:

id - The id of the medium.

Returns:

The specified medium or NoMedium if id was 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.

createChannel

public com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib.Channel createChannel(NameserverProxy proxy)

Creates an empty, uninitialized channel fitting the given communication medium.

Parameters:

proxy - The nameserver with which the channel was created.

Returns:

An empty, uninitialized channel fitting the given communication medium.

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.