com.ur.urcap.api.domain.io

Interface IO

All Known Subinterfaces:

AnalogIO, BooleanRegister, DigitalIO, FloatRegister, IntegerRegister, ModbusIO, Register

public interface IO

This is the base interface representing all types of I/Os available in PolyScope.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IO.InterfaceType
static class	IO.IOType

Method Summary

Modifier and Type	Method and Description
String	getDefaultName()
IO.InterfaceType	getInterfaceType()
String	getName()
IO.IOType	getType()
String	getValueStr()
boolean	isInput()
boolean	isResolvable() Some I/Os, such as MODBUS I/Os and analog Tool inputs, are in some situations not present in PolyScope or available for use.

Method Detail

getName

String getName()

Returns:

the user defined name of the IO in the currently selected installation.

getDefaultName

String getDefaultName()

Returns:

the robot default name of the I/O.

getType

IO.IOType getType()

Returns:

the I/O type.

getInterfaceType

IO.InterfaceType getInterfaceType()

Returns:

the interface type this I/O belongs to.

isInput

boolean isInput()

Returns:

true if I/O supports reading of values and false otherwise.

getValueStr

String getValueStr()

Returns:

get current reading of the I/O as a string.

isResolvable

boolean isResolvable()

Some I/Os, such as MODBUS I/Os and analog Tool inputs, are in some situations not present in PolyScope or available for use. This method can be used to determine if the I/O is available.
For more details about the specific situations where certain types of I/Os can be unresolved, see the relevant interfaces extending this base interface, e.g. ModbusIO.isResolvable().

Returns:

true, if the I/O is available in PolyScope, otherwise false.

Since:

1.7.0