org.vishia.byteData

Class ByteDataSymbolicAccess.Variable

java.lang.Object

org.vishia.byteData.ByteDataSymbolicAccess.Variable

All Implemented Interfaces:

VariableAccess_ifc, VariableAccessArray_ifc

Enclosing class:

ByteDataSymbolicAccess

public class ByteDataSymbolicAccess.Variable
extends java.lang.Object
implements VariableAccessArray_ifc

An instance can be created and filled from ZBNF-parser using reflection or also programmatically created using . It is a non static class because it is related to the instance of the given ByteDataSymbolicAccess.

Effort for machine code: There may be a lot of variable, 1000 or more. Any variable needs this amount of data space, approximately 50 Byte. 50 kByte is not much for PC programming.
The access operations are contained only one time in byte and then machine code, this is effective.

Field Summary

Fields

Modifier and Type	Field and Description
int	bitMask
ByteDataSymbolicAccess	byteDataAccess
int	bytePos
java.lang.String	name The data path.
java.lang.String	nameShow A simple read-able identifier
int	nrofArrayElements
int	nrofBytes From ZBNF parsing.
private char	typeChar

Fields inherited from interface org.vishia.byteData.VariableAccessArray_ifc

version

Constructor Summary

Constructors

Constructor and Description
Variable() Creates an instance which's fields can be set afterwards, especially while parsing a textual given file.
Variable(ByteDataSymbolicAccess XXXbytes) Deprecated.
Variable(java.lang.String name, java.lang.String nameShow, int bytePos, char typeChar, int nrofArrayElements) Creates an instance which's fields can be set afterwards, especially while parsing a textual given file.

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() Gets the value from this variable.
double	getDouble(int... ixArray) Gets the value from this variable.
float	getFloat() Gets the value from this variable.
float	getFloat(int... ixArray) Gets the value from this variable.
int	getInt() Gets a integer value from this variable.
int	getInt(int... ixArray) Gets a integer value from this variable.
long	getLastRefreshTime() Gets the time stamp when this variable was refreshed lastly.
int[]	getLastRefreshTimeShort() Returns the timeShort of all variable of this sample This operation does not regard any absolute time stamp.
long	getLong() Gets a long value from this variable.
long	getLong(int... ixArray) Gets a long value from this variable.
private int	getNrofBytes()
java.lang.String	getString() Gets the value from this variable.
java.lang.String	getString(int... ixArray) Gets the value from this variable.
char	getType() Returns the type of the variable:
char	getTypeChar()
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.
void	set_typeChar(java.lang.String src)
double	setDouble(double value) Sets the value from this variable.
double	setDouble(double value, int... ixArray) Sets the value from this variable.
float	setFloat(float value) Sets the value from this variable.
float	setFloat(float value, int... ixArray) Sets the value from this variable.
int	setInt(int value) Sets the value into the variable.
int	setInt(int value, int... ixArray) Sets the value into the variable.
long	setLong(long value) Sets the value into the variable.
long	setLong(long value, int... ixArray) Sets the value into the variable.
void	setProps(java.lang.String name, java.lang.String nameShow, int bytePos, char typeChar, int nrofArrayElements) Defines which type of variable are found on which position.
void	setRefreshed(long time)
java.lang.String	setString(java.lang.String value) Sets the value into the variable
java.lang.String	setString(java.lang.String value, int... ixArray) Sets the value into the variable
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

byteDataAccess

public final ByteDataSymbolicAccess byteDataAccess

name

public java.lang.String name

The data path.

nameShow

public java.lang.String nameShow

A simple read-able identifier

typeChar

private char typeChar

bytePos

public int bytePos

bitMask

public int bitMask

nrofBytes

public int nrofBytes

From ZBNF parsing.

nrofArrayElements

public int nrofArrayElements

Constructor Detail

Variable

public Variable()

Creates an instance which's fields can be set afterwards, especially while parsing a textual given file.

Variable

public Variable(java.lang.String name,
                java.lang.String nameShow,
                int bytePos,
                char typeChar,
                int nrofArrayElements)

Creates an instance which's fields can be set afterwards, especially while parsing a textual given file.

Variable

@Deprecated
public Variable(ByteDataSymbolicAccess XXXbytes)

Deprecated.

Method Detail

getTypeChar

public char getTypeChar()

set_typeChar

public void set_typeChar(java.lang.String src)

setProps

public void setProps(java.lang.String name,
                     java.lang.String nameShow,
                     int bytePos,
                     char typeChar,
                     int nrofArrayElements)

Defines which type of variable are found on which position. The elements of a variable are not final because there are also set as ZBNF parse result. But usual a variable is used as final (not reused for several approaches on different positions).

Parameters:

name - Name for internal administration, unique

nameShow - name to show

bytePos - position in the datagram / byte array.

typeChar - see typeChar, Z B S I L F D for boolean, byte, short, int, long, float, double Note: for boolean values not on bit 0 a bitMask should be set.

nrofArrayElements - 0 for scalar, >0 an array more values one after another

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.

getDimension

public int getDimension(int dimension)

Description copied from interface: VariableAccessArray_ifc

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

Specified by:

getDimension in interface VariableAccessArray_ifc

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.

getInt

public int getInt(int... ixArray)

Description copied from interface: VariableAccessArray_ifc

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.

Specified by:

getInt in interface VariableAccessArray_ifc

Parameters:

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

Returns:

the value.

setInt

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

Description copied from interface: VariableAccessArray_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 VariableAccessArray_ifc

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

public long getLong(int... ixArray)

Description copied from interface: VariableAccessArray_ifc

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.

Specified by:

getLong in interface VariableAccessArray_ifc

Parameters:

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

Returns:

the value.

setLong

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

Description copied from interface: VariableAccessArray_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 VariableAccessArray_ifc

Parameters:

value - The value given as int.

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

Returns:

The value really set (maybe more imprecise).

getString

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

Description copied from interface: VariableAccessArray_ifc

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

Specified by:

getString in interface VariableAccessArray_ifc

Parameters:

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

Returns:

the value.

setString

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

Description copied from interface: VariableAccessArray_ifc

Sets the value into the variable

Specified by:

setString in interface VariableAccessArray_ifc

Parameters:

value - The value given as String.

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

Returns:

The value really set (maybe shortened).

getFloat

public float getFloat(int... ixArray)

Description copied from interface: VariableAccessArray_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 VariableAccessArray_ifc

Parameters:

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

Returns:

the value.

setFloat

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

Description copied from interface: VariableAccessArray_ifc

Sets the value from this variable.

Specified by:

setFloat in interface VariableAccessArray_ifc

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

Returns:

the value.

getDouble

public double getDouble(int... ixArray)

Description copied from interface: VariableAccessArray_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 VariableAccessArray_ifc

Parameters:

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

Returns:

the value.

setDouble

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

Description copied from interface: VariableAccessArray_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 VariableAccessArray_ifc

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

Returns:

the value.

getNrofBytes

private int getNrofBytes()

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

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()

Returns the timeShort of all variable of this sample This operation does not regard any absolute time stamp. An absolute time stamp can be organized outside. See for example org.vishia.gral.base.GralCurveView, there either the system time is used as absolute time, but also the controller can store an absolute time. The absolute time should be associated at point{0,0} of this timestamp. See concept in Timeshort.

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.

setRefreshed

public void setRefreshed(long time)

Specified by:

setRefreshed in interface VariableAccess_ifc

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.

getInt

public int getInt()

Description copied from interface: VariableAccess_ifc

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.

Specified by:

getInt in interface VariableAccess_ifc

Returns:

the value.

getLong

public long getLong()

Description copied from interface: VariableAccess_ifc

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.

Specified by:

getLong 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.

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.

setFloat

public float setFloat(float value)

Description copied from interface: VariableAccess_ifc

Sets the value from this variable.

Specified by:

setFloat 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).

setString

public java.lang.String setString(java.lang.String value)

Description copied from interface: VariableAccess_ifc

Sets the value into the variable

Specified by:

setString in interface VariableAccess_ifc

Parameters:

value - The value given as String.

Returns:

The value really set (maybe shortened).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object