com.iotize.jvm

Class TapNLinkVarInt

java.lang.Object

com.iotize.jvm.TapNLinkVar

com.iotize.jvm.TapNLinkVarInt

public final class TapNLinkVarInt
extends TapNLinkVar

TapNLink class to manage integer 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
TapNLinkVarInt(short id, short ctype, java.lang.String name, int periodms) Creates a new Java object to manage the specified integer variable that is configured in the tap.
TapNLinkVarInt(short id, VariableType type, java.lang.String name, int periodms) Deprecated. VariableType are replaced by 'short' values (see next method).

Method Summary

Modifier and Type	Method and Description
long	getLValue() Deprecated. Returns the value of the variable as a long integer. If the variable is not a UINT32, use getValue() instead.
int	getValue() Returns the value of the variable as an integer.
int	getValue(boolean generateException) Returns the value of the variable as an integer.
void	setLValue(long v) Deprecated. Sets the variable with a new long integer value. If the variable is not a UINT32, use setValue(int v) instead.
void	setValue(int v) Sets the variable with a new integer value.
void	setValue(int v, boolean generateException) Sets the variable with a new integer value.

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

TapNLinkVarInt

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

Deprecated. VariableType are replaced by 'short' values (see next method).

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

Parameters:

id - the id of the variable in the tap

type - the VariableType of the variable

name - the name of the variable

periodms - the period at which the variable is monitored

TapNLinkVarInt

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

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

Parameters:

id - the id of the variable in the tap

ctype - the Type of the variable

name - the name of the variable

periodms - the period at which the variable is monitored

Method Detail

getValue

public final int getValue()

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

Returns:

the value of the variable as an integer

getValue

public final int getValue(boolean generateException)

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

Parameters:

generateException -

Returns:

the value of the variable as an integer

getLValue

public final long getLValue()

Deprecated. Returns the value of the variable as a long integer. If the variable is not a UINT32, use getValue() instead.

Returns:

the value of the variable as a long integer

setValue

public final void setValue(int v)

Sets the variable with a new integer value.

Parameters:

v - the new value of the variable

setValue

public final void setValue(int v,
                           boolean generateException)

Sets the variable with a new integer value. If generateException is true, a TapNLinkException will be thrown if the read action fails.

Parameters:

generateException -

v - the new value of the variable

setLValue

public final void setLValue(long v)

Deprecated. Sets the variable with a new long integer value. If the variable is not a UINT32, use setValue(int v) instead.

Parameters:

v - the new value of the variable