Inspcitem

java.lang.Object
- org.vishia.inspcComm.Inspcitem

```
public class Inspcitem
extends java.lang.Object
```
This class contains the organization of access to datagram data given in a byte[] array for one request or answer item. Any item starts with at least 4 head bytes. In a C language struct it is:
```
 typedef struct Inspcitem_t
 {
   int16 nrofBytes;
   int16 cmd;
 } Inspcitem;
 
```
Depending on the command the item has some more bytes which can be recognized as children of the ByteDataAccess. The other possibility in C language my be: test and cast. But in C the C-translated version of this class and ByteDataAccessBase is used for too.

This class contains all yet defined cmd constants for a Inspcector datagram item starting with

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Inspcitem.Head` Access to head data.
`static class`	`Inspcitem.HeadOrder` The older form of items contains an order number to associate an answer item to its request.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`kAnswerFieldMethod` Antwort auf Aufforderung zur Rueckgabe einer Liste von Attributen, Assoziationen oder Methoden.
`static int`	`kAnswerMsg`
`static int`	`kAnswerRegisterRepeat`
`static int`	`kAnswerRemoveMsgNok`
`static int`	`kAnswerRemoveMsgOk`
`static int`	`kAnswerValue`
`static int`	`kAnswerValueByIndex` , answer: , +------head-8---------+-int-4-+-int-4-+---n-------+-int-4-+---n-------+ , \|kAnswerValueByIndex \| ixVal \| types \| values \| types \| values \| , +---------------------+-------+-------+-----------+-------+-----------+ First byte after head is the start index of variable for answer.
`static int`	`kAnswervaluedata` This item sets a value with a given position: <@8+4#?
`static int`	`kFailedCommand`
`static int`	`kFailedPath`
`static int`	`kFailedRegisterRepeat`
`static int`	`kFailedValue`
`static int`	`kGetAddressByPath`
`static int`	`kGetFields` Request to get a list of all attributes and associations of the addressed Object.
`static int`	`kGetMsg` Request to get all messages
`static int`	`kGetValueByIndex`
`static int`	`kGetValueByPath`
`static int`	`kNoRessource`
`static int`	`kRegisterRepeat`
`static int`	`kRemoveMsg` Remove gotten messages.
`static int`	`kSetStringByPath` Sets a string value.
`static int`	`kSetValueByPath`
`static int`	`kSetvaluedata` This item sets a value with a given position: <@8+4#?

Constructor Summary

Constructors
Constructor and Description

Inspcitem()

Constructors
Constructor and Description
`Inspcitem()`

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

Field Detail

kGetFields
```
public static final int kGetFields
```
Request to get a list of all attributes and associations of the addressed Object. The address is given as String , Cmd: , +------head------------+---------string--------------+ , |kGetFields | PATH with dot on end | , +----------------------+-----------------------------+ The positive answer datagram contains some Inspcitem for each Attribute or association: , Answer: , +------head-----------+-----string--+-------head----------+-----string-- , |kAnswerFieldMethod | Name:Typ |kAnswerFieldMethod | Name:Typ ... , +---------------------+-------------+---------------------+------------- The structure of the string is described on kAnswerFieldMethod.

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. One Answer for the request kGetFields or kGetMethods (not yet ready) for one field or one method. For one request some more answer items are produced which were send all with one sequence number maybe with more as one answer datagram with incremented InspcDatagram.SeqEntrant.answer() number. All that answer items are associated to the only one request.

The answer contains a Inspcitem.HeadOrder following by a String. The String should be end with 0..3 zero-Bytes for 4-byte-boundary (tolerable if not). The String has the following syntax (ZBNF)

 nameType::= <*:?name> : <*:\[\.?type> [ \[\]  | \[ <#?arrayLen> \] |] [\.\.\.].
  The String consists of two parts separated by a colon: name:type. The type is given as String. 
 It can have some additional information about array, container, sub struct. The type is the type of the reference.
 Note: If inheritance is used, the type of the associated instance can be an derived type which's fields and methods can be evaluated
 by an invocation of 16 with that path as address.
 


 Examples for that syntax:
 
 name:typ: for simple fields.
 
name:typ...: for a struct type. In the target system it may be a reference or a embedded structure in C.
 
name:typ[99]: with the number of array elements if it is a static array with known number of elements.
 
name:typ[99]...: Array of pointers or instances which are a struct.
 
name:typ[]: Array with dynamic size or any other container. Its size ...TODO

See Also:: Constant Field Values

kRegisterRepeat
```
public static final int kRegisterRepeat
```
See Also:

Constant Field Values

kAnswerRegisterRepeat
```
public static final int kAnswerRegisterRepeat
```
See Also:

Constant Field Values

kFailedRegisterRepeat
```
public static final int kFailedRegisterRepeat
```
See Also:

Constant Field Values

kGetValueByIndex
```
public static final int kGetValueByIndex
```
See Also:

Constant Field Values

kAnswerValueByIndex

public static final int kAnswerValueByIndex

  ,  answer:
  ,  +------head-8---------+-int-4-+-int-4-+---n-------+-int-4-+---n-------+
  ,  |kAnswerValueByIndex  | ixVal | types | values    | types | values    |
  ,  +---------------------+-------+-------+-----------+-------+-----------+
 
 First byte after head is the start index of variable for answer. It is 0 for the first answer
   info block. If the info block cannot contain all answers, a second info block in a second telegram
   will be send which starts with its start index.
 
After them a block with up to 4 values follows. The first word of that block ///
   contains 4 types of values, see InspcDataExchangeAccess#kScalarTypes. Especially the

See Also:: Constant Field Values

kAnswerValue
```
public static final int kAnswerValue
```
See Also:

Constant Field Values

kFailedValue
```
public static final int kFailedValue
```
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
```
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 org.vishia.msgDispatch.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
```
public Inspcitem()
```

Class Inspcitem

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

kGetFields

kAnswerFieldMethod

kRegisterRepeat

kAnswerRegisterRepeat

kFailedRegisterRepeat

kGetValueByIndex

kAnswerValueByIndex

kAnswerValue

kFailedValue

kGetValueByPath

kGetAddressByPath

kSetValueByPath

kSetStringByPath

kGetMsg

kAnswerMsg

kRemoveMsg

kAnswerRemoveMsgOk

kAnswerRemoveMsgNok

kSetvaluedata

kAnswervaluedata

kFailedPath

kNoRessource

kFailedCommand

Constructor Detail

Inspcitem