VariableAccessWithIdx

java.lang.Object
- org.vishia.byteData.VariableAccessWithIdx

All Implemented Interfaces:

VariableAccess_ifc
```
public class VariableAccessWithIdx
extends java.lang.Object
implements VariableAccess_ifc
```
This class supports the access to any type of variable with given indices and bit masks. The indices and the bit mask are not part of a variable itself because a variable is an entity to access data in any target system.
Reason: If some bits should be read from a variable, and then other bits should be read, the variable should be gotten from the target device only one time. Therefore it is only one variable. But the access to several bits - or indices are controlled with this class.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`bit` The position of the last significant bit if the value of the variable is placed in some bits or specially in only one bit, a boolean value. 0 per default.
`protected int[]`	`ixArray` Array of indices to access if the variable has more as one dimension.
`protected int`	`mask` The mask to access to some bits.
`protected VariableAccessArray_ifc`	`variable` The entity of a variable.
`static int`	`version` Version, history and license 2012-09-24 Hartmut new `#getLong(int...)`

Constructor Summary

Constructors
Constructor and Description
`VariableAccessWithIdx(VariableAccessArray_ifc variable)`
`VariableAccessWithIdx(VariableAccessArray_ifc variable, int[] idx)`
`VariableAccessWithIdx(VariableAccessArray_ifc variable, int[] idx, int bit, int mask)`
`VariableAccessWithIdx(VariableAccessArray_ifc variable, int bit, int mask)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getDouble()` Gets the value from this variable.
`float`	`getFloat()` Gets the value from this variable.
`int`	`getInt()` Returns the integer representation of the value of the variable.
`long`	`getLastRefreshTime()` Gets the time stamp when this variable was refreshed lastly.
`int[]`	`getLastRefreshTimeShort()` Returns a pair of timeShort and timeShortAdd (see `Timeshort`) of the last refresh time if timeAbs is not available or the necessary resolution should be finer than 1 ms.
`long`	`getLong()` Returns the integer representation of the value of the variable.
`java.lang.String`	`getString()` Gets the value from this variable.
`char`	`getType()` Returns the type of the variable:
`VariableAccess_ifc`	`getVariable()`
`boolean`	`isRefreshed()` Returns true if the variable was refreshed after it was requested.
`boolean`	`isRequestedValue(long timeEarlyRequested, boolean retryFaultyVariables)` Returns true if the request is newer than the last refresh.
`void`	`requestValue()` Requests a new value from the target device with the `System.currentTimeMillis()`
`void`	`requestValue(long timeRequested)` Requests a new value from the target device.
`void`	`requestValue(long timeRequested, java.lang.Runnable run)` Requests a new value from the target device.
`double`	`setDouble(double value)` Sets the value from this variable.
`float`	`setFloat(float value)` Sets a float to the variable.
`void`	`setFloat(float value, int... ix)` Sets a value to the variable which is an array variable.
`int`	`setInt(int value)` Sets the value into the variable.
`long`	`setLong(long value)` Sets the value into the variable.
`void`	`setRefreshed(long time)`
`java.lang.String`	`setString(java.lang.String src)` Sets the value into the variable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - version
```
public static final int version
```
    Version, history and license
    - 2012-09-24 Hartmut new #getLong(int...)
    - 2012-08-23 Hartmut new setFloat(float, int...) Access a variable with an index if this describes the non-indexed variable. It is only implmented yet for the setFloat. TODO: for all others too.
    - 2012-03-31 Hartmut created. Before that, a org.vishia.gral.base.GralWidget has accessed a variable via VariableAccess_ifcand the necessary index #idx for an arry variable was contained in the GralWidget. Secondary the possibility of mask of some bits was impossible. The access to a array or bitfield variable is not a problem of the widget in a GUI, it is a problem of access to the variable. Therefore this class was created.
      A implementation of VariableAccess_ifc should not contain this details of access A variable accessed via VariableAccess_ifc is an entity of access to a whole data element. This class controls the access to details of a variable.
    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
  - variable
```
protected final VariableAccessArray_ifc variable
```
    The entity of a variable.
  - ixArray
```
protected final int[] ixArray
```
    Array of indices to access if the variable has more as one dimension.
  - mask
```
protected final int mask
```
    The mask to access to some bits. The mask is shifted to right with bit. For example if bit 3..1 should be gotten, mask = 0x7 and bit=1. It is -1 (all bits set) if the value should not be mask.
  - bit
```
protected final int bit
```
    The position of the last significant bit if the value of the variable is placed in some bits or specially in only one bit, a boolean value. 0 per default.
- Constructor Detail
  - VariableAccessWithIdx
```
public VariableAccessWithIdx(VariableAccessArray_ifc variable,
                             int[] idx,
                             int bit,
                             int mask)
```
  - VariableAccessWithIdx
```
public VariableAccessWithIdx(VariableAccessArray_ifc variable,
                             int[] idx)
```
  - VariableAccessWithIdx
```
public VariableAccessWithIdx(VariableAccessArray_ifc variable)
```
  - VariableAccessWithIdx
```
public VariableAccessWithIdx(VariableAccessArray_ifc variable,
                             int bit,
                             int mask)
```
- Method Detail
  - getDouble
```
public double getDouble()
```
    Description copied from interface: VariableAccess_ifc
    
    Gets the value from this variable. If the variable is in another format than double, a conversion to be will be done.
    
    Specified by:
    
    getDouble in interface VariableAccess_ifc
    
    Returns:
    
    the value.
  - getFloat
```
public float getFloat()
```
    Description copied from interface: VariableAccess_ifc
    
    Gets the value from this variable. If the variable is in another format than float, a conversion to be will be done.
    
    Specified by:
    
    getFloat in interface VariableAccess_ifc
    
    Returns:
    
    the value.
  - getString
```
public java.lang.String getString()
```
    Description copied from interface: VariableAccess_ifc
    
    Gets the value from this variable. If the variable is numerical, it is converted to a proper representation.
    
    Specified by:
    
    getString in interface VariableAccess_ifc
    
    Returns:
    
    the value.
  - setRefreshed
```
public void setRefreshed(long time)
```
    Specified by:
    
    setRefreshed in interface VariableAccess_ifc
  - getLastRefreshTime
```
public long getLastRefreshTime()
```
    Description copied from interface: VariableAccess_ifc
    
    Gets the time stamp when this variable was refreshed lastly.
    
    Specified by:
    
    getLastRefreshTime in interface VariableAccess_ifc
    
    Returns:
    
    -1 if this function is not supported, 0 if this variable was never set.
  - getLastRefreshTimeShort
```
public int[] getLastRefreshTimeShort()
```
    Description copied from interface: VariableAccess_ifc
    
    Returns a pair of timeShort and timeShortAdd (see Timeshort) of the last refresh time if timeAbs is not available or the necessary resolution should be finer than 1 ms.
    
    Specified by:
    
    getLastRefreshTimeShort in interface VariableAccess_ifc
    
    Returns:
    
    null if this operation is not supported. Elsewhere an array with at least 2 elements. The first element[0] is the timeShort, the second [1] is timeShortAdd. The timeShortAdd may be 0.
  - getType
```
public char getType()
```
    Description copied from interface: VariableAccess_ifc
    
    Returns the type of the variable:
    
    Specified by:
    
    getType in interface VariableAccess_ifc
    
    Returns:
    
    B, S, I, J, F, D, s for byte, short, integer, long, float, double and string.
  - getInt
```
public int getInt()
```
    Returns the integer representation of the value of the variable. Note: If the variable itself is a byte or 16-bit-type, only 1 or 2 bytes are gotten from the variable respectively the index is regarded to the length of the variable. Note: The bit and mask will be regarded.
    
    Specified by:
    
    getInt in interface VariableAccess_ifc
    
    Returns:
    
    The value
  - getLong
```
public long getLong()
```
    Returns the integer representation of the value of the variable. Note: If the variable itself is a byte or 16-bit-type, only 1 or 2 bytes are gotten from the variable respectively the index is regarded to the length of the variable. Note: The bit and mask will be regarded.
    
    Specified by:
    
    getLong in interface VariableAccess_ifc
    
    Returns:
    
    The value
  - getVariable
```
public VariableAccess_ifc getVariable()
```
  - setFloat
```
public float setFloat(float value)
```
    Sets a float to the variable. See setFloat(float, int...). The index may be stored here.
    
    Specified by:
    
    setFloat in interface VariableAccess_ifc
    
    Parameters:
    
    value -
    
    Returns:
    
    the value.
  - setFloat
```
public void setFloat(float value,
                     int... ix)
```
    Sets a value to the variable which is an array variable.
    
    Parameters:
    
    value -
    
    ix -
  - setString
```
public java.lang.String setString(java.lang.String src)
```
    Description copied from interface: VariableAccess_ifc
    
    Sets the value into the variable
    
    Specified by:
    
    setString in interface VariableAccess_ifc
    
    Parameters:
    
    src - The value given as String.
    
    Returns:
    
    The value really set (maybe shortened).
  - requestValue
```
public void requestValue(long timeRequested)
```
    Description copied from interface: VariableAccess_ifc
    
    Requests a new value from the target device.
    
    Specified by:
    
    requestValue in interface VariableAccess_ifc
    
    Parameters:
    
    timeRequested - the current time, used to mark the request.
  - requestValue
```
public void requestValue()
```
    Description copied from interface: VariableAccess_ifc
    
    Requests a new value from the target device with the System.currentTimeMillis()
    
    Specified by:
    
    requestValue in interface VariableAccess_ifc
  - requestValue
```
public void requestValue(long timeRequested,
                         java.lang.Runnable run)
```
    Description copied from interface: VariableAccess_ifc
    
    Requests a new value from the target device.
    
    Specified by:
    
    requestValue in interface VariableAccess_ifc
    
    Parameters:
    
    timeRequested - the current time
    
    run - method which should be invoked if the request is resolved, optional operation.
  - isRequestedValue
```
public boolean isRequestedValue(long timeEarlyRequested,
                                boolean retryFaultyVariables)
```
    Description copied from interface: VariableAccess_ifc
    
    Returns true if the request is newer than the last refresh.
    
    Specified by:
    
    isRequestedValue in interface VariableAccess_ifc
    
    Parameters:
    
    timeEarlyRequested - The earliest time where the variable is requested. If the request time is more early, it is not regarded. This is since 2016-01. An old request should be ignored but the time stamp of the request should be visible for debug or view the state.
    
    retryFaultyVariables - A variable which is set to invalid is requested though.
    
    Returns:
    
    true if a new value should be gotten from target.
  - isRefreshed
```
public boolean isRefreshed()
```
    Description copied from interface: VariableAccess_ifc
    
    Returns true if the variable was refreshed after it was requested. false if the variable was never requested or it was requested and not refreshed after them.
    
    Specified by:
    
    isRefreshed in interface VariableAccess_ifc
  - setDouble
```
public double setDouble(double value)
```
    Description copied from interface: VariableAccess_ifc
    
    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.
    
    Specified by:
    
    setDouble in interface VariableAccess_ifc
    
    Returns:
    
    the value.
  - setInt
```
public int setInt(int value)
```
    Description copied from interface: VariableAccess_ifc
    
    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.
    
    Specified by:
    
    setInt in interface VariableAccess_ifc
    
    Parameters:
    
    value - The value given as int.
    
    Returns:
    
    The value really set (maybe more imprecise).
  - setLong
```
public long setLong(long value)
```
    Description copied from interface: VariableAccess_ifc
    
    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.
    
    Specified by:
    
    setLong in interface VariableAccess_ifc
    
    Parameters:
    
    value - The value given as int.
    
    Returns:
    
    The value really set (maybe more imprecise).

Class VariableAccessWithIdx

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

variable

ixArray

mask

bit

Constructor Detail

VariableAccessWithIdx

VariableAccessWithIdx

VariableAccessWithIdx

VariableAccessWithIdx

Method Detail

getDouble

getFloat

getString

setRefreshed

getLastRefreshTime

getLastRefreshTimeShort

getType

getInt

getLong

getVariable

setFloat

setFloat

setString

requestValue

requestValue

requestValue

isRequestedValue

isRefreshed

setDouble

setInt

setLong