Package com.beanit.dnp3bean

Class ReadRequest.Builder

java.lang.Object

com.beanit.dnp3bean.ReadRequest.Builder

Enclosing class:

ReadRequest

public static class ReadRequest.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
ReadRequest	build()	Build the read request.
ReadRequest.Builder	integrityPoll()	Read classes 0-3.
ReadRequest.Builder	readAll(Variation variation)	Read all data of the specified group variation using qualifier 0x06.
ReadRequest.Builder	readAllWithLimit(Variation variation, int limit)	Read all data of the specified group variation with the given limit/count using qualifiers 0x07 and 0x08.
ReadRequest.Builder	readIndexes(Variation variation, int... indexes)	Read one or more indexes using qualifiers 0x17 or 0x28.
ReadRequest.Builder	readIndexes(Variation variation, java.util.List<java.lang.Integer> indexes)	Read one or more indexes using qualifiers 0x17 or 0x28.
ReadRequest.Builder	readIndexless(Variation variation)	Read a single indexless data point using qualifier 0x07 and a specified limit/count of 1.
ReadRequest.Builder	readRange(Variation variation, int start, int stop)	Read the index range from start to stop (inclusive).

Methods inherited from class java.lang.Object

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

Method Detail

readAll

public ReadRequest.Builder readAll(Variation variation)

Read all data of the specified group variation using qualifier 0x06.

Parameters:

variation - the group variation to read

Returns:

this builder

readAllWithLimit

public ReadRequest.Builder readAllWithLimit(Variation variation,
                                            int limit)

Read all data of the specified group variation with the given limit/count using qualifiers 0x07 and 0x08. It denotes the maximum number of data points that the response may contain. Reading with limit has two main use cases:

• reading event groups where the amount of data returned is unknown.
• reading single data points that have no index, in this case the limit/count must be 1.

Parameters:

variation - the group variation to read

limit - the maximum number of data points a response shall contain

Returns:

this builder

readIndexless

public ReadRequest.Builder readIndexless(Variation variation)

Read a single indexless data point using qualifier 0x07 and a specified limit/count of 1. This method is equivalent to readAllWithLimit(Variation, int) with a limit/count of 1.

Parameters:

variation - the group variation to read

Returns:

this builder

readRange

public ReadRequest.Builder readRange(Variation variation,
                                     int start,
                                     int stop)

Read the index range from start to stop (inclusive). Single values can be read by specifying a range with start equal to stop. This request uses qualifiers 0x00 or 0x01.

Parameters:

variation - the group variation

start - the start index

stop - the stop index

Returns:

this builder

readIndexes

public ReadRequest.Builder readIndexes(Variation variation,
                                       java.util.List<java.lang.Integer> indexes)

Read one or more indexes using qualifiers 0x17 or 0x28.

Parameters:

variation - the group variation

indexes - the indexes

Returns:

this builder

readIndexes

public ReadRequest.Builder readIndexes(Variation variation,
                                       int... indexes)

Read one or more indexes using qualifiers 0x17 or 0x28.

Parameters:

variation - the group variation

indexes - the indexes

Returns:

this builder

integrityPoll

public ReadRequest.Builder integrityPoll()

Read classes 0-3. A shortcut to calling readAll(Variation) for all four classes.

Returns:

this builder

build

public ReadRequest build()

Build the read request.

Returns:

the read request