org.vishia.byteData

Interface VariableAccessArray_ifc

All Superinterfaces:

VariableAccess_ifc

All Known Implementing Classes:

ByteDataSymbolicAccess.Variable

public interface VariableAccessArray_ifc
extends VariableAccess_ifc

This interface enhances the VariableAccess_ifc with the capability to access elements in an array.

Field Summary

Fields

Modifier and Type	Field and Description
static int	version Version, history and license.

Method Summary

Modifier and Type	Method and Description
int	getDimension(int dimension) Returns the number of dimension if it is an array or its number of elements.
double	getDouble(int... ixArray) Gets the value from this variable.
float	getFloat(int... ixArray) Gets the value from this variable.
int	getInt(int... ixArray) Gets a integer value from this variable.
long	getLong(int... ixArray) Gets a long value from this variable.
java.lang.String	getString(int... ixArray) Gets the value from this variable.
double	setDouble(double value, int... ixArray) Sets the value from this variable.
float	setFloat(float value, int... ixArray) Sets the value from this variable.
int	setInt(int value, int... ixArray) Sets the value into the variable.
long	setLong(long value, int... ixArray) Sets the value into the variable.
java.lang.String	setString(java.lang.String value, int... ixArray) Sets the value into the variable

Methods inherited from interface org.vishia.byteData.VariableAccess_ifc

getDouble, getFloat, getInt, getLastRefreshTime, getLastRefreshTimeShort, getLong, getString, getType, isRefreshed, isRequestedValue, requestValue, requestValue, requestValue, setDouble, setFloat, setInt, setLong, setRefreshed, setString

Field Detail

version

static final int version

Version, history and license.

• 2013-12-10 Hartmut new rename this and separate VariableAccess_ifc. All simple accesses and especially VariableAccessWithIdx need VariableAccess_ifc. All implementations need the VariableAccessArray_ifc if they support arrays.
• 2012-09-24 Hartmut new getLong(int...) and setLong(long, int...)
• 2012-04-25 Hartmut new VariableAccess_ifc.requestValue(long), VariableAccess_ifc.getLastRefreshTime(): A variable should be refreshed by determined call of VariableAccess_ifc.requestValue(long) if it holds a value from a remote device.
• 2012-03-31 Hartmut enhanced VariableAccess_ifc.getType()
• 2010-06-00 Hartmut created to access values in an UDP-telegram with given positions. The interface permits an access independent of the concrete implementation.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

Method Detail

getInt

int getInt(int... ixArray)

Gets a integer value from this variable. The variable contains the information, whether it is long, short etc. If the variable contains a long value greater as the integer range, an IllegalArgumentException may be thrown or not, it depends on the implementation. If the variable is a float or double it may be convert to the integer format. If the variable is a boolean, it is converted to 0 or 1.

Parameters:

ixArray - unused if it isn't an indexed variable.

Returns:

the value.

setInt

int setInt(int value,
           int... ixArray)

Sets the value into the variable. If the variable is of byte or short type and the value is not able to present, an IllegalArgumentException may be thrown or not, it depends on the implementation.

Parameters:

value - The value given as int.

ixArray - unused if it isn't an indexed variable.

Returns:

The value really set (maybe more imprecise).

getLong

long getLong(int... ixArray)

Gets a long value from this variable. The variable contains the information, whether it is long, short etc. If the variable is a float or double it may be convert to the long format. If the value is not able to present, an IllegalArgumentException may be thrown or not, it depends on the implementation. If the variable is a boolean, it is converted to 0 or 1.

Parameters:

ixArray - unused if it isn't an indexed variable.

Returns:

the value.

setLong

long setLong(long value,
             int... ixArray)

Sets the value into the variable. If the variable is of byte, short or int type and the value is not able to present, an IllegalArgumentException may be thrown or not, it depends on the implementation.

Parameters:

value - The value given as int.

ixArray - unused if it isn't an indexed variable.

Returns:

The value really set (maybe more imprecise).

getFloat

float getFloat(int... ixArray)

Gets the value from this variable. If the variable is in another format than float, a conversion to be will be done.

Parameters:

ixArray - unused if it isn't an indexed variable.

Returns:

the value.

setFloat

float setFloat(float value,
               int... ixArray)

Sets the value from this variable.

Parameters:

ixArray - unused if it isn't an indexed variable.

Returns:

the value.

getDouble

double getDouble(int... ixArray)

Gets the value from this variable. If the variable is in another format than double, a conversion to be will be done.

Parameters:

ixArray - unused if it isn't an indexed variable.

Returns:

the value.

setDouble

double setDouble(double value,
                 int... ixArray)

Sets the value from this variable. If the variable is from float type, and the range (exponent) is able to present in float, the value will be stored in float with truncation of digits.

Parameters:

ixArray - unused if it isn't an indexed variable.

Returns:

the value.

getString

java.lang.String getString(int... ixArray)

Gets the value from this variable. If the variable is numerical, it is converted to a proper representation.

Parameters:

ixArray - unused if it isn't an indexed variable.

Returns:

the value.

setString

java.lang.String setString(java.lang.String value,
                           int... ixArray)

Sets the value into the variable

Parameters:

value - The value given as String.

ixArray - unused if it isn't an indexed variable.

Returns:

The value really set (maybe shortened).

getDimension

int getDimension(int dimension)

Returns the number of dimension if it is an array or its number of elements.

Parameters:

dimension - 0 to get number of dimension, 1... to get the length of the dimension.

Returns:

0 if it hasn't such an dimension.