com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib
Class NameserverData

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib.NameserverData

public class NameserverData
extends Object

Data class for nameserver requests. Mirrors the C++ struct from the C++ Nameserver implementation.

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.

Field Summary

static int

DATA_LENGTH The length in bytes of a nameserver data packet.

Constructor Summary

NameserverData()
Creates a new NameserverData instance.

Method Summary

void	failOnError() Tests if the current nameserver data contains an error id and throws an appropriate exception.
String	getAddress() Gets the address entry.
byte[]	getBuffer() Gets the underlying buffer for this nameserver data.
CommunicationMedium	getChosenCommunicationMedium() Gets the communication medium entry out of this data which was chosen by the nameserver.
String	getConnectionName() Gets the connection name entry.
NameserverRequestType	getRequestType() Gets the nameserver request type entry out of this data.
boolean	hasEmptyBuffer() Checks whether there is any data left in the buffer.
void	resetBuffer() Resets the buffer to 0.
void	setAddress(String address) Sets the address entry.
void	setChosenCommunicationMedium(CommunicationMedium medium) Sets the communication medium which should be used for communication.
void	setCommunicationMedium(Set<CommunicationMedium> mediums) Sets the communication medium entry.
void	setConnectionName(String name) Sets the connection name entry.
void	setConnectionType(ConnectionType connectionType) Sets the connection type entry.
void	setErrorMessage(String message) Sets the error message for this data.
void	setMaxClient(int maxClients) Sets the max clients entry.
void	setRequestType(NameserverRequestType type) Sets the nameserver request typeentry.
void	setReturnValue(int value) Sets the return value flag for the data.
void	setSystemType() Sets the system type for this nameserver data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATA_LENGTH

public static final int DATA_LENGTH

The length in bytes of a nameserver data packet.

See Also:

Constant Field Values

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.

Constructor Detail

NameserverData

public NameserverData()

Creates a new NameserverData instance.

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.

Method Detail

resetBuffer

public void resetBuffer()

Resets the buffer to 0.

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.

getBuffer

public byte[] getBuffer()

Gets the underlying buffer for this nameserver data.

Returns:

The underlying buffer for this nameserver data.

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.

failOnError

public void failOnError()

Tests if the current nameserver data contains an error id and throws an appropriate exception.

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.

setReturnValue

public void setReturnValue(int value)

Sets the return value flag for the data.

Parameters:

value - The return value flag for the data.

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.

setErrorMessage

public void setErrorMessage(String message)

Sets the error message for this data.

Parameters:

message - The error message for this data.

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.

getChosenCommunicationMedium

public CommunicationMedium getChosenCommunicationMedium()

Gets the communication medium entry out of this data which was chosen by the nameserver.

Returns:

The communication medium entry.

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.

setChosenCommunicationMedium

public void setChosenCommunicationMedium(CommunicationMedium medium)

Sets the communication medium which should be used for communication.

Parameters:

medium - The communication medium entry.

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.

getRequestType

public NameserverRequestType getRequestType()

Gets the nameserver request type entry out of this data.

Returns:

The nameserver request type entry.

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.

setRequestType

public void setRequestType(NameserverRequestType type)

Sets the nameserver request typeentry.

Parameters:

type - The nameserver request type value.

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.

setAddress

public void setAddress(String address)

Sets the address entry.

Parameters:

address - The address.

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.

setConnectionName

public void setConnectionName(String name)

Sets the connection name entry.

Parameters:

name - The conenction name.

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.

getConnectionName

public String getConnectionName()

Gets the connection name entry.

Returns:

The connection name entry.

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.

setConnectionType

public void setConnectionType(ConnectionType connectionType)

Sets the connection type entry.

Parameters:

connectionType - The connection 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.

setCommunicationMedium

public void setCommunicationMedium(Set<CommunicationMedium> mediums)

Sets the communication medium entry.

Parameters:

mediums - The communication mediums.

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.

setMaxClient

public void setMaxClient(int maxClients)

Sets the max clients entry.

Parameters:

maxClients - The max clients amount.

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.

setSystemType

public void setSystemType()

Sets the system type for this nameserver data.

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.

getAddress

public String getAddress()

Gets the address entry.

Returns:

The address entry.

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.

hasEmptyBuffer

public boolean hasEmptyBuffer()

Checks whether there is any data left in the buffer.

Returns:

True if buffer is empty

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.