InspcVariable

java.lang.Object
- org.vishia.inspcPC.mng.InspcVariable

```
public class InspcVariable
extends java.lang.Object
```
This class presents a variable, which is accessed by a InspcTargetAccessor. It mirrors a variable in the target.

Get a variable:
Use the VariableContainer_ifc#getVariable(String) which is provided with the InspcMng to access an already existing variable or create a new one mirror for a variable. The String parameter should be the access path to the target. The access path can start with
alias:...path...:
The alias will be translated using the given InspcMng#complete_ReplaceAlias_ifc(org.vishia.util.ReplaceAlias_ifc).

After replacing the alias or without alias the path should start with
target:...path...
The target identifier should be one of the names given by construction of the InspcMng.InspcMng(String, java.util.Map, int, boolean, org.vishia.inspcPC.InspcPlugUser_ifc).

Access a variable:
- One can invoke requestValue() or requestValue(long, Runnable) to request the communication with the target. This is done for example for graphical representation in org.vishia.gral.base.GralWidget#requestNewValueForVariable(long)
- The InspcMng.procComm() routine checks all variables via #isRequestedValue(boolean). That call sets an internal flag isRequested to prevent more as one request to the target. It sends the request to the target in the routine requestValueFromTarget(long, boolean) either via InspcTargetAccessor.cmdGetValueByPath(String, InspcAccessExecRxOrder_ifc) or InspcTargetAccessor.cmdGetValueByHandle(int, InspcAccessExecRxOrder_ifc) with more variable in one datagram and all requests in up to 10 datagrams.
- The target may answer (if connected) and invoke the callback routine of the request. This is done in the same thread as the request on start of InspcMng.procComm(). The answer was expected in another thread (communication thread) but the answer datagrams are stored in the InspcTargetAccessor.TelgData instance to evaluate in the procComm. The answer sets the timeRefreshed.
- It is possible to check whether the variable is updated by invocation of getLastRefreshTime(). With them it is possible to set fields to show the value to gray if the variable was not refreshed a longer time.
- The invocation of getFloat() etc. returns the stored value independently whether it was refreshed or not.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`InspcVariable.ActionRxByHandle` This class supplies the method to set the variable value from a received info block.
`(package private) static class`	`InspcVariable.ModeHandleVariable`
`(package private) class`	`InspcVariable.VariableRxAction` This class supplies the method to set the variable value from a received info block.

Field Summary

Fields
Modifier and Type	Field and Description
`private InspcVariable.ActionRxByHandle`	`actionRxByHandle`
`(package private) char`	`cType` The type depends from the type in the target device.
`InspcTargetAccessData`	`ds`
`(package private) int`	`handleTarget` If >=0 then it is the handle of the variable in the target device.
`(package private) boolean`	`isRequested` If true this variable is requested already by the `InspcMng`.
`private InspcStruct`	`itsStruct` It is is a structure, it maybe not null if it is requested.
`protected static int`	`kIdTargetDisabled` Special designations as value of `#idTarget`
`protected static int`	`kIdTargetUndefined` Special designations as value of `#idTarget`
`protected static int`	`kIdTargetUsePerPath` Special designations as value of `#idTarget`
`(package private) InspcVariable.ModeHandleVariable`	`modeTarget`
`InspcVariable`	`parent` The structure were this variable is member of.
`private <any>`	`runOnRecv`
`(package private) InspcVariable.VariableRxAction`	`rxAction`
`(package private) java.lang.String`	`sValueToTarget` The value of the variable was set from `VariableAccess_ifc`.
`(package private) long`	`timeRefreshed`
`(package private) long`	`timeRequested` Timestamp in milliseconds after 1970 when the variable was requested.
`(package private) short`	`typeTarget` The type information which is returned from the target by registerHandle.
`(package private) float`	`valueF` The value from the target device.
`(package private) int`	`valueI` The value from the target device.
`(package private) java.lang.String`	`valueS` The value from the target device.
`(package private) InspcMng`	`varMng`
`static int`	`version` Version, history and license.

Constructor Summary

Constructors
Constructor and Description

InspcVariable(InspcMng mng, InspcVariable parent, InspcTargetAccessData data)
Creates a variable.

Constructors
Constructor and Description
`InspcVariable(InspcMng mng, InspcVariable parent, InspcTargetAccessData data)` Creates a variable.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getDimension(int dimension)`
`double`	`getDouble()`
`double`	`getDouble(int... ixArray)`
`float`	`getFloat()`
`float`	`getFloat(int... ixArray)`
`int`	`getInt()`
`int`	`getInt(int... ixArray)`
`long`	`getLastRefreshTime()`
`long`	`getLong()`
`long`	`getLong(int... ixArray)`
`InspcStruct`	`getOrCreateStructForNonLeafVariables()` Creates an `InspcStruct` if it is not created till now, returns it.
`java.lang.String`	`getString()`
`java.lang.String`	`getString(int... ixArray)`
`InspcStruct`	`getStruct()` Gets the struct for a node (non leafe variable).
`char`	`getType()`
`boolean`	`isRefreshed()`
`boolean`	`isRequestedValue(long timeEarlyRequested, boolean retryFaultyVariables)`
`void`	`requestValue()` Request with the current time.
`void`	`requestValue(long time)`
`void`	`requestValue(long time, java.lang.Runnable run)`
`(package private) boolean`	`requestValueFromTarget(long timeCurrent, boolean retryDisabledVariable)` Notes the request for this variable in the request telegram to the target.
`double`	`setDouble(double value)`
`double`	`setDouble(double value, int... ixArray)`
`float`	`setFloat(float value)`
`float`	`setFloat(float value, int... ixArray)`
`int`	`setInt(int value)`
`int`	`setInt(int value, int... ixArray)`
`long`	`setLong(long value)`
`long`	`setLong(long value, int... ixArray)`
`void`	`setRefreshed(long time)`
`java.lang.String`	`setString(java.lang.String value)`
`java.lang.String`	`setString(java.lang.String value, int... ixArray)`
`private void`	`setValueFormAnswerTelgByHandle(InspcDataExchangeAccess.Inspcitem accAnswerItem, long time)`
`java.lang.String`	`toString()`

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

- Field Detail
  - version
```
public static final int version
```
    Version, history and license.
    - 2013-12-07 Hartmut new: Bit isRequested to prevent request twice, in experience.
    - 2013-12-07 Hartmut new: sValueToTarget is set on setString(String). Then the new content is sent to target to change it there. It is done in the requestValueFromTarget(long, boolean) because this routine is called if the field is shown. Only if it is shown the change can be done.
    - 2013-12-07 Hartmut new: itsStruct
    - 2013-12-07 Hartmut chg: In InspcVariable.VariableRxAction: Answer from target with info.cmd = InspcDataExchangeAccess.Inspcitem#kFailedPath disables this variable from data communication. TODO enable with user action if the target was changed (recompiled, restarted etc).
    - 2013-12-07 Hartmut chg: In InspcVariable.VariableRxAction: Answer from target with variable type designation = InspcDataExchangeAccess.kInvalidHandle The requester should remove that index. Then a new InspcTargetAccessor.cmdRegisterHandle(String, InspcAccessExecRxOrder_ifc) is forced to get a valid index.
    - 2013-12-07 Hartmut chg: #requestValueFromTarget(long): If the path starts with '#', it is not requested.
    - 2013-01-10 Hartmut bugfix: If a variable can't be requested in #requestValueFromTarget(long) because the telegram is full, the same variable should be requested repeatedly in the next telegram. It was forgotten.
    - 2012-09-24 Hartmut new getLong(int...) and setLong(long, int...) not implemented, only formal
    - 2012-04-22 Hartmut adapt: requestValue(long) etc. from VariableAccess_ifc.
    - 2012-04-17 Hartmut new: Access via getValuePerPath for downward compatibility with target device.
    - 2012-04-08 Hartmut new: Support of GetValueByIdent
    - 2012-03-31 Hartmut created. See InspcMng.version.
    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 is 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
  - varMng
```
final InspcMng varMng
```
  - actionRxByHandle
```
private final InspcVariable.ActionRxByHandle actionRxByHandle
```
  - parent
```
public final InspcVariable parent
```
    The structure were this variable is member of. Not null if this is not the root variable in a device.
  - rxAction
```
final InspcVariable.VariableRxAction rxAction
```
  - ds
```
public final InspcTargetAccessData ds
```
  - itsStruct
```
private InspcStruct itsStruct
```
    It is is a structure, it maybe not null if it is requested. null for a leaf variable, null if the structure was not requested till now. See getOrCreateStructForNonLeafVariables(). It creates.
  - kIdTargetUndefined
```
protected static final int kIdTargetUndefined
```
    Special designations as value of #idTarget
    
    See Also:
    
    Constant Field Values
  - kIdTargetDisabled
```
protected static final int kIdTargetDisabled
```
    Special designations as value of #idTarget
    
    See Also:
    
    Constant Field Values
  - kIdTargetUsePerPath
```
protected static final int kIdTargetUsePerPath
```
    Special designations as value of #idTarget
    
    See Also:
    
    Constant Field Values
  - modeTarget
```
InspcVariable.ModeHandleVariable modeTarget
```
  - handleTarget
```
int handleTarget
```
    If >=0 then it is the handle of the variable in the target device. if <0 then see kIdTargetDisabled etc. The the value can be gotten calling getValueByHandle().
  - typeTarget
```
short typeTarget
```
    The type information which is returned from the target by registerHandle.
  - timeRequested
```
long timeRequested
```
    Timestamp in milliseconds after 1970 when the variable was requested. A value may be gotten only if a new request is pending.
  - isRequested
```
boolean isRequested
```
    If true this variable is requested already by the InspcMng. The answer should be awaited.
  - timeRefreshed
```
long timeRefreshed
```
  - runOnRecv
```
private final <any> runOnRecv
```
  - valueF
```
float valueF
```
    The value from the target device.
  - valueI
```
int valueI
```
    The value from the target device.
  - valueS
```
java.lang.String valueS
```
    The value from the target device.
  - cType
```
char cType
```
    The type depends from the type in the target device. It is set if any answer is gotten. 'c' for character array.
  - sValueToTarget
```
java.lang.String sValueToTarget
```
    The value of the variable was set from VariableAccess_ifc. It means it should be sent to target.
- Constructor Detail
  - InspcVariable
```
InspcVariable(InspcMng mng,
              InspcVariable parent,
              InspcTargetAccessData data)
```
    Creates a variable. A variable is an entity, which will be gotten with one access to the target device. It may be a String or a short static array too.
    
    Parameters:
    
    mng -
    
    sPathInTarget - The access path.
- Method Detail
  - requestValueFromTarget
```
boolean requestValueFromTarget(long timeCurrent,
                               boolean retryDisabledVariable)
```
    Notes the request for this variable in the request telegram to the target.
    
    Parameters:
    
    retryDisabledVariable - true then retry a disabled variable, see kIdTargetDisabled
    
    Returns:
    
    order if the datagram item is set. 0 if the datagram is full. -1 if there is nothing to send.
  - getDouble
```
public double getDouble()
```
  - getFloat
```
public float getFloat()
```
  - getInt
```
public int getInt()
```
  - getLong
```
public long getLong()
```
  - getString
```
public java.lang.String getString()
```
  - setDouble
```
public double setDouble(double value)
```
  - setFloat
```
public float setFloat(float value)
```
  - setInt
```
public int setInt(int value)
```
  - setLong
```
public long setLong(long value)
```
  - setString
```
public java.lang.String setString(java.lang.String value)
```
  - getType
```
public char getType()
```
  - getOrCreateStructForNonLeafVariables
```
public InspcStruct getOrCreateStructForNonLeafVariables()
```
    Creates an InspcStruct if it is not created till now, returns it. This method should only be called for variable which are not leaf variables in the target device. If it is created for a leaf variable, the filling of the struct fails so that the structure has no fields.
    
    Returns:
    
    Instance for the structure information of this variable.
  - getStruct
```
public InspcStruct getStruct()
```
    Gets the struct for a node (non leafe variable). If it is a leaf variable, this method returns null because the struct is only given for a node in the tree. It is possible that this method returns null on a non-leaf variable, if the struct is not defined till now. If it is guaranteed that this is a non-leaf-variable, invoke getOrCreateStructForNonLeafVariables().
    
    Returns:
    
    null on a leaf-variable, the defined struct (maybe null) for a non-leaf variable.
  - setRefreshed
```
public void setRefreshed(long time)
```
  - getLastRefreshTime
```
public long getLastRefreshTime()
```
  - requestValue
```
public void requestValue()
```
    Request with the current time. This is more simple for usage in JZcmd.
  - requestValue
```
public void requestValue(long time)
```
  - requestValue
```
public void requestValue(long time,
                         java.lang.Runnable run)
```
  - isRequestedValue
```
public boolean isRequestedValue(long timeEarlyRequested,
                                boolean retryFaultyVariables)
```
  - isRefreshed
```
public boolean isRefreshed()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getInt
```
public int getInt(int... ixArray)
```
  - setInt
```
public int setInt(int value,
                  int... ixArray)
```
  - getLong
```
public long getLong(int... ixArray)
```
  - setLong
```
public long setLong(long value,
                    int... ixArray)
```
  - getFloat
```
public float getFloat(int... ixArray)
```
  - setFloat
```
public float setFloat(float value,
                      int... ixArray)
```
  - getDouble
```
public double getDouble(int... ixArray)
```
  - setDouble
```
public double setDouble(double value,
                        int... ixArray)
```
  - getString
```
public java.lang.String getString(int... ixArray)
```
  - setString
```
public java.lang.String setString(java.lang.String value,
                                  int... ixArray)
```
  - getDimension
```
public int getDimension(int dimension)
```
  - setValueFormAnswerTelgByHandle
```
private void setValueFormAnswerTelgByHandle(InspcDataExchangeAccess.Inspcitem accAnswerItem,
                                            long time)
```

Class InspcVariable

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

varMng

actionRxByHandle

parent

rxAction

ds

itsStruct

kIdTargetUndefined

kIdTargetDisabled

kIdTargetUsePerPath

modeTarget

handleTarget

typeTarget

timeRequested

isRequested

timeRefreshed

runOnRecv

valueF

valueI

valueS

cType

sValueToTarget

Constructor Detail

InspcVariable

Method Detail

requestValueFromTarget

getDouble

getFloat

getInt

getLong

getString

setDouble

setFloat

setInt

setLong

setString

getType

getOrCreateStructForNonLeafVariables

getStruct

setRefreshed

getLastRefreshTime

requestValue

requestValue

requestValue

isRequestedValue

isRefreshed

toString

getInt

setInt

getLong

setLong

getFloat

setFloat

getDouble

setDouble

getString

setString

getDimension

setValueFormAnswerTelgByHandle