org.vishia.inspcPC

Interface InspcAccess_ifc

All Known Implementing Classes:

InspcCmdStore, InspcMng, InspcTargetAccessor

public interface InspcAccess_ifc

This is the interface to use the Inspector to access any target. This interface is used both from the central org.vishia.inspcPc.mng.InspcMng to access all known targets and for the org.vishia.inspcPc.accTarget.InspcTargetAccessor to access a specific target.

Field Summary

Fields

Modifier and Type	Field and Description
static int	idLogFailedSeq Some adding values for the message number for the log system.
static int	idLogGetAddress Some adding values for the message number for the log system.
static int	idLogGetFields Some adding values for the message number for the log system.
static int	idLogGetOther Some adding values for the message number for the log system.
static int	idLogGetValueByIdent Some adding values for the message number for the log system.
static int	idLogGetValueByPath Some adding values for the message number for the log system.
static int	idLogRcvGetAddress Some adding values for the message number for the log system.
static int	idLogRcvGetFields Some adding values for the message number for the log system.
static int	idLogRcvGetOther Some adding values for the message number for the log system.
static int	idLogRcvGetValueByIdent Some adding values for the message number for the log system.
static int	idLogRcvGetValueByPath Some adding values for the message number for the log system.
static int	idLogRcvRegisterByPath Some adding values for the message number for the log system.
static int	idLogRcvSetValueByPath Some adding values for the message number for the log system.
static int	idLogRegisterByPath Some adding values for the message number for the log system.
static int	idLogRx Some adding values for the message number for the log system.
static int	idLogRxError Some adding values for the message number for the log system.
static int	idLogRxItem Some adding values for the message number for the log system.
static int	idLogRxLast Some adding values for the message number for the log system.
static int	idLogRxNotlast Some adding values for the message number for the log system.
static int	idLogRxRepeat Some adding values for the message number for the log system.
static int	idLogSetValueByPath Some adding values for the message number for the log system.
static int	idLogTx Some adding values for the message number for the log system.
static java.lang.String	sVersion Version, history and license.

Method Summary

Modifier and Type	Method and Description
void	addUserTxOrder(java.lang.Runnable order) Adds any program snippet which is executed while preparing the telegram for data request from target.
boolean	cmdGetAddressByPath(java.lang.String sPath, InspcAccessExecRxOrder_ifc actionOnRx) Adds the info block to send 'get value by path'
int	cmdGetFields(java.lang.String sDataPath, InspcAccessExecRxOrder_ifc actionOnRx)
boolean	cmdGetValueByHandle(int ident, InspcAccessExecRxOrder_ifc actionOnRx) Adds the info block to send 'register by path'
int	cmdGetValueByPath(java.lang.String sDataPath, InspcAccessExecRxOrder_ifc actionOnRx) Adds the info block to send 'get value by path'
int	cmdRegisterHandle(java.lang.String sDataPath, InspcAccessExecRxOrder_ifc actionOnRx) Adds the info block to send 'register by path'
void	cmdSetDoubleByPath(java.lang.String sDataPath, double value, InspcAccessExecRxOrder_ifc actionOnRx) Adds the info block to send 'get value by path'
void	cmdSetFloatByPath(java.lang.String sDataPath, float value, InspcAccessExecRxOrder_ifc actionOnRx) Adds the info block to send 'get value by path'
void	cmdSetInt32ByPath(java.lang.String sDataPath, int value, InspcAccessExecRxOrder_ifc actionOnRx) Adds the info block to send 'get value by path'
void	cmdSetStringByPath(VariableAccessArray_ifc var, java.lang.String value) Adds the info block to send 'set value by path'
void	cmdSetValueByPath(java.lang.String sDataPath, long value, int typeofValue, InspcAccessExecRxOrder_ifc actionOnRx) Adds the info block to send 'get value by path'
InspcTargetAccessData	getTargetAccessFromPath(java.lang.String sDataPath, boolean strict) Splits a given full data path with device:datapath maybe with alias:datapath in the device, path, name and returns a struct.
boolean	isOrSetReady(long timeCurrent) Checks readiness of communication cycle.
void	requestFields(InspcTargetAccessData data, InspcAccessExecRxOrder_ifc rxActionGetFields, java.lang.Runnable runOnReceive) Set the request for all fields of the given variable.

Field Detail

sVersion

static final java.lang.String sVersion

Version, history and license.

• 2014-04-24 Hartmut Methods should all return boolean for success or not, for different reasons. It is fatal if a command was not sent and it is not known. Implemented only on cmdGetAddressByPath(String, InspcAccessExecRxOrder_ifc) yet.
• 2014-04-24 Hartmut created: Methods from InspcTargetAccessor

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

idLogGetValueByPath

static final int idLogGetValueByPath

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogGetValueByIdent

static final int idLogGetValueByIdent

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogGetAddress

static final int idLogGetAddress

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogGetFields

static final int idLogGetFields

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRegisterByPath

static final int idLogRegisterByPath

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogSetValueByPath

static final int idLogSetValueByPath

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogGetOther

static final int idLogGetOther

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogTx

static final int idLogTx

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRx

static final int idLogRx

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRxLast

static final int idLogRxLast

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRxNotlast

static final int idLogRxNotlast

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRxItem

static final int idLogRxItem

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogFailedSeq

static final int idLogFailedSeq

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRxRepeat

static final int idLogRxRepeat

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRxError

static final int idLogRxError

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRcvGetValueByPath

static final int idLogRcvGetValueByPath

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRcvGetValueByIdent

static final int idLogRcvGetValueByIdent

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRcvGetAddress

static final int idLogRcvGetAddress

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRcvGetFields

static final int idLogRcvGetFields

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRcvRegisterByPath

static final int idLogRcvRegisterByPath

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRcvSetValueByPath

static final int idLogRcvSetValueByPath

Some adding values for the message number for the log system.

See Also:

Constant Field Values

idLogRcvGetOther

static final int idLogRcvGetOther

Some adding values for the message number for the log system.

See Also:

Constant Field Values

Method Detail

cmdGetFields

int cmdGetFields(java.lang.String sDataPath,
                 InspcAccessExecRxOrder_ifc actionOnRx)

cmdGetValueByPath

int cmdGetValueByPath(java.lang.String sDataPath,
                      InspcAccessExecRxOrder_ifc actionOnRx)

Adds the info block to send 'get value by path'

Parameters:

sDataPath -

Returns:

The order number. 0 if the cmd can't be created.

cmdRegisterHandle

int cmdRegisterHandle(java.lang.String sDataPath,
                      InspcAccessExecRxOrder_ifc actionOnRx)

Adds the info block to send 'register by path'

Parameters:

sDataPath -

Returns:

The order number. 0 if the cmd can't be created because the telegram is full.

cmdGetValueByHandle

boolean cmdGetValueByHandle(int ident,
                            InspcAccessExecRxOrder_ifc actionOnRx)

Adds the info block to send 'register by path'

Parameters:

sDataPath -

Returns:

The order number. 0 if the cmd can't be created because the telegram is full.

cmdSetValueByPath

void cmdSetValueByPath(java.lang.String sDataPath,
                       long value,
                       int typeofValue,
                       InspcAccessExecRxOrder_ifc actionOnRx)

Adds the info block to send 'get value by path'

Parameters:

sDataPath -

value - The value as long-image, it may be a double, float, int etc.

typeofValue - The type of the value, use InspcDataExchangeAccess#kScalarTypes + ClassJc#REFLECTION_double etc.

cmdSetStringByPath

void cmdSetStringByPath(VariableAccessArray_ifc var,
                        java.lang.String value)

Adds the info block to send 'set value by path'

Parameters:

sDataPath -

value - The value as long-image, it may be a double, float, int etc.

typeofValue - The type of the value, use InspcDataExchangeAccess#kScalarTypes + ClassJc#REFLECTION_double etc.

cmdSetInt32ByPath

void cmdSetInt32ByPath(java.lang.String sDataPath,
                       int value,
                       InspcAccessExecRxOrder_ifc actionOnRx)

Adds the info block to send 'get value by path'

Parameters:

sDataPath -

value - The value as long-image, it may be a double, float, int etc.

typeofValue - The type of the value, use InspcDataExchangeAccess#kScalarTypes + ClassJc#REFLECTION_double etc.

cmdSetFloatByPath

void cmdSetFloatByPath(java.lang.String sDataPath,
                       float value,
                       InspcAccessExecRxOrder_ifc actionOnRx)

Adds the info block to send 'get value by path'

Parameters:

sDataPath -

value - The value as long-image, it may be a double, float, int etc.

typeofValue - The type of the value, use InspcDataExchangeAccess#kScalarTypes + ClassJc#REFLECTION_double etc.

cmdSetDoubleByPath

void cmdSetDoubleByPath(java.lang.String sDataPath,
                        double value,
                        InspcAccessExecRxOrder_ifc actionOnRx)

Adds the info block to send 'get value by path'

Parameters:

sDataPath -

value - The value as long-image, it may be a double, float, int etc.

typeofValue - The type of the value, use InspcDataExchangeAccess#kScalarTypes + ClassJc#REFLECTION_double etc.

cmdGetAddressByPath

boolean cmdGetAddressByPath(java.lang.String sPath,
                            InspcAccessExecRxOrder_ifc actionOnRx)

Adds the info block to send 'get value by path'

Parameters:

sPath - Either the path inside the target or the path with target identification, depends on implementation. Maybe possible with alias.

actionOnRx - it will be added to a list with its order. Executed in the receive thread.

Throws:

java.lang.IllegalArgumentException - if too many requests are done without answer. Hint: Write all activities in try-catch with a common error log.

isOrSetReady

boolean isOrSetReady(long timeCurrent)

Checks readiness of communication cycle. Returns true if a communication cycle is not pending (finished). It is in state States.StateIdle or States.StateFilling Returns false if not all answer telegrams were received from the last request. It is in all other states of States. If the time of the last send request was before timeLastTxWaitFor then it is assumed that the communication was faulty. Therefore all older pending requests are removed. Note: On InspcMng it return false;

Parameters:

timeCurrent - The current time. It is compared with the time of the last transmit telegram which's answer is expected, and the timeout. If the timeout is expired, older requests are removed and this routine returns true.

addUserTxOrder

void addUserTxOrder(java.lang.Runnable order)

Adds any program snippet which is executed while preparing the telegram for data request from target. After execution the order will be removed.

Parameters:

order - the program snippet.

requestFields

void requestFields(InspcTargetAccessData data,
                   InspcAccessExecRxOrder_ifc rxActionGetFields,
                   java.lang.Runnable runOnReceive)

Set the request for all fields of the given variable. This method is invoked from outer (GUI) to force cmdGetFields(String, InspcAccessExecRxOrder_ifc) in the inspector thread.

Parameters:

data - The variable

rxActionGetFields - Action on gotten fields

runOnReceive - Action should be run if all fields are received, if all datagrams are received for that communication cycle.

getTargetAccessFromPath

InspcTargetAccessData getTargetAccessFromPath(java.lang.String sDataPath,
                                              boolean strict)

Splits a given full data path with device:datapath maybe with alias:datapath in the device, path, name and returns a struct. It uses #indexTargetAccessor to get the target accessor instance. It uses #idxAllStruct to get the existing InspcStruct for the variable

Parameters:

sDataPath - The user given data path maybe with alias, necessary with target. An alias is written in form "alias:rest.of.path". A device is written "device:rest.of.path". The distinction between alias and device is done with checking whether the charsequence before : is detected as alias.

strict - true then throws an error on faulty device, if false then returns null if faulty.

Returns:

structure which contains the device, path, name.