ByteDataSymbolicAccess

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

All Implemented Interfaces:

VariableContainer_ifc
```
public class ByteDataSymbolicAccess
extends java.lang.Object
implements VariableContainer_ifc
```
This class supports the access to binary data with some variable which describes parts of data. The ByteDataSymbolicAccess.Variable contains a name, a data path (full name), the type and the position of the bytes for the variable in the whole raw byte area. The class ByteDataSymbolicAccessReadConfig contained in the javaSrc_Zbnf component extends this class with a routine, which reads the information for all variable from a script file. Therewith the ZBNF-Parser org.vishia.zbnf is used. The variable may be given with Java-written instantiation too. The data are given calling #assignData(byte[]), #assignData(byte[], int, int) from any source. New data can be updated outside, for example by a communication via network receive, and update in the data buffer by calling copyNewData(byte[], int, int, long). Thereby a timestamp of updating is provided. It supports the method VariableAccess_ifc.getLastRefreshTime().

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`ByteDataSymbolicAccess.Variable` An instance can be created and filled from ZBNF-parser using reflection or also programmatically created using .

Field Summary

Fields
Modifier and Type	Field and Description
`private byte[]`	`data`
`ByteDataAccessSimple`	`dataAccess` The basically access to data.
`private java.util.Map<java.lang.String,VariableAccess_ifc>`	`indexVariable` The access to variables, index of variables used internally.
`private int`	`ixStartData`
`private int`	`nrofData`
`private ConcurrentLinkedQueue<java.lang.Runnable>`	`runOnRecv`
`protected long`	`timeRequestNewValue`
`protected long`	`timeSetNewValue` The last refresh time.
`protected int[]`	`timeShortRefresh` The time of last refresh of the data set. see `VariableAccess_ifc.getLastRefreshTimeShort()`.
`static int`	`versionStamp` Version, history and license.

Fields inherited from interface org.vishia.byteData.VariableContainer_ifc
version

Constructor Summary

Constructors
Constructor and Description
`ByteDataSymbolicAccess()` Creates with its own internal (not visible) `ByteDataAccessSimple` access operations.
`ByteDataSymbolicAccess(ByteDataAccessSimple dataAccess)` Works with a given ByteDataAccess which can be additional touched with the `ByteDataAccessBase` or `ByteDataAccessSimple` operations.
`ByteDataSymbolicAccess(java.util.Map<java.lang.String,VariableAccess_ifc> idxVariables)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addVariable(java.lang.String name, ByteDataSymbolicAccess.Variable variable)`
`void`	`assignData(byte[] dataP, int length, int from, long time)` Assigns new data which are filled with byte before, often from a received socket telegram
`void`	`assignData(byte[] dataP, long time)`
`void`	`copyNewData(byte[] src, int srcpos, int srclen, long time)` Replace the data bytes in the buffer.
`VariableAccess_ifc`	`getVariable(java.lang.String name)` Searches a variable by name and returns it.
`VariableAccess_ifc`	`getVariableAssert(java.lang.String name)` Searches a variable by name and returns it.
`long`	`isRequestedNewData()` Returns the time stamp (seconds after 1970) of the last call of `VariableAccess_ifc.requestValue(long)` for any variable of this container.
`int`	`lengthData()`
`static java.lang.String`	`separateIndex(java.lang.String sPathValue, int[] ix)` Separates an string-given index from a path.
`void`	`setCallbackOnReceivedData(java.lang.Runnable callback)` see `VariableContainer_ifc.setCallbackOnReceivedData(Runnable)` It is not implemented here.
`void`	`setTimeShort(int timeShort, int timeShortAdd)` Sets the timestamp not as absolute but as relative time for this sample.

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

- Field Detail
  - versionStamp
```
public static final int versionStamp
```
    Version, history and license. The version number is a date written as yyyymmdd as decimal number.
    - 2022-10-26 Hartmut The indexVariable is now not only private, it can be shared with a global index using the ctor ByteDataSymbolicAccess(Map) as done in org.vishia.guiViewCfg.OamShowValues. In conclusion the members cannot have the specialized type ByteDataSymbolicAccess.Variable, instead the abstract common type VariableAccess_ifc.
      Some operations here are commented yet because not used, should be refactored with this change. The problem is, using the interface instead the specialized type. For array access the variables should implement the VariableAccessArray_ifc, and that should be test. If an array access is done (index found in string), then the downcasting should be done. It should be able to do, elsewhere the index access cannot be done. This is partially refactored for the necessary operations.
    - 2022-09-28 Hartmut new: setTimeShort(int, int) and ByteDataSymbolicAccess.Variable.getLastRefreshTimeShort() as support for data from a controller which has a relative timeShort.
    - 2013-11-26 Hartmut new: copyNewData(byte[], int, int, long)
    - 2013-11-26 Hartmut chg assignData(byte[], long) with timestamp required. Usages should updated. A timestamp is a substantial propertiy of dynamic data. Use System.currentTimeMillis().
    - 2012-09-24 Hartmut new ByteDataSymbolicAccess.Variable.getLong(int...) and ByteDataSymbolicAccess.Variable.setLong(long, int...)
    - 2012-04-22 Hartmut minor change: ByteDataSymbolicAccess.Variable.nrofBytes is necessary for ZBNF parse result. But it isn't used yet.
    - 2012-04-01 Hartmut new: Because enhanced VariableAccess_ifc new ByteDataSymbolicAccess.Variable.getType() and ByteDataSymbolicAccess.Variable.getDimension(int).
    - 2012-03-02 Hartmut chg: Dissolving the readConfig because it needs the ZBNF parser which isn't part of this component up to now. It may be seen as additional functionality. Base functionality is gotten without the more complex parser.
    - 2010-12-03 Hartmut fnChg: The syntax is defined internally, see #syntaxSymbolicDescrFile.
    - new: new functionality, downward compatibility.
    - fnChg: Change of functionality, no changing of formal syntax, it may be influencing the functions of user, but mostly in a positive kind.
    - chg: Change of functionality, it should be checked syntactically, re-compilation necessary.
    - adap: No changing of own functionality, but adapted to a used changed module.
    - corr: correction of a bug, it should be a good thing.
    - bug123: correction of a tracked bug.
    - nice: Only a nice correction, without changing of functionality, without changing of syntax.
    - descr: Change of description of elements.
    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
  - indexVariable
```
private final java.util.Map<java.lang.String,VariableAccess_ifc> indexVariable
```
    The access to variables, index of variables used internally. This reference can be set to a common reference, see #setIdx...
  - data
```
private byte[] data
```
  - ixStartData
```
private int ixStartData
```
  - nrofData
```
private int nrofData
```
  - timeRequestNewValue
```
protected long timeRequestNewValue
```
  - timeShortRefresh
```
protected int[] timeShortRefresh
```
    The time of last refresh of the data set. see VariableAccess_ifc.getLastRefreshTimeShort().
  - runOnRecv
```
private final ConcurrentLinkedQueue<java.lang.Runnable> runOnRecv
```
  - timeSetNewValue
```
protected long timeSetNewValue
```
    The last refresh time.
  - dataAccess
```
public final ByteDataAccessSimple dataAccess
```
    The basically access to data. Hint: It is public to use for experience. Normally it should not be used from external.
- Constructor Detail
  - ByteDataSymbolicAccess
```
public ByteDataSymbolicAccess()
```
    Creates with its own internal (not visible) ByteDataAccessSimple access operations.
  - ByteDataSymbolicAccess
```
public ByteDataSymbolicAccess(java.util.Map<java.lang.String,VariableAccess_ifc> idxVariables)
```
  - ByteDataSymbolicAccess
```
public ByteDataSymbolicAccess(ByteDataAccessSimple dataAccess)
```
    Works with a given ByteDataAccess which can be additional touched with the ByteDataAccessBase or ByteDataAccessSimple operations. with that concept only a part of the whole data may be used for the symbolic access.
    
    Parameters:
    
    dataAccess -
- Method Detail
  - addVariable
```
public final void addVariable(java.lang.String name,
                              ByteDataSymbolicAccess.Variable variable)
```
  - assignData
```
public void assignData(byte[] dataP,
                       long time)
```
  - assignData
```
public void assignData(byte[] dataP,
                       int length,
                       int from,
                       long time)
```
    Assigns new data which are filled with byte before, often from a received socket telegram
    
    Parameters:
    
    dataP -
    
    length - valid number of bytes, the length + from should not exceed the dataP length.
    
    from - byte position where the data for the internal variables starts. This is usual start of the payload, or after them
    
    time - The timestamp of the received data helpfull for some time relation operations.
  - copyNewData
```
public void copyNewData(byte[] src,
                        int srcpos,
                        int srclen,
                        long time)
```
    Replace the data bytes in the buffer.
    
    Parameters:
    
    src - source
    
    srcpos - maybe any position in the source buffer
    
    srclen - number of bytes in source buffer. It should be the same like number of bytes in this.data, but it may be lesser or more. Lesser: Only a part of data are replaces.
    
    time - timestamp of receive.
  - setTimeShort
```
public void setTimeShort(int timeShort,
                         int timeShortAdd)
```
    Sets the timestamp not as absolute but as relative time for this sample. Concept see Timeshort. 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.
    
    Parameters:
    
    timeShort - The internal currently relative time, maybe wrapping. Set to 0 to mark, not used.
    
    timeShortAdd - An additional part to adjust with a given absolute time.
  - lengthData
```
public int lengthData()
```
  - isRequestedNewData
```
public long isRequestedNewData()
```
    Returns the time stamp (seconds after 1970) of the last call of VariableAccess_ifc.requestValue(long) for any variable of this container.
    
    Returns:
    
    0 if no request is called after the last call of #assignData(byte[]) or #assignData(byte[], int, int).
  - getVariable
```
public VariableAccess_ifc getVariable(java.lang.String name)
```
    Searches a variable by name and returns it. A variable is a description of the byte position. length, type in a byte[]-Array. see VariableContainer_ifc.getVariable(String)
    
    Specified by:
    
    getVariable in interface VariableContainer_ifc
    
    Parameters:
    
    name - The name
    
    Returns:
    
    null if not found.
  - getVariableAssert
```
public VariableAccess_ifc getVariableAssert(java.lang.String name)
                                     throws java.lang.NoSuchFieldException
```
    Searches a variable by name and returns it. A variable is a description of the byte position. length, type in a byte[]-Array.
    
    Parameters:
    
    name - The name
    
    Returns:
    
    null if not found.
    
    Throws:
    
    java.lang.NoSuchFieldException
  - separateIndex
```
public static java.lang.String separateIndex(java.lang.String sPathValue,
                                             int[] ix)
```
    Separates an string-given index from a path. The index may contain in the sPathValue at end in form "[index]", where index is numerical, maybe hexa starting with "0x"
    
    Parameters:
    
    sPathValue - The path, it can contain "[ix]" on its wnd where ix is the numerical index.
    
    ix - An array with the necessary number of element to store the index. It may be null or shorter then the number of indices. Then the indeces are not stored.
    
    Returns:
    
    The sPathValue without the index. If sPathValue does not contain an index it is == sPathValue.
  - setCallbackOnReceivedData
```
public void setCallbackOnReceivedData(java.lang.Runnable callback)
```
    see VariableContainer_ifc.setCallbackOnReceivedData(Runnable) It is not implemented here.
    
    Specified by:
    
    setCallbackOnReceivedData in interface VariableContainer_ifc

Class ByteDataSymbolicAccess

Nested Class Summary

Field Summary

Fields inherited from interface org.vishia.byteData.VariableContainer_ifc

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

versionStamp

indexVariable

data

ixStartData

nrofData

timeRequestNewValue

timeShortRefresh

runOnRecv

timeSetNewValue

dataAccess

Constructor Detail

ByteDataSymbolicAccess

ByteDataSymbolicAccess

ByteDataSymbolicAccess

Method Detail

addVariable

assignData

assignData

copyNewData

setTimeShort

lengthData

isRequestedNewData

getVariable

getVariableAssert

separateIndex

setCallbackOnReceivedData