org.vishia.communication

Class InspcDataExchangeAccess

java.lang.Object

org.vishia.communication.InspcDataExchangeAccess

public final class InspcDataExchangeAccess
extends java.lang.Object

This class supports preparing data for the Inspector-datagram-definition.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InspcDataExchangeAccess.InspcAnswerValueByHandle An item to set values with an index.
static class	InspcDataExchangeAccess.InspcDatagram Preparing the header of a datagram.
static class	InspcDataExchangeAccess.Inspcitem This is the header of an information entry.
static class	InspcDataExchangeAccess.InspcSetValue ReflItem which contains a value.
static class	InspcDataExchangeAccess.InspcSetValueData An item to set values with an index.

Field Summary

Fields

Modifier and Type	Field and Description
static short	kInvalidHandle This type identification designates that the index to access by index is invalid.
static short	kLengthAndString The value is a string uptp 200 character which's length is stored in the first byte.
static short	kReferenceAddr A reference is the memory-address of an element in C-language or a significant numeric Identifier of an object (instance) in Java.
static short	kReferenceAddr64 A memory-address of an element in C-language or a significant numeric Identifier of an object (instance) in Java.
static short	kScalarTypes Scalar types started with 0xe0, see ClassJc.REFLECTION_int32 etc.
static short	kTypeNoValue This type identification designates that the value is not available.
static short	maxNrOfChars Values between 0..199 determines the length of string.
private static int[]	nrofBytesSpecialTypes
static java.lang.String	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
InspcDataExchangeAccess()

Method Summary

Modifier and Type	Method and Description
static float	getFloatChild(short type, ByteDataAccessBase access) Returns the byte given value with the designated type as float value with conversion.
static int	getIntChild(short type, ByteDataAccessBase access) Returns the byte given value with the designated type as int32 value with conversion.
static int	nrofBytesForType(short type) Returns the number of bytes for any value which is designated with 0..

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2016-01-23 Hartmut new: InspcDataExchangeAccess.Inspcitem.kAccessCheck
• 2016-01-23 Hartmut new: InspcDataExchangeAccess.InspcSetValue.getType() should return short, not byte, to detect the values of the type.
• 2016-01-23 Hartmut new: InspcDataExchangeAccess.InspcSetValue.getInt() etc. now tests the given type and converts it. Till now the transmitter has known the value type and send it proper. But that is not a common approach.
• 2015-08-08 Hartmut new: nrofBytesForType(short), InspcDataExchangeAccess.InspcAnswerValueByHandle. The getValueByHandle is improved and tested. It is changed in communication yet.
• 2015-08-08 Hartmut new: getFloatChild(short, ByteDataAccessBase)
• 2015-08-05 Hartmut adapt: InspcDataExchangeAccess.InspcDatagram.setHeadAnswer(int, int, int): Because the nAnswerNr for the first answer datagram will be incremented, the head need 0 as start value.
• 2013-12-08 Hartmut chg: Rename Datagram to InspcDataExchangeAccess.InspcDatagram and Info to InspcDataExchangeAccess.Inspcitem, better to associate.
• 2013-12-08 Hartmut new: InspcDataExchangeAccess.InspcSetValueData
• 2013-12-07 Hartmut chg:
  • InspcDataExchangeAccess.InspcDatagram.setHeadRequest(int, int, int) with answerNr = 0 and InspcDataExchangeAccess.InspcDatagram.setHeadAnswer(int, int, int) with previous behavior, answerNr = 1 initial. A request telegram sends the answerNr = 0 up to now.
  • Some InspcDataExchangeAccess.InspcDatagram.knrofBytes etc. now private. Any application uses the access methods.
  • new InspcDataExchangeAccess.InspcDatagram.getAnswerNr() and InspcDataExchangeAccess.InspcDatagram.lastAnswer()
  • new InspcDataExchangeAccess.Inspcitem.kSetvaluedata, InspcDataExchangeAccess.Inspcitem.kAnswervaluedata as a new kind of request.
  • new kInvalidHandle to distinguish an index error from a value error.
• 2012-04-09 Hartmut new: Some enhancements, especially InspcDataExchangeAccess.Inspcitem.kGetValueByHandle The InspcDataExchangeAccess.Inspcitem.setInfoHead(int, int, int) and InspcDataExchangeAccess.Inspcitem.setLength(int) now adjusts the length of the element and parent in the ByteDataAccessBase data with the same. Set this information at end of filling variable data in an Info item, then all is correct.
• 2011-06-21 Hartmut new InspcDataExchangeAccess.InspcSetValue completed with set-methods. Note: Because this class is used in Java2C for C-Programming, the short methods should be designated to use macros while translation Java2C.
• 2011-01-01 Hartmut Translated to Java
• 2005 Hartmut created for C-programming

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 ist 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

maxNrOfChars

public static final short maxNrOfChars

Values between 0..199 determines the length of string. A String item contains maximal 200 Bytes.

See Also:

Constant Field Values

kLengthAndString

public static final short kLengthAndString

The value is a string uptp 200 character which's length is stored in the first byte.

See Also:

Constant Field Values

kReferenceAddr64

public static final short kReferenceAddr64

A memory-address of an element in C-language or a significant numeric Identifier of an object (instance) in Java. It is 8 Byte, 64 Bit.

See Also:

Constant Field Values

kInvalidHandle

public static final short kInvalidHandle

This type identification designates that the index to access by index is invalid.

See Also:

Constant Field Values

kTypeNoValue

public static final short kTypeNoValue

This type identification designates that the value is not available.

See Also:

Constant Field Values

kReferenceAddr

public static final short kReferenceAddr

A reference is the memory-address of an element in C-language or a significant numeric Identifier of an object (instance) in Java. It is 4 Byte.

See Also:

Constant Field Values

kScalarTypes

public static final short kScalarTypes

Scalar types started with 0xe0, see ClassJc.REFLECTION_int32 etc.

See Also:

Constant Field Values

nrofBytesSpecialTypes

private static final int[] nrofBytesSpecialTypes

Constructor Detail

InspcDataExchangeAccess

public InspcDataExchangeAccess()

Method Detail

nrofBytesForType

public static int nrofBytesForType(short type)

Returns the number of bytes for any value which is designated with 0.. maxNrOfChars .. kScalarTypes + ClassJc.REFLECTION_int etc.

Parameters:

type -

Returns:

getFloatChild

public static float getFloatChild(short type,
                                  ByteDataAccessBase access)

Returns the byte given value with the designated type as float value with conversion. It is proper if an application is attempt to process a float value independent of the value type.

Parameters:

type - The type returned by Inspector Communication kScalarTypes + ClassJc.REFLECTION_int32 etc. A string is not converted yet. (Necessary? then TODO).

access - Any data access, the value with the given type will be gotten as next child.

Returns:

value in float presentation.

getIntChild

public static int getIntChild(short type,
                              ByteDataAccessBase access)

Returns the byte given value with the designated type as int32 value with conversion. It is proper if an application is attempt to process an int value independent of the value type.

Parameters:

type - The type returned by Inspector Communication kScalarTypes + ClassJc.REFLECTION_int32 etc. A string is not converted yet. (Necessary? then TODO).

access - Any data access, the value with the given type will be gotten as next child.

Returns:

value in int presentation.