de.htw.berlin.polysun4diac.forte.comm

Class ForteDataBufferLayer

java.lang.Object

de.htw.berlin.polysun4diac.forte.comm.AbstractCommunicationLayer

de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

de.htw.berlin.polysun4diac.forte.comm.ForteDataBufferLayer

All Implemented Interfaces:

ICommunicationLayer, IForteSocket, java.io.Serializable

public class ForteDataBufferLayer
extends de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer
implements IForteSocket, java.io.Serializable

Class for reading/writing and buffering 4diac-RTE (FORTE) byte data arriving from or to be sent to a communication service interface function block (CSIFB). Although it is technically possible to use an instance of this class both for handling received data and data to be sent, it is not recommended if the CSIFB's data inputs differ from it's data outputs. In this case, use a CommFunctionBlockLayer, which has two "parallel" ForteDataBufferLayer objects below: One for the inputs and one of the outputs.

The class can perform the following conversions between JAVA objects and IEC 61499 data types:

JAVA object/primitive	IEC 61499 data type
boolean	BOOL
int	SINT, INT, DINT, USINT, UINT, UDINT
long	LINT, ULINT
float	REAL
double	LREAL
DateAndTime*, LocalDateTime	DATE_AND_TIME
String	STRING**

*DateAndTime is part of this library.

Author:

Marc Jakobi

HTW Berlin

July 2017

See Also:

ForteDataType, DateAndTime, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ForteDataBufferLayer()

Method Summary

Modifier and Type	Method and Description
byte[]	array() This method is intended to allow array-backed buffers to be passed to native code more efficiently.
int	capacity() Returns the buffer's capacity
void	disconnect() Closes the connection.
boolean	getBool() Increments the position by one.
boolean[]	getBoolArray() Increments the position by one.
DateAndTime	getDateAndTime() Increments the position by one.
DateAndTime[]	getDateAndTimeArray() Increments the position by one.
double	getDouble() Increments the position by one.
double[]	getDoubleArray() Increments the position by one.
float	getFloat() Increments the position by one.
float[]	getFloatArray() Increments the position by one.
int	getInt() Increments the position by one.
int[]	getIntArray() Increments the position by one.
long	getLong() Increments the position by one.
long[]	getLongArray() Increments the position by one.
int	getNumDataValues()
int	getPosition() Returns mPosition If mPosition is in the initialized position of -1, this method returns 0.
java.lang.String	getString() Increments the position by one.
java.lang.String[]	getStringArray() Increments the position by one.
ForteDataType	getTypeAtNextPosition() Returns Intended for enabling the dynamic retrieval of data from the buffer.
ForteDataType	getTypeAtPosition(int position) Intended for enabling the dynamic retrieval of data from the buffer.
boolean	incrementPosition() Increments this buffer's position by 1.
void	initialise(java.util.List<java.lang.Enum<?>> dataTypes, java.util.List<java.lang.Integer> arraySizes) Initializes this object's buffer that can hold multiple arrays of various data types
boolean	isArrayAtPosition(int position) Intended for enabling the dynamic retrieval of data from the buffer.
boolean	isBool()
boolean	isBoolArray()
boolean	isConnected()
boolean	isDateAndTime()
boolean	isDateAndTimeArray()
boolean	isDouble()
boolean	isDoubleArray()
boolean	isFloat()
boolean	isFloatArray()
boolean	isInt()
boolean	isIntArray()
boolean	isLong()
boolean	isLongArray()
boolean	isString()
boolean	isStringArray()
java.util.Iterator<java.lang.Object>	iterator() Use this method with caution.
boolean	openConnection(CommLayerParams params) Opens the connection and sets up the communication stack.
boolean	put(boolean value) Adds a boolean to be sent to FORTE as an IEC 61499 BOOLEAN to buffer
boolean	put(boolean[] value) Adds a boolean[] array to be sent to FORTE as an IEC 61499 BOOLEAN array to buffer
boolean	put(DateAndTime value) Adds a DateAndTime object to be sent to FORTE as IEC 61499 DATE_AND_TIME data to buffer
boolean	put(DateAndTime[] value) Adds a DateAndTime[] array to be sent to FORTE as an IEC 61499 DATE_AND_TIME array to buffer
boolean	put(double value) Adds a double to be sent to FORTE as IEC 61499 LREAL to buffer
boolean	put(double[] value) Adds a double[] array to be sent to FORTE as an IEC 61499 LREAL array to buffer
boolean	put(float value) Adds a float to be sent to FORTE as IEC 61499 REAL to buffer
boolean	put(float[] value) Adds a float[] array to be sent to FORTE as an IEC 61499 REAL array to buffer
boolean	put(int value) Adds a 32 bit int to be sent to FORTE as one of the IEC 61499 32 bit integer types to buffer
boolean	put(int[] value) Adds a 32 bit int[] array to be sent to FORTE as an IEC 61499 32 bit integer array to buffer
boolean	put(long value) Adds a 64 bit long integer to be sent to FORTE as an IEC 61499 integer to buffer
boolean	put(long[] value) Adds a 64 bit long[] integer array to be sent to FORTE as an IEC 61499 integer array to buffer
boolean	put(java.lang.String value) Adds a String to be sent to FORTE as an IEC 61499 STRING to buffer
boolean	put(java.lang.String[] value) Adds a String[] array to be sent to FORTE as an IEC 61499 STRING array to buffer
byte	readByte() Reads a byte from the communication layer below or the connected device if this layer is the bottom layer.
void	recvData() Performs the necessary actions for receiving data.
void	reset() Resets the position to its initialized state and clears the internal byte buffer.
void	rewind() Resets the position to its initialized state.
void	sendData() Writes the data stored within this instance's byte buffer to a DataOutputStream.
void	sendData(byte[] data, int off, int len) Performs the necessary actions for sending data.
void	sendRsp() Sends a response (e.g., a single byte with the value of 5)
void	setDateAndTimeReference(DateAndTime dt) Sets a DateAndTime object as reference for any new DateAndTime objects received.
void	setPosition(int position) Sets the position.

Methods inherited from class de.htw.berlin.polysun4diac.forte.comm.AbstractCommunicationLayer

closeConnection, getAbove, getBelow, getConnectionState, getRawBytes, readDouble, readFloat, readLong, sendData, setAbove, setBelow

Methods inherited from class java.lang.Object

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

Constructor Detail

ForteDataBufferLayer

public ForteDataBufferLayer()

Method Detail

openConnection

public boolean openConnection(CommLayerParams params)
                       throws java.io.IOException

Description copied from interface: ICommunicationLayer

Opens the connection and sets up the communication stack. If necessary, additional layers below this layer are created.

Specified by:

openConnection in interface ICommunicationLayer

Overrides:

openConnection in class AbstractCommunicationLayer

Parameters:

params - CommLayerParams object holding the connection info

Returns:

true if the connection was opened successfully, false otherwise

Throws:

java.io.IOException

initialise

public void initialise(java.util.List<java.lang.Enum<?>> dataTypes,
                       java.util.List<java.lang.Integer> arraySizes)

Initializes this object's buffer that can hold multiple arrays of various data types

Specified by:

initialise in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Parameters:

dataTypes - List containing the ForteDataType enumerations. This could be the inputs of outputs set in a CommLayerParams object.

arraySizes - List containing the corresponding array sizes (1 for non-arrays) This could be the array sizes set in a CommLayerParams object.

See Also:

ForteDataType

put

public boolean put(float value)

Description copied from interface: IForteSocket

Adds a float to be sent to FORTE as IEC 61499 REAL to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

put

public boolean put(float[] value)

Description copied from interface: IForteSocket

Adds a float[] array to be sent to FORTE as an IEC 61499 REAL array to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

put

public boolean put(double value)

Description copied from interface: IForteSocket

Adds a double to be sent to FORTE as IEC 61499 LREAL to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

put

public boolean put(double[] value)

Description copied from interface: IForteSocket

Adds a double[] array to be sent to FORTE as an IEC 61499 LREAL array to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

put

public boolean put(int value)

Description copied from interface: IForteSocket

Adds a 32 bit int to be sent to FORTE as one of the IEC 61499 32 bit integer types to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Parameters:

value - Value to be converted to byte data

Returns:

true if more data can be added, false if not

put

public boolean put(int[] value)

Description copied from interface: IForteSocket

Adds a 32 bit int[] array to be sent to FORTE as an IEC 61499 32 bit integer array to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

put

public boolean put(long value)

Description copied from interface: IForteSocket

Adds a 64 bit long integer to be sent to FORTE as an IEC 61499 integer to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

put

public boolean put(long[] value)

Description copied from interface: IForteSocket

Adds a 64 bit long[] integer array to be sent to FORTE as an IEC 61499 integer array to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

put

public boolean put(boolean value)

Description copied from interface: IForteSocket

Adds a boolean to be sent to FORTE as an IEC 61499 BOOLEAN to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

put

public boolean put(boolean[] value)

Description copied from interface: IForteSocket

Adds a boolean[] array to be sent to FORTE as an IEC 61499 BOOLEAN array to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

put

public boolean put(java.lang.String value)

Description copied from interface: IForteSocket

Adds a String to be sent to FORTE as an IEC 61499 STRING to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

put

public boolean put(java.lang.String[] value)

Description copied from interface: IForteSocket

Adds a String[] array to be sent to FORTE as an IEC 61499 STRING array to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

put

public boolean put(DateAndTime value)

Description copied from interface: IForteSocket

Adds a DateAndTime object to be sent to FORTE as IEC 61499 DATE_AND_TIME data to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

put

public boolean put(DateAndTime[] value)

Description copied from interface: IForteSocket

Adds a DateAndTime[] array to be sent to FORTE as an IEC 61499 DATE_AND_TIME array to buffer

Specified by:

put in interface IForteSocket

Specified by:

put in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if more data can be added, false if not

array

public byte[] array()

Description copied from interface: IForteSocket

This method is intended to allow array-backed buffers to be passed to native code more efficiently. Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa.

Specified by:

array in interface IForteSocket

Specified by:

array in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

the array that backs this buffer (optional operation).

getBool

public boolean getBool()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isBool() to determine whether the correct data type is at the next position.

Specified by:

getBool in interface IForteSocket

Specified by:

getBool in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

boolean value at the next position.

getLong

public long getLong()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isLong() to determine whether the correct data type is at the next position.

Specified by:

getLong in interface IForteSocket

Specified by:

getLong in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

long value at the next position.

getInt

public int getInt()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isInt() to determine whether the correct data type is at the next position.

Specified by:

getInt in interface IForteSocket

Specified by:

getInt in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

int value at the next position.

getFloat

public float getFloat()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isFloat() to determine whether the correct data type is at the next position.

Specified by:

getFloat in interface IForteSocket

Specified by:

getFloat in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

float value at the next position.

getDouble

public double getDouble()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isDouble() to determine whether the correct data type is at the next position.

Specified by:

getDouble in interface IForteSocket

Specified by:

getDouble in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

double value at the next position.

getDateAndTime

public DateAndTime getDateAndTime()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isDateAndTime() to determine whether the correct data type is at the next position.

Specified by:

getDateAndTime in interface IForteSocket

Specified by:

getDateAndTime in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

DateAndTime value at the next position.

getString

public java.lang.String getString()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isString() to determine whether the correct data type is at the next position.

Specified by:

getString in interface IForteSocket

Specified by:

getString in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

String value at the next position.

getBoolArray

public boolean[] getBoolArray()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isBoolArray() to determine whether the correct data type is at the next position.

Specified by:

getBoolArray in interface IForteSocket

Specified by:

getBoolArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

boolean[] value at the next position.

getLongArray

public long[] getLongArray()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isLongArray() to determine whether the correct data type is at the next position.

Specified by:

getLongArray in interface IForteSocket

Specified by:

getLongArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

long[] value at the next position.

getIntArray

public int[] getIntArray()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isIntArray() to determine whether the correct data type is at the next position.

Specified by:

getIntArray in interface IForteSocket

Specified by:

getIntArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

int[] value at the next position.

getFloatArray

public float[] getFloatArray()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isFloatArray() to determine whether the correct data type is at the next position.

Specified by:

getFloatArray in interface IForteSocket

Specified by:

getFloatArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

float[] value at the next position.

getDoubleArray

public double[] getDoubleArray()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isDoubleArray() to determine whether the correct data type is at the next position.

Specified by:

getDoubleArray in interface IForteSocket

Specified by:

getDoubleArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

double[] value at the next position.

getDateAndTimeArray

public DateAndTime[] getDateAndTimeArray()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isDateAndTimeArray() to determine whether the correct data type is at the next position.

Specified by:

getDateAndTimeArray in interface IForteSocket

Specified by:

getDateAndTimeArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

DateAndTime[] value at the next position.

getStringArray

public java.lang.String[] getStringArray()

Description copied from interface: IForteSocket

Increments the position by one.

Use IForteSocket.isStringArray() to determine whether the correct data type is at the next position.

Specified by:

getStringArray in interface IForteSocket

Specified by:

getStringArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

String[] value at the next position.

isBool

public boolean isBool()

Specified by:

isBool in interface IForteSocket

Specified by:

isBool in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type boolean. If the position is at the end of the data buffer, the current position is checked.

isLong

public boolean isLong()

Specified by:

isLong in interface IForteSocket

Specified by:

isLong in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type long. If the position is at the end of the data buffer, the current position is checked.

isInt

public boolean isInt()

Specified by:

isInt in interface IForteSocket

Specified by:

isInt in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type int. If the position is at the end of the data buffer, the current position is checked.

isFloat

public boolean isFloat()

Specified by:

isFloat in interface IForteSocket

Specified by:

isFloat in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type float. If the position is at the end of the data buffer, the current position is checked.

isDouble

public boolean isDouble()

Specified by:

isDouble in interface IForteSocket

Specified by:

isDouble in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type double. If the position is at the end of the data buffer, the current position is checked.

isDateAndTime

public boolean isDateAndTime()

Specified by:

isDateAndTime in interface IForteSocket

Specified by:

isDateAndTime in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type DateAndTime. If the position is at the end of the data buffer, the current position is checked.

isString

public boolean isString()

Specified by:

isString in interface IForteSocket

Specified by:

isString in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type String. If the position is at the end of the data buffer, the current position is checked.

isBoolArray

public boolean isBoolArray()

Specified by:

isBoolArray in interface IForteSocket

Specified by:

isBoolArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type boolean[]. If the position is at the end of the data buffer, the current position is checked.

isLongArray

public boolean isLongArray()

Specified by:

isLongArray in interface IForteSocket

Specified by:

isLongArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type long[]. If the position is at the end of the data buffer, the current position is checked.

isIntArray

public boolean isIntArray()

Specified by:

isIntArray in interface IForteSocket

Specified by:

isIntArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type int[]. If the position is at the end of the data buffer, the current position is checked.

isFloatArray

public boolean isFloatArray()

Specified by:

isFloatArray in interface IForteSocket

Specified by:

isFloatArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type float[]. If the position is at the end of the data buffer, the current position is checked.

isDoubleArray

public boolean isDoubleArray()

Specified by:

isDoubleArray in interface IForteSocket

Specified by:

isDoubleArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type double[]. If the position is at the end of the data buffer, the current position is checked.

isDateAndTimeArray

public boolean isDateAndTimeArray()

Specified by:

isDateAndTimeArray in interface IForteSocket

Specified by:

isDateAndTimeArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type DateAndTime[]. If the position is at the end of the data buffer, the current position is checked.

isStringArray

public boolean isStringArray()

Specified by:

isStringArray in interface IForteSocket

Specified by:

isStringArray in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if value at next position is of type String[]. If the position is at the end of the data buffer, the current position is checked.

recvData

public void recvData()
              throws java.io.IOException

Description copied from interface: ICommunicationLayer

Performs the necessary actions for receiving data.

Specified by:

recvData in interface ICommunicationLayer

Specified by:

recvData in interface IForteSocket

Overrides:

recvData in class AbstractCommunicationLayer

Throws:

java.io.IOException

sendData

public void sendData()
              throws java.io.IOException

Description copied from interface: IForteSocket

Writes the data stored within this instance's byte buffer to a DataOutputStream. IForteSocket.reset() is called after completing the write operation. Before calling this method, the data output layer must be set using #setOutputLayer(AbstractCommunicationLayer).

Specified by:

sendData in interface IForteSocket

Specified by:

sendData in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Throws:

java.io.IOException

sendData

public void sendData(byte[] data,
                     int off,
                     int len)
              throws java.io.IOException

Description copied from interface: ICommunicationLayer

Performs the necessary actions for sending data.

Specified by:

sendData in interface ICommunicationLayer

Overrides:

sendData in class AbstractCommunicationLayer

Parameters:

data - Byte array containing the data

len - Length of the data to be sent

Throws:

java.io.IOException

sendRsp

public void sendRsp()
             throws java.io.IOException

Description copied from interface: IForteSocket

Sends a response (e.g., a single byte with the value of 5)

Specified by:

sendRsp in interface IForteSocket

Specified by:

sendRsp in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Throws:

java.io.IOException

reset

public void reset()

Description copied from interface: IForteSocket

Resets the position to its initialized state and clears the internal byte buffer.

Specified by:

reset in interface IForteSocket

Specified by:

reset in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

getTypeAtPosition

public ForteDataType getTypeAtPosition(int position)

Description copied from interface: IForteSocket

Intended for enabling the dynamic retrieval of data from the buffer. Throws an exception if position is out of bounds.

Specified by:

getTypeAtPosition in interface IForteSocket

Specified by:

getTypeAtPosition in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

a ForteDataType enumeration representing the FORTE data type at the specified position.

getTypeAtNextPosition

public ForteDataType getTypeAtNextPosition()

Description copied from interface: IForteSocket

Returns Intended for enabling the dynamic retrieval of data from the buffer. Throws an exception if position is out of bounds.

Specified by:

getTypeAtNextPosition in interface IForteSocket

Specified by:

getTypeAtNextPosition in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

a ForteDataType enumeration representing the FORTE data type at the next position.

isArrayAtPosition

public boolean isArrayAtPosition(int position)

Description copied from interface: IForteSocket

Intended for enabling the dynamic retrieval of data from the buffer. Throws an exception if position is out of bounds.

Specified by:

isArrayAtPosition in interface IForteSocket

Specified by:

isArrayAtPosition in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if the data at the specified position is an array and false otherwise.

rewind

public void rewind()

Description copied from interface: IForteSocket

Resets the position to its initialized state.

Specified by:

rewind in interface IForteSocket

Specified by:

rewind in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

iterator

public java.util.Iterator<java.lang.Object> iterator()

Description copied from interface: IForteSocket

Use this method with caution. It is recommended to use the class's type-safe built-in iteration methods instead.

Specified by:

iterator in interface IForteSocket

Specified by:

iterator in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

Iterator over the elements in this buffer in proper sequence.

See Also:

#isDouble()}, {@link #getDouble()} {@link #isDoubleArray()}, {@link #getDoubleArray()}, {@link #getBool()}, {@link #getInt()} {@link #getLong()}, {@link #getFloat()}, {@link #getString()}, {@link #getDateAndTime()}, {@link #getLocalDateTime()}, {@link #getBoolArray()}, {@link #getIntArray()} {@link #getLongArray()}, {@link #getFloatArray()}, {@link #getStringArray()}, {@link #getDateAndTimeArray()}, {@link #getLocalDateTimeArray()}, etc.

isConnected

public boolean isConnected()

Specified by:

isConnected in interface IForteSocket

Specified by:

isConnected in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if the socket is connected, false otherwise.

readByte

public byte readByte()
              throws java.io.IOException

Description copied from interface: ICommunicationLayer

Reads a byte from the communication layer below or the connected device if this layer is the bottom layer.

Specified by:

readByte in interface ICommunicationLayer

Overrides:

readByte in class AbstractCommunicationLayer

Returns:

The next byte from the .

Throws:

java.io.IOException

capacity

public int capacity()

Description copied from interface: IForteSocket

Returns the buffer's capacity

Specified by:

capacity in interface IForteSocket

Specified by:

capacity in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

incrementPosition

public boolean incrementPosition()

Description copied from interface: IForteSocket

Increments this buffer's position by 1.

Specified by:

incrementPosition in interface IForteSocket

Specified by:

incrementPosition in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

true if Position was successfully incremented, false otherwise

getNumDataValues

public int getNumDataValues()

Specified by:

getNumDataValues in interface IForteSocket

Specified by:

getNumDataValues in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Returns:

The number of data values that can be stored within this buffer.

setPosition

public void setPosition(int position)

Description copied from interface: IForteSocket

Sets the position. The position is limited to [-1, IForteSocket.getNumDataValues()]. -1 is the initialized state.

Specified by:

setPosition in interface IForteSocket

Specified by:

setPosition in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

setDateAndTimeReference

public void setDateAndTimeReference(DateAndTime dt)

Description copied from interface: IForteSocket

Sets a DateAndTime object as reference for any new DateAndTime objects received.

Specified by:

setDateAndTimeReference in interface IForteSocket

Specified by:

setDateAndTimeReference in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

disconnect

public void disconnect()
                throws java.io.IOException

Description copied from interface: IForteSocket

Closes the connection.

Specified by:

disconnect in interface IForteSocket

Specified by:

disconnect in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer

Throws:

java.io.IOException

getPosition

public int getPosition()

Returns mPosition If mPosition is in the initialized position of -1, this method returns 0.

Specified by:

getPosition in interface IForteSocket

Specified by:

getPosition in class de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer