com.kuka.roboticsAPI.requestModel
Class GetIODetailsRequest

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

All Implemented Interfaces:

IRequest

public class GetIODetailsRequest
extends AbstractRequest

Request to get information about IOs.

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.

Nested Class Summary

static class

GetIODetailsRequest.GetIOCommandType The possible types of the IO request.

Constructor Summary

GetIODetailsRequest()
Creates a request to get detailed information about all IOs of the controller.

GetIODetailsRequest(com.kuka.roboticsAPI.ioModel.IOGroupDetail ioGroupDetails)
Creates a request that updates the value of the supplied IO-group IOs.

GetIODetailsRequest(String ioGroupName)
Creates a request to get detailed information about all the IOs that belong to the specified IO-group.

GetIODetailsRequest(String busDriverName, String busInstanceName)
Creates a request to get detailed information about all the IOs that belong to the specified bus (identified by bus driver name and bus instance name).

GetIODetailsRequest(String ioGroupName, String ioName, boolean isOutput)
Creates a request to get detailed information about a specific IO of the controller.

Method Summary

void	addDetail(com.kuka.roboticsAPI.ioModel.IODetail detail) Adds an IO detail to the result list.
com.kuka.roboticsAPI.ioModel.IODetail	findDetail(String ioGroupName, String ioName, com.kuka.roboticsAPI.ioModel.IODirection direction, int possibleIndex) Tries to find the an IODetail in the result list that matches the specified names and direction.
String	getBusDriverName() Gets the name of the bus driver.
String	getBusInstanceName() Gets the bus instance name.
GetIODetailsRequest.GetIOCommandType	getGetIOCommandType() Gets the type the get IO request (indicates whether all, only an IO-group or only an IO should be queried).
String	getIOGroupName() Gets the name of the IO group that should be queried.
String	getIOName() Gets the name of the IO that should be queried.
List<com.kuka.roboticsAPI.ioModel.IODetail>	getResult() Gets the result of the request.
boolean	hasResult() Returns true if getResult is not null.
boolean	isGetFullDetails() Gets the detail level of the request answer.
boolean	isOutput() Gets the direction of the I/O.
void	setHasResult() Signals that a result is existing ant set.

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

GetIODetailsRequest

public GetIODetailsRequest()

Creates a request to get detailed information about all IOs of the 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.

GetIODetailsRequest

public GetIODetailsRequest(String ioGroupName,
                           String ioName,
                           boolean isOutput)

Creates a request to get detailed information about a specific IO of the controller.

Parameters:

ioGroupName - name of the IO-group the IO belongs to

ioName - name of the IO

isOutput - true if the IO is an output, false otherwise

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.

GetIODetailsRequest

public GetIODetailsRequest(String ioGroupName)

Creates a request to get detailed information about all the IOs that belong to the specified IO-group.

Parameters:

ioGroupName - 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.

GetIODetailsRequest

public GetIODetailsRequest(com.kuka.roboticsAPI.ioModel.IOGroupDetail ioGroupDetails)

Creates a request that updates the value of the supplied IO-group IOs. This request sends a simple message to the controller and only updates the IO value in its result.

Parameters:

ioGroupDetails - all details about 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.

GetIODetailsRequest

public GetIODetailsRequest(String busDriverName,
                           String busInstanceName)

Creates a request to get detailed information about all the IOs that belong to the specified bus (identified by bus driver name and bus instance name).

Parameters:

busDriverName - bus driver name

busInstanceName - bus instance 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.

Method Detail

getIOGroupName

public String getIOGroupName()

Gets the name of the IO group that should be queried.

Returns:

the name of the IO group that should be queried

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.

getBusDriverName

public String getBusDriverName()

Gets the name of the bus driver.

Returns:

bus driver 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.

getBusInstanceName

public String getBusInstanceName()

Gets the bus instance name.

Returns:

bus instance 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.

getIOName

public String getIOName()

Gets the name of the IO that should be queried.

Returns:

the name of the IO that should be queried

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

Gets the direction of the I/O.

Returns:

true if I/O is an output, false otherwise

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.

getGetIOCommandType

public GetIODetailsRequest.GetIOCommandType getGetIOCommandType()

Gets the type the get IO request (indicates whether all, only an IO-group or only an IO should be queried).

Returns:

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

isGetFullDetails

public boolean isGetFullDetails()

Gets the detail level of the request answer.

Returns:

true, if all details and false if only the IO values should be queried.

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.

getResult

public List<com.kuka.roboticsAPI.ioModel.IODetail> 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.

setHasResult

public void setHasResult()

Signals that a result is existing ant 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.

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.

addDetail

public void addDetail(com.kuka.roboticsAPI.ioModel.IODetail detail)

Adds an IO detail to the result list.

Parameters:

detail - the detail to add.

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.

findDetail

public com.kuka.roboticsAPI.ioModel.IODetail findDetail(String ioGroupName,
                                                        String ioName,
                                                        com.kuka.roboticsAPI.ioModel.IODirection direction,
                                                        int possibleIndex)

Tries to find the an IODetail in the result list that matches the specified names and direction. The possibleIndex parameter is an optimization: Normally the list sorting never changes, so the index is known and tested first.

Parameters:

ioGroupName - name of the IO-group.

ioName - name of the IO

direction - direction of the IO

possibleIndex - possible index within the the result list where the details can be found

Returns:

details about 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.