com.iotize.jvm

Class TapNLinkVarIntArray

java.lang.Object

com.iotize.jvm.TapNLinkVar

com.iotize.jvm.TapNLinkVarIntArray

public final class TapNLinkVarIntArray
extends TapNLinkVar

TapNLink class to manage integer (signed / unsigned, 8, 16 or 32 bits) 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
TapNLinkVarIntArray(short id, short ctype, java.lang.String name, int periodms, int size) Creates a new Java object to manage the specified integer array variable that is configured in the tap.
TapNLinkVarIntArray(short id, VariableType type, java.lang.String name, int periodms, int size) Deprecated.

Method Summary

Modifier and Type	Method and Description
int	getSize() Returns the length of the variable array.
int[]	getValue() Returns the value of the integer array variable.
int[]	getValue(boolean generateException) Returns the value of the integer array variable.
void	setValue(int[] array) Sets the value of the variable with a new integer array
void	setValue(int[] array, boolean generateException) Sets the value of the variable with a new integer array If generateException is true, a TapNLinkException will be thrown if the write action fails.

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

TapNLinkVarIntArray

@Deprecated
public TapNLinkVarIntArray(short id,
                                        VariableType type,
                                        java.lang.String name,
                                        int periodms,
                                        int size)

Deprecated.

DEPRECATED **************** Obsolete: VariableType are replaced by 'short' values (see next method). Creates a new Java object to manage the specified integer array variable that is configured in the tap.

Parameters:

id - the id of the variable in the tap

type - the VariableType of the elements of the array

name - the name of the variable

periodms - the period at which the variable is monitored

size - the size of the array

TapNLinkVarIntArray

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

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

Parameters:

id - the id of the variable in the tap

ctype - the Type of the elements of the array

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(int[] array)

Sets the value of the variable with a new integer array

Parameters:

array - the new value of the variable

setValue

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

Sets the value of the variable with a new integer array 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 int[] getValue()

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

Returns:

the value of the variable

getValue

public final int[] getValue(boolean generateException)

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

Parameters:

generateException -

Returns:

the value of the variable

getSize

public final int getSize()

Returns the length of the variable array.

Returns:

the length of the array