InspcDataExchangeAccess.Inspcitem

java.lang.Object
- ByteDataAccessBase
- - org.vishia.communication.InspcDataExchangeAccess.Inspcitem

Direct Known Subclasses:

InspcDataExchangeAccess.InspcAnswerValueByHandle, InspcDataExchangeAccess.InspcSetValueData, InspcTelgInfoSet

Enclosing class:

InspcDataExchangeAccess
```
public static class InspcDataExchangeAccess.Inspcitem
extends ByteDataAccessBase
```
This is the header of an information entry.
```
 Inspcitem::= <@0+2#?SIZE> <@2+2#?cmd> <@4+4#?order> .
 
```
An information entry contains this header and may be some childs. The childs may be simple integer or String childs getting and setting with the methodes to add ByteDataAccessBase#addChildInteger(int, long) or ByteDataAccessBase#addChildString(String). and the methods to get ByteDataAccessBase#getChildInteger(int) or ByteDataAccessBase#getChildString(int). The childs may be described by a named-here class, forex InspcDataExchangeAccess.InspcSetValue

The structure of an information entry may be described with XML, where the XML is only a medium to show the structures, for example:
```
 Example   
 
```
In this case 8 Bytes are added after the head. The length stored in the head is 16. The consists of a length byte, following by ASCII-character.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`kAccessCheck`
`static int`	`kAnswerFieldMethod` Antwort auf Aufforderung zur Rueckgabe einer Liste von Attributen, Assoziationen oder Methoden.
`static int`	`kAnswerMsg`
`static int`	`kAnswerRegisterHandle` Answer cmd to `kRegisterHandle`.
`static int`	`kAnswerRemoveMsgNok`
`static int`	`kAnswerRemoveMsgOk`
`static int`	`kAnswerValue` Answer cmd to `kGetValueByPath`.
`static int`	`kAnswerValueByHandle` Answer cmd to `kGetValueByHandle`.
`static int`	`kAnswervaluedata` This item sets a value with a given position: <@8+4#?
`private static int`	`kbyteOrder`
`static int`	`kFailedCommand`
`static int`	`kFailedHandle` Answer cmd for a `kGetValueByHandle` which is a faulty handle.
`static int`	`kFailedPath`
`static int`	`kFailedRegisterRepeat`
`static int`	`kFailedValue`
`static int`	`kGetAddressByPath`
`static int`	`kGetFields` Aufforderung zur Rueckgabe einer Liste aller Attribute und Assoziationen des adressierten Objektes.
`static int`	`kGetMsg` Request to get all messages
`static int`	`kGetValueByHandle`
`static int`	`kGetValueByPath`
`static int`	`kNoRessource`
`static int`	`kRegisterHandle`
`static int`	`kRemoveMsg` Remove gotten messages.
`static int`	`kSetStringByPath` Sets a string value.
`static int`	`kSetValueByPath` Sets a value with given path.
`static int`	`kSetvaluedata` This item sets a value with a given position: <@8+4#?
`static int`	`sizeofHead`

Constructor Summary

Constructors
Modifier Constructor and Description

Inspcitem()

protected Inspcitem(int sizeHeadDerived)
Constructor for derived items with other head size.

Constructors
Modifier	Constructor and Description
	`Inspcitem()`
`protected`	`Inspcitem(int sizeHeadDerived)` Constructor for derived items with other head size.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCmd()` Returns the cmd in a Reflitem.
`int`	`getLenInfo()`
`int`	`getOrder()` Gets the order number of the info block.
`void`	`infoFormattedAppend(StringFormatter u)`
`void`	`setCmd(int cmd)`
`void`	`setInfoHead(int length, int cmd, int order)` Sets the head data and sets the length of the ByteDataAccess-element.
`void`	`setLength(int length)`

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

- Field Detail
  - kbyteOrder
```
private static final int kbyteOrder
```
    See Also:
    
    Constant Field Values
  - sizeofHead
```
public static final int sizeofHead
```
    See Also:
    
    Constant Field Values
  - kGetFields
```
public static final int kGetFields
```
    Aufforderung zur Rueckgabe einer Liste aller Attribute und Assoziationen des adressierten Objektes. Im Cmd wird der PATH des Objektes uebergeben. Das geschieht in einer Struktur DataExchangeString_OBM. , Cmd: , +------head------------+---------string--------------+ , |kGetFields | PATH mit Punkt am Ende | , +----------------------+-----------------------------+ Dabei wird mit dem ,,head.index,, ein Startindex uebergeben. Dieser soll bei der ersten Abfrage =0 sein. Das positive Antworttelegramm enthaelt eine Liste von Items mit einzelnen Attributen und Assoziationen: , Answer: , +------head-----------+-----string--+-------head----------+-----string-- , |kAnswerFieldMethod | Name:Typ |kAnswerFieldMethod | Name:Typ ... , +---------------------+-------------+---------------------+------------- Der Aufbau des Strings ist bei ,,kAnswerFieldMethod,, beschrieben.
    
    See Also:
    
    Constant Field Values
  - kAccessCheck
```
public static final int kAccessCheck
```
    See Also:
    
    Constant Field Values
  - kAnswerFieldMethod
```
public static final int kAnswerFieldMethod
```
    Antwort auf Aufforderung zur Rueckgabe einer Liste von Attributen, Assoziationen oder Methoden. Das Antwort-Item enthaelt einen Eintrag f�r ein Element, Type DataExchangeString_OBM. Die Antwort auf kGetFields oder kGetMethods besteht aus mehreren Items je nach der Anzahl der vorhandenen Elemente. Gegebenenfalls ist die Antwort auch auf mehrere Telegramme verteilt. Die Zeichenkette fuer ein Item aus zwei Teilen, Typ und Name, getrennt mit einem Zeichen ':'. Der angegebenen Typ entspricht dem Typ der Assoziationsreferenz, nicht dem Typ des tatsaechlich assoziierten Objektes, wenn es sich nicht um einen einfachen Typ handelt. Wenn eine Methode uebergeben wird, dann werden die Aufrufargument-Typen wie eine formale Argumentliste in C angegeben. Beispiel: , returnType:methodName(arg1Typ,arg2Typ) Der Index im Head der Antwort zaehlt die uebergebenen Informationen.
    
    See Also:
    
    Constant Field Values
  - kRegisterHandle
```
public static final int kRegisterHandle
```
    See Also:
    
    Constant Field Values
  - kAnswerRegisterHandle
```
public static final int kAnswerRegisterHandle
```
    Answer cmd to kRegisterHandle.
```
  +------head-8---------+-int-4--+-byte-+-int 4-+--------+
  |kAnswerRegisterHandle| handle | type | value | 0 0 0  |
  +---------------------+--------+------+-------+--------+
 
```
    The handle can be used now. The type is the type byte with encoding see InspcDataExchangeAccess.kScalarTypes. The type determines the number of bytes used by the value in the answer 37. It should be stored to help evaluating the answer correctly. The current value is sent additionally. Type and value are stored in the same way like kAnswerValue.
    See Also:
    
    Constant Field Values
  - kFailedRegisterRepeat
```
public static final int kFailedRegisterRepeat
```
    See Also:
    
    Constant Field Values
  - kGetValueByHandle
```
public static final int kGetValueByHandle
```
    See Also:
    
    Constant Field Values
  - kAnswerValueByHandle
```
public static final int kAnswerValueByHandle
```
    Answer cmd to kGetValueByHandle.
```
  +------head-8---------+-int2-+----------n---------------+
  |kAnswerValueByHandle | ixVal|     values ...........   |
  +---------------------+------+--------------------------+
 
```
    - First int16 after head is the start index of the handle in the request item for that values. It is 0 for the first answer item. If the item cannot contain all answers, a second item in a second telegram will be send which starts with its start index.
    - After them a block with all values follows. The length (bytes) for each value was returned with the kAnswerValueByHandle with the type information.
    See Also:
    
    Constant Field Values
  - kAnswerValue
```
public static final int kAnswerValue
```
    Answer cmd to kGetValueByPath.
```
  +------head-8---------+-byte-+-int 4-+--------+
  |kAnswerValue         | type | value | 0 0 0  |
  +---------------------+------+-------+--------+
 
```
    The child after the item contains the type byte and the value following immediately. The rest to 4-byte-Alignment may be filled with 0 for newer telegrams or the length of the item may be not 4-aligned (older implementations).
    See Also:
    
    Constant Field Values
  - kFailedValue
```
public static final int kFailedValue
```
    See Also:
    
    Constant Field Values
  - kFailedHandle
```
public static final int kFailedHandle
```
    Answer cmd for a kGetValueByHandle which is a faulty handle.
```
  +------head-8---------+-int-2---+-int-2-+
  |kFailedHandle        |ixHandle | ixEnd |
  +---------------------+---------+-------+
 
```
    The ixHandle is the index of the handle in the request. The ixEnd is the index of the next correct handle or the length of the handle array in request if all handles till end are faulty. If only one handle is faulty, ixEnd is ixHandle +1.
    See Also:
    
    Constant Field Values
  - kGetValueByPath
```
public static final int kGetValueByPath
```
    See Also:
    
    Constant Field Values
  - kGetAddressByPath
```
public static final int kGetAddressByPath
```
    See Also:
    
    Constant Field Values
  - kSetValueByPath
```
public static final int kSetValueByPath
```
    Sets a value with given path. The item consists of:
```
 setValueByPath::=<@SIZE=head.nrofBytesItem>
           <@ReflitemHead !cmdItem=0x35 ?head>
           <@8-(SIZE-17):String04?!accesspath> <@(SIZE-16)?InspcSetValue> .
 
```
    Example:
```
+---------+---------+---------'---------+----+----+----+----+----+----+----+----+
|   0x1c  |  0x30   |      order        |  r    o    o    t    .    a    c    c |
+----+----+----+----+----+----+----+----+----+----+----+----+----+----+----+----+
|  e    s    s    .    p    a    t    h    .    0    0    0 |     password      |
+---------+----+----+-------------------+-------------------+-------------------|
|password |    | e4 |  0    0    0    0 | int32 big endian  |
+---------+----+----+-------------------+-------------------+
 
```
    see InspcDataExchangeAccess.InspcSetValue.
    See Also:
    
    Constant Field Values
  - kSetStringByPath
```
public static final int kSetStringByPath
```
    Sets a string value.
```
 < inspcitem> <@+2#?strlen> <@+strlen$?value> <@a4> <@strlen..SIZE$?path> <@a4>
 
```
    Since:
    
    2013-12-24
    
    See Also:
    
    Constant Field Values
  - kGetMsg
```
public static final int kGetMsg
```
    Request to get all messages. , Cmd:
```
    ,  +------head-----------+
    ,  |kGetMs               |
    ,  +---------------------+
    
```
    , Answer:
```
    ,  +------head-----------+---------+---------+---------+---------+
    ,  |kAnswerMsg           | Msg     | Msg     | Msg     | Msg     |
    ,  +---------------------+---------+---------+---------+---------+

 Any Message has 16 to 80 Bytes. The structure of a message is described with InspcMsgDataExchg.
 This structure should be used as child. All values of the message are children of that child.
```
    See Also:
    
    Constant Field Values
  - kAnswerMsg
```
public static final int kAnswerMsg
```
    See Also:
    
    Constant Field Values
  - kRemoveMsg
```
public static final int kRemoveMsg
```
    Remove gotten messages. Any message contains a sequence number. The answer of kGetMsg contains all messages in a proper sequence order from..to. This Telegram removes the messages from..to sequence. , Cmd:
```
    ,  +------head-----------+--int-----+--int-----+
    ,  |kRemoveMsg           | from seq | to seq   |
    ,  +---------------------+----------+----------+
    
```
    , Answer:
```
    ,  +------head-----------+
    ,  |kAnswerRemoveMsg     |
    ,  +---------------------+
```
    See Also:
    
    Constant Field Values
  - kAnswerRemoveMsgOk
```
public static final int kAnswerRemoveMsgOk
```
    See Also:
    
    Constant Field Values
  - kAnswerRemoveMsgNok
```
public static final int kAnswerRemoveMsgNok
```
    See Also:
    
    Constant Field Values
  - kSetvaluedata
```
public static final int kSetvaluedata
```
    This item sets a value with a given position:
```
 <@8+4#?position> <@12+4#?length> <@16..SIZE#?bitImageValue>
 
```
    The position may be a memory address which is known in the client proper to the target or it may be a relative offset in any target's data. The type of data is target-specific.
    See Also:
    
    Constant Field Values
  - kAnswervaluedata
```
public static final int kAnswervaluedata
```
    This item sets a value with a given position:
```
 <@8+4#?position> <@12+4#?length> <@16..SIZE#?bitImageValue>
 
```
    The position may be a memory address which is known in the client proper to the target or it may be a relative offset in any target's data. The type of data is target-specific.
    See Also:
    
    Constant Field Values
  - kFailedPath
```
public static final int kFailedPath
```
    See Also:
    
    Constant Field Values
  - kNoRessource
```
public static final int kNoRessource
```
    See Also:
    
    Constant Field Values
  - kFailedCommand
```
public static final int kFailedCommand
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Inspcitem
```
protected Inspcitem(int sizeHeadDerived)
```
    Constructor for derived items with other head size.
    
    Parameters:
    
    sizeHeadDerived -
  - Inspcitem
```
public Inspcitem()
```
- Method Detail
  - setInfoHead
```
public final void setInfoHead(int length,
                              int cmd,
                              int order)
```
    Sets the head data and sets the length of the ByteDataAccess-element. This routine should invoked at last after all children are added because the element will be freeze. Especially ByteDataAccessBase#bExpand is set to false. That is because the length in head should match to the real length of the element.
    
    Parameters:
    
    length - The length in head, the length of the info element
    
    cmd - The cmd of the info element
    
    order - The order number to assign the answer.
  - setLength
```
public final void setLength(int length)
```
  - setCmd
```
public final void setCmd(int cmd)
```
  - getCmd
```
public final int getCmd()
```
    Returns the cmd in a Reflitem. The cmd is coded see kFailedCommand, kAnswerFieldMethod etc.
    
    Returns:
  - getLenInfo
```
public final int getLenInfo()
```
  - getOrder
```
public final int getOrder()
```
    Gets the order number of the info block. A sending info is set with the setInfoHead(int, int, int) with any order identification number which is unified for the target in a proper time. The received info returns the same order ident.
    
    Returns:
    
    The order from this Info block.
  - infoFormattedAppend
```
public void infoFormattedAppend(StringFormatter u)
```

Class InspcDataExchangeAccess.Inspcitem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

kbyteOrder

sizeofHead

kGetFields

kAccessCheck

kAnswerFieldMethod

kRegisterHandle

kAnswerRegisterHandle

kFailedRegisterRepeat

kGetValueByHandle

kAnswerValueByHandle

kAnswerValue

kFailedValue

kFailedHandle

kGetValueByPath

kGetAddressByPath

kSetValueByPath

kSetStringByPath

kGetMsg

kAnswerMsg

kRemoveMsg

kAnswerRemoveMsgOk

kAnswerRemoveMsgNok

kSetvaluedata

kAnswervaluedata

kFailedPath

kNoRessource

kFailedCommand

Constructor Detail

Inspcitem

Inspcitem

Method Detail

setInfoHead

setLength

setCmd

getCmd

getLenInfo

getOrder

infoFormattedAppend