org.lsst.ccs.drivers.ads

Class VariableHandle

java.lang.Object

org.lsst.ccs.drivers.ads.VariableHandle

public class VariableHandle
extends Object

Contains information about a PLC variable in the remote server. Instances are generated by the ADS driver.

Author:

tether

See Also:

ADSDriver.getVariableHandle(java.lang.String), ADSDriver.releaseVariableHandle(org.lsst.ccs.drivers.ads.VariableHandle)

Method Summary

Modifier and Type	Method and Description
ByteBuffer	createBuffer() Creates a read-write ByteBuffer that has the correct byte order, position=0 with capacity and limit both set to the variable size.
int	getHandleValue() Gets the 32-bit handle assigned to the variable by the remote server.
String	getName() Gets the variable name passed to ADSDriver.getVariableHandle(java.lang.String).
int	getVarSize() Gets the size of the PLC variable in bytes.

Methods inherited from class java.lang.Object

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

Method Detail

getHandleValue

public int getHandleValue()

Gets the 32-bit handle assigned to the variable by the remote server.

Returns:

The handle.

getName

public String getName()

Gets the variable name passed to ADSDriver.getVariableHandle(java.lang.String).

Returns:

The name string.

getVarSize

public int getVarSize()

Gets the size of the PLC variable in bytes.

Returns:

The size.

createBuffer

public ByteBuffer createBuffer()

Creates a read-write ByteBuffer that has the correct byte order, position=0 with capacity and limit both set to the variable size.

Returns:

The buffer.