com.kuka.roboticsAPI.requestModel
Class ReadIORequest

java.lang.Object
  com.kuka.roboticsAPI.requestModel.AbstractRequest
      com.kuka.roboticsAPI.requestModel.ReadIORequest

All Implemented Interfaces:

IRequest

public class ReadIORequest
extends AbstractRequest

Request for reading an I/O.

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 Summary

ReadIORequest(String ioGroup, String ioName, boolean isOutput, com.kuka.roboticsAPI.ioModel.IOTypes ioType, int bitSize)
Creates a new request.

Method Summary

int	getBitSize() Gets the bitSize of the IO.
String	getIOGroupName() Gets the name of the IO group.
String	getIOName() Gets the name of the IO.
com.kuka.roboticsAPI.ioModel.IOTypes	getIOType() Gets the type of the IO.
Number	getResult() Gets the result of the request (the IO value).
boolean	hasResult() Returns true if getResult is not null.
boolean	isOutput() IO is output.
void	setResult(Number result) Sets the read IO result.

Methods inherited from class com.kuka.roboticsAPI.requestModel.AbstractRequest

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadIORequest

public ReadIORequest(String ioGroup,
                     String ioName,
                     boolean isOutput,
                     com.kuka.roboticsAPI.ioModel.IOTypes ioType,
                     int bitSize)

Creates a new request.

Parameters:

ioGroup - name of the IO group

ioName - name of the IO

isOutput - IO is output

ioType - type of the IO

bitSize - bit size of the IO

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

getResult

public Number getResult()

Gets the result of the request (the IO value).

Returns:

The result of the request, which is the IO value. The IO values will be mapped as follows:

Bit IO

Integer with values 0 or 1

Digital IO

Long with in the allowable range for the IO type

Analog IO

Double

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.

hasResult

public boolean hasResult()

Returns true if getResult is not null. May be overridden by subclasses to determine if the request has a result in a different way.

Specified by:

hasResult in interface IRequest

Overrides:

hasResult in class AbstractRequest

Returns:

True if the request has a result.

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.

getIOGroupName

public String getIOGroupName()

Gets the name of the IO group.

Returns:

the name of the IO group

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.

getIOName

public String getIOName()

Gets the name of the IO.

Returns:

the name of the IO

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.

isOutput

public boolean isOutput()

IO is output.

Returns:

true if IO is output

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.

getBitSize

public int getBitSize()

Gets the bitSize of the IO.

Returns:

the IO bitSize

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.

getIOType

public com.kuka.roboticsAPI.ioModel.IOTypes getIOType()

Gets the type of the IO.

Returns:

the type of the IO

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.

setResult

public void setResult(Number result)

Sets the read IO result.

Parameters:

result - The result of the request, which is the IO value. The IO values must be mapped as follows:

Bit IO

Integer with values 0 or 1

Digital IO

Long with in the allowable range for the IO type

Analog IO

Double

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.