com.kuka.roboticsAPI.requestModel
Class WriteIORequest

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

All Implemented Interfaces:

IRequest

public class WriteIORequest
extends AbstractRequest

Request for writing IO values to a controller.

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

WriteIORequest(String ioGroup, String ioName, boolean value)
Creates a request for writing an boolean IO value.

WriteIORequest(String ioGroup, String ioName, double value)
Creates a request for writing analog IO values.

WriteIORequest(String ioGroup, String ioName, com.kuka.roboticsAPI.ioModel.IOTypes ioType, int bitSize, Number value)
Creates a request for writing digital IO value.

Method Summary

int	getBitSize() Gets the bit size of the IO.
String	getIOGroupName() Gets the name of the IO group.
String	getIOName() Gets the full name of the IO.
com.kuka.roboticsAPI.ioModel.IOTypes	getIOType() Gets the type of the IO.
Number	getIOValue() Returns the Value of the IO.
Object	getResult() Gets the result of the request.
boolean	hasResult() Returns true if getResult is not null.
void	setSucceeded() Indicates if this request has succeeded.

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

WriteIORequest

public WriteIORequest(String ioGroup,
                      String ioName,
                      com.kuka.roboticsAPI.ioModel.IOTypes ioType,
                      int bitSize,
                      Number value)

Creates a request for writing digital IO value.

Parameters:

ioGroup - name of the IO-group

ioName - name of the IO

ioType - type of the IO

bitSize - bitSize of the IO

value - The digital value to write. Must be of following type:

Bit IO

Integer with values 0 or 1

Digital IO

Long within 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.

WriteIORequest

public WriteIORequest(String ioGroup,
                      String ioName,
                      boolean value)

Creates a request for writing an boolean IO value.

Parameters:

ioGroup - name of the IO-group

ioName - name of the IO

value - boolean value to set

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.

WriteIORequest

public WriteIORequest(String ioGroup,
                      String ioName,
                      double value)

Creates a request for writing analog IO values.

Parameters:

ioGroup - name of the IO-group

ioName - name of the IO

value - analog value to write

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 Object getResult()

Gets the result of the request.

Returns:

The result of the request.

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.

setSucceeded

public void setSucceeded()

Indicates if this request has succeeded.

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:

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 full name of the IO.

Returns:

IO full 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.

getIOType

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

Gets the type of the IO.

Returns:

the IO 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.

getIOValue

public Number getIOValue()

Returns the Value of the IO.

Returns:

The IO value. The IO values will be mapped as follows:

Bit IO

Integer with values 0 or 1

Digital IO

Long within 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.

getBitSize

public int getBitSize()

Gets the bit size of the IO.

Returns:

IO bit size.

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.