com.iotize.jvm

Class TapNLinkVarByteArray

java.lang.Object

com.iotize.jvm.TapNLinkVar

com.iotize.jvm.TapNLinkVarByteArray

public final class TapNLinkVarByteArray
extends TapNLinkVar

TapNLink class to manage byte array variables

Field Summary

Fields inherited from class com.iotize.jvm.TapNLinkVar

ARRAY, FLOAT32, INT16, INT32, INT8, UINT16, UINT32, UINT8

Constructor Summary

Constructors

Constructor and Description
TapNLinkVarByteArray(short id, java.lang.String name, int periodms, int size) Creates a new Java object to manage the specified byte array variable that is configured in the tap.

Method Summary

Modifier and Type	Method and Description
short	getSize() Returns the length of the variable array.
java.lang.String	getString() Returns the value of the variable, formatted as an ASCII string.
byte[]	getValue() Returns the value of the variable, as a byte array If the read action failed, the last retrieved value is returned.
byte[]	getValue(boolean generateException) Returns the value of the variable, as a byte array If generateException is true, a TapNLinkException will be thrown if the read action fails.
void	setValue(byte[] array) Sets the variable with the given byte array.
void	setValue(byte[] array, boolean generateException) Sets the variable with the given byte array.

Methods inherited from class com.iotize.jvm.TapNLinkVar

getcType, getId, getName, getPeriod, getTime, getType

Methods inherited from class java.lang.Object

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

Constructor Detail

TapNLinkVarByteArray

public TapNLinkVarByteArray(short id,
                            java.lang.String name,
                            int periodms,
                            int size)

Creates a new Java object to manage the specified byte array variable that is configured in the tap.

Parameters:

id - the id of the variable in the tap

name - the name of the variable

periodms - the period at which the variable is monitored

size - the size of the array

Method Detail

setValue

public final void setValue(byte[] array)

Sets the variable with the given byte array. If the given array is larger than the size property, it will be truncated.

Parameters:

array - the new value of the variable

setValue

public final void setValue(byte[] array,
                           boolean generateException)

Sets the variable with the given byte array. If the given array is larger than the size property, it will be truncated. If generateException is true, a TapNLinkException will be thrown if the write action fails.

Parameters:

array - the new value of the variable

generateException -

getValue

public final byte[] getValue()

Returns the value of the variable, as a byte array If the read action failed, the last retrieved value is returned.

Returns:

byte array

getValue

public final byte[] getValue(boolean generateException)

Returns the value of the variable, as a byte array If generateException is true, a TapNLinkException will be thrown if the read action fails.

Parameters:

generateException -

Returns:

byte array

getString

public final java.lang.String getString()

Returns the value of the variable, formatted as an ASCII string.

Returns:

the value of the variable, as a string

getSize

public final short getSize()

Returns the length of the variable array.

Returns:

the length of the array