org.vishia.inspcPC.mng

Class InspcCmdStore

java.lang.Object

org.vishia.inspcPC.mng.InspcCmdStore

All Implemented Interfaces:

InspcAccess_ifc

class InspcCmdStore
extends java.lang.Object
implements InspcAccess_ifc

This class stores commands to any target from any application. Used for example for InspcMng#cmdSetValueByPath(String, float, org.vishia.inspcPC.InspcAccessExecRxOrder_ifc) The preparation of the telegram is only done in one thread. Therefore the command is stored here.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) InspcAccessExecRxOrder_ifc	actionOnRx
(package private) int	cmd The command like defined in InspcDataExchangeAccess.Inspcitem
(package private) int	handle
(package private) InspcMng	inspc
(package private) java.lang.String	sDataPath
(package private) int	typeofValue
(package private) long	value A value is stored in a long format, as float or double bit image though it is a double or float value.
(package private) java.lang.String	values

Fields inherited from interface org.vishia.inspcPC.InspcAccess_ifc

idLogFailedSeq, idLogGetAddress, idLogGetFields, idLogGetOther, idLogGetValueByIdent, idLogGetValueByPath, idLogRcvGetAddress, idLogRcvGetFields, idLogRcvGetOther, idLogRcvGetValueByIdent, idLogRcvGetValueByPath, idLogRcvRegisterByPath, idLogRcvSetValueByPath, idLogRegisterByPath, idLogRx, idLogRxError, idLogRxItem, idLogRxLast, idLogRxNotlast, idLogRxRepeat, idLogSetValueByPath, idLogTx, sVersion

Constructor Summary

Constructors

Constructor and Description
InspcCmdStore(InspcMng inspc)

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 sDataPath, 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'
(package private) void	exec() Executes the stored command in this thread.
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.

Methods inherited from class java.lang.Object

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

Field Detail

inspc

final InspcMng inspc

sDataPath

java.lang.String sDataPath

handle

int handle

cmd

int cmd

The command like defined in InspcDataExchangeAccess.Inspcitem

value

long value

A value is stored in a long format, as float or double bit image though it is a double or float value. The typeofValue contains the type. That is the convention of communication.

values

java.lang.String values

typeofValue

int typeofValue

actionOnRx

InspcAccessExecRxOrder_ifc actionOnRx

Constructor Detail

InspcCmdStore

public InspcCmdStore(InspcMng inspc)

Method Detail

cmdGetFields

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

Specified by:

cmdGetFields in interface InspcAccess_ifc

cmdGetValueByPath

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

Description copied from interface: InspcAccess_ifc

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

Specified by:

cmdGetValueByPath in interface InspcAccess_ifc

Returns:

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

cmdRegisterHandle

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

Description copied from interface: InspcAccess_ifc

Adds the info block to send 'register by path'

Specified by:

cmdRegisterHandle in interface InspcAccess_ifc

Returns:

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

cmdGetValueByHandle

public boolean cmdGetValueByHandle(int ident,
                                   InspcAccessExecRxOrder_ifc actionOnRx)

Description copied from interface: InspcAccess_ifc

Adds the info block to send 'register by path'

Specified by:

cmdGetValueByHandle in interface InspcAccess_ifc

Returns:

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

cmdSetValueByPath

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

Description copied from interface: InspcAccess_ifc

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

Specified by:

cmdSetValueByPath in interface InspcAccess_ifc

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

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

Description copied from interface: InspcAccess_ifc

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

Specified by:

cmdSetInt32ByPath in interface InspcAccess_ifc

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

cmdSetStringByPath

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

Description copied from interface: InspcAccess_ifc

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

Specified by:

cmdSetStringByPath in interface InspcAccess_ifc

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

cmdSetFloatByPath

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

Description copied from interface: InspcAccess_ifc

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

Specified by:

cmdSetFloatByPath in interface InspcAccess_ifc

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

cmdSetDoubleByPath

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

Description copied from interface: InspcAccess_ifc

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

Specified by:

cmdSetDoubleByPath in interface InspcAccess_ifc

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

cmdGetAddressByPath

public boolean cmdGetAddressByPath(java.lang.String sDataPath,
                                   InspcAccessExecRxOrder_ifc actionOnRx)

Description copied from interface: InspcAccess_ifc

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

Specified by:

cmdGetAddressByPath in interface InspcAccess_ifc

Parameters:

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

isOrSetReady

public boolean isOrSetReady(long timeCurrent)

Description copied from interface: InspcAccess_ifc

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;

Specified by:

isOrSetReady in interface InspcAccess_ifc

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

public void addUserTxOrder(java.lang.Runnable order)

Description copied from interface: InspcAccess_ifc

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

Specified by:

addUserTxOrder in interface InspcAccess_ifc

Parameters:

order - the program snippet.

requestFields

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

Description copied from interface: InspcAccess_ifc

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

Specified by:

requestFields in interface InspcAccess_ifc

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

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

Description copied from interface: InspcAccess_ifc

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

Specified by:

getTargetAccessFromPath in interface InspcAccess_ifc

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.

exec

void exec()

Executes the stored command in this thread.