A B C D E F G H I J K L M N O P Q R S T U V W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- absValue() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- absValue() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- absValue() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- absValue() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- absValue() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- absValue() - Method in class com.smartgridready.communicator.common.api.values.Float32Value
- absValue() - Method in class com.smartgridready.communicator.common.api.values.Float64Value
- absValue() - Method in class com.smartgridready.communicator.common.api.values.Int16UValue
- absValue() - Method in class com.smartgridready.communicator.common.api.values.Int16Value
- absValue() - Method in class com.smartgridready.communicator.common.api.values.Int32UValue
- absValue() - Method in class com.smartgridready.communicator.common.api.values.Int32Value
- absValue() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- absValue() - Method in class com.smartgridready.communicator.common.api.values.Int64Value
- absValue() - Method in class com.smartgridready.communicator.common.api.values.Int8UValue
- absValue() - Method in class com.smartgridready.communicator.common.api.values.Int8Value
- absValue() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- absValue() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- absValue() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Sets the instance's value to its absolute value, if possible.
- add(int) - Method in class com.smartgridready.communicator.common.helper.JsonReader.Key
-
Adds an index to the key.
- add(Processor) - Method in class com.smartgridready.communicator.async.process.Parallel
-
Adds the process to an asynchronous task processor.
- add(Processor) - Method in class com.smartgridready.communicator.async.process.Sequence
-
Adds the process to an asynchronous task processor.
- addHeader(String, String) - Method in class com.smartgridready.communicator.rest.http.client.RestServiceClient
-
Adds a new request header.
- apply(String, String) - Method in interface com.smartgridready.communicator.async.callable.ReadFunction
-
Executes the function.
- apply(String, String, V) - Method in interface com.smartgridready.communicator.async.callable.WriteFunction
-
Executes the function.
- applyUnitConversion(P, Value, DoubleBinaryOperator) - Static method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
-
Performs conversion of units of measurements on a data point.
- ArrayValue<T extends Value> - Class in com.smartgridready.communicator.common.api.values
-
Implements an array wrapper around other kinds of SGr value.
- ArrayValue(T[]) - Constructor for class com.smartgridready.communicator.common.api.values.ArrayValue
-
Constructs a new instance.
- asArray() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- asArray() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- asArray() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- asArray() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- asArray() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- asArray() - Method in class com.smartgridready.communicator.common.api.values.Float32Value
- asArray() - Method in class com.smartgridready.communicator.common.api.values.Float64Value
- asArray() - Method in class com.smartgridready.communicator.common.api.values.Int16UValue
- asArray() - Method in class com.smartgridready.communicator.common.api.values.Int16Value
- asArray() - Method in class com.smartgridready.communicator.common.api.values.Int32UValue
- asArray() - Method in class com.smartgridready.communicator.common.api.values.Int32Value
- asArray() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- asArray() - Method in class com.smartgridready.communicator.common.api.values.Int64Value
- asArray() - Method in class com.smartgridready.communicator.common.api.values.Int8UValue
- asArray() - Method in class com.smartgridready.communicator.common.api.values.Int8Value
- asArray() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- asArray() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- asArray() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as array.
- AsyncResult<T> - Class in com.smartgridready.communicator.async.callable
-
Implements an asynchronous process result.
- AsyncResult() - Constructor for class com.smartgridready.communicator.async.callable.AsyncResult
-
Constructs a new instance.
- attachGateway(ModbusInterfaceDescription, GenDriverAPI4ModbusFactory, String) - Method in interface com.smartgridready.communicator.modbus.api.ModbusGatewayRegistry
-
Uses or creates a Modbus transport gateway for a given device.
- attachGateway(ModbusInterfaceDescription, GenDriverAPI4ModbusFactory, String) - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusGatewayRegistry
- authenticate() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Deprecated, for removal: This API element is subject to removal in a future version.Since version 2.1.0.
- authenticate() - Method in interface com.smartgridready.communicator.rest.api.GenDeviceApi4Rest
-
Deprecated, for removal: This API element is subject to removal in a future version.Since version 2.2.0
- authenticate() - Method in class com.smartgridready.communicator.rest.impl.SGrRestApiDevice
- Authenticator - Interface in com.smartgridready.communicator.rest.http.authentication
-
Defines the interface of an HTTP authenticator.
- AuthenticatorFactory - Class in com.smartgridready.communicator.rest.http.authentication
-
Implements a factory that creates HTTP authenticators.
- await(Executable...) - Method in class com.smartgridready.communicator.async.process.Processor
-
Prepares awaiting processes to be finished.
B
- BaseCallable<T> - Class in com.smartgridready.communicator.async.callable
-
Base class for callable methods on SGr devices.
- BaseCallable(String, String) - Constructor for class com.smartgridready.communicator.async.callable.BaseCallable
-
Constructs a new instance.
- BasicAuthenticator - Class in com.smartgridready.communicator.rest.http.authentication
-
Implements an HTTP authenticator for basic authentication.
- BearerTokenAuthenticator - Class in com.smartgridready.communicator.rest.http.authentication
-
Implements an HTTP authenticator using JWT bearer tokens.
- BITMAP - com.smartgridready.communicator.common.api.values.DataType
-
Bit map
- BitmapRecord - Class in com.smartgridready.communicator.common.api.values
-
Implements a custom bit map record.
- BitmapRecord(String, boolean, String) - Constructor for class com.smartgridready.communicator.common.api.values.BitmapRecord
-
Constructs a new instance.
- BitmapValue - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a bit map value.
- BOOLEAN - com.smartgridready.communicator.common.api.values.DataType
-
Boolean
- BooleanValue - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a boolean value.
- BrokerListMapper - Class in com.smartgridready.communicator.messaging.mapper
-
Implements a message broker list mapper.
- build() - Method in class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Builds the SGr device using the previously set builder parameters.
- buildJsonNode(Collection<Map<String, Object>>) - Method in class com.smartgridready.communicator.common.helper.JsonWriter
-
Builds a JSON node from a list of key-value pairs.
- buildJsonString(Collection<Map<String, Object>>) - Method in class com.smartgridready.communicator.common.helper.JsonWriter
-
Builds a JSON string from a list of key-value pairs.
- byteArrToBooleanArr(byte[]) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts a byte array to a boolean array.
- byteBufFromRegisters(int[]) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts Modbus registers to a byte buffer.
- bytesToRegisters(byte[]) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts a byte array to Modbus registers.
C
- CacheRecord<V> - Class in com.smartgridready.communicator.modbus.helper
-
Implements a generic cache record.
- CacheRecord(V, Instant) - Constructor for class com.smartgridready.communicator.modbus.helper.CacheRecord
-
Constructs a new instance.
- call() - Method in class com.smartgridready.communicator.async.callable.BaseCallable
- callService() - Method in class com.smartgridready.communicator.rest.http.client.RestServiceClient
-
Executes the HTTP request.
- canSubscribe() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Tells if the device interface supports subscribe/unsubscribe.
- canSubscribe() - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Checks whether the device can subscribe to data points.
- canSubscribe() - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
- canSubscribe() - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- changeByteOrder(int[], int) - Static method in class com.smartgridready.communicator.modbus.helper.EndiannessConversionHelper
-
Changes the byte order in registers.
- changeDWordOrder(int[], int) - Static method in class com.smartgridready.communicator.modbus.helper.EndiannessConversionHelper
-
Changes double-word order.
- changeWordOrder(int[], int) - Static method in class com.smartgridready.communicator.modbus.helper.EndiannessConversionHelper
-
Changes word order.
- checkOutOfRange(Value[], double, SGrDeviceBase.Comparator) - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
-
Checks if a value is beyond its valid range.
- checkOutOfRange(Value[], DataPointBase) - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
-
Tests an array of SGr values against upper and lower bounds of a given data point.
- checkReadWritePermission(DataPointBase, SGrDeviceBase.RwpDirections) - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
-
Tests a given data point's read or write permissions.
- cleanup() - Method in class com.smartgridready.communicator.async.process.ReadExec
-
Cleans up disposable resources.
- cleanup() - Method in class com.smartgridready.communicator.async.process.WriteExec
-
Cleans up disposable resources.
- close() - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- CLOUD - com.smartgridready.communicator.common.api.dto.OperationEnvironment
-
Remote environment like cloud.
- com.smartgridready.communicator.async.callable - package com.smartgridready.communicator.async.callable
- com.smartgridready.communicator.async.process - package com.smartgridready.communicator.async.process
- com.smartgridready.communicator.common.api - package com.smartgridready.communicator.common.api
- com.smartgridready.communicator.common.api.dto - package com.smartgridready.communicator.common.api.dto
- com.smartgridready.communicator.common.api.values - package com.smartgridready.communicator.common.api.values
- com.smartgridready.communicator.common.helper - package com.smartgridready.communicator.common.helper
- com.smartgridready.communicator.common.impl - package com.smartgridready.communicator.common.impl
- com.smartgridready.communicator.contacts.impl - package com.smartgridready.communicator.contacts.impl
- com.smartgridready.communicator.generic.impl - package com.smartgridready.communicator.generic.impl
- com.smartgridready.communicator.messaging.api - package com.smartgridready.communicator.messaging.api
- com.smartgridready.communicator.messaging.impl - package com.smartgridready.communicator.messaging.impl
- com.smartgridready.communicator.messaging.mapper - package com.smartgridready.communicator.messaging.mapper
- com.smartgridready.communicator.modbus.api - package com.smartgridready.communicator.modbus.api
- com.smartgridready.communicator.modbus.helper - package com.smartgridready.communicator.modbus.helper
- com.smartgridready.communicator.modbus.impl - package com.smartgridready.communicator.modbus.impl
- com.smartgridready.communicator.rest.api - package com.smartgridready.communicator.rest.api
- com.smartgridready.communicator.rest.exception - package com.smartgridready.communicator.rest.exception
- com.smartgridready.communicator.rest.http.authentication - package com.smartgridready.communicator.rest.http.authentication
- com.smartgridready.communicator.rest.http.client - package com.smartgridready.communicator.rest.http.client
- com.smartgridready.communicator.rest.impl - package com.smartgridready.communicator.rest.impl
- com.smartgridready.utils - package com.smartgridready.utils
- compareTo(JsonReader.Key) - Method in class com.smartgridready.communicator.common.helper.JsonReader.Key
- ConfigurationValue - Class in com.smartgridready.communicator.common.api.dto
-
Implements an EID configuration parameters.
- ConfigurationValue(String, Value, DataTypeInfo, Map<Language, String>) - Constructor for class com.smartgridready.communicator.common.api.dto.ConfigurationValue
-
Constructs a new instance.
- connect() - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Connect the device.
- connect() - Method in class com.smartgridready.communicator.contacts.impl.SGrContactsDevice
- connect() - Method in class com.smartgridready.communicator.generic.impl.SGrGenericDevice
- connect() - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- connect() - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusDevice
- connect() - Method in class com.smartgridready.communicator.rest.impl.SGrRestApiDevice
- connect(String) - Method in class com.smartgridready.communicator.modbus.api.ModbusGateway
-
Connects a specific device.
- CONST - com.smartgridready.communicator.common.impl.SGrDeviceBase.RwpDirections
-
Data point is constant.
- CONTACT - com.smartgridready.communicator.common.api.dto.InterfaceType
-
Digital contacts
- ConversionHelper - Class in com.smartgridready.communicator.modbus.helper
-
A helper class for value conversion.
- convertNodeToString(Node) - Static method in class com.smartgridready.communicator.common.helper.XPathHelper
-
Converts a DOM node to a string.
- convertXmlToDocument(String) - Static method in class com.smartgridready.communicator.common.helper.XPathHelper
-
Loads an XML string into a document
- convRegistersToString(int[], int, int) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts 16 - Bit Register values to String
- convStringToRegisters(String) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts a String to 16 - Bit Registers
- copy(JsonReader.Key) - Static method in class com.smartgridready.communicator.common.helper.JsonReader.Key
-
Clones the instance.
- createTransport(ModbusInterfaceDescription, GenDriverAPI4ModbusFactory) - Static method in class com.smartgridready.communicator.modbus.helper.ModbusTransportUtil
-
Creates a new tranport.
D
- DataPoint - Class in com.smartgridready.communicator.common.api.dto
-
Implements a generic data point facade.
- DataPoint(String, String, DataTypeInfo, Units, DataDirectionProduct, Double, Double, Integer, List<GenericAttribute>, List<DynamicRequestParameter>, GenDeviceApi) - Constructor for class com.smartgridready.communicator.common.api.dto.DataPoint
-
Constructs a data point.
- dataPointName - Variable in class com.smartgridready.communicator.async.callable.BaseCallable
-
The data point name.
- DataPointValue - Class in com.smartgridready.communicator.common.api.dto
-
Implements a data point value with functional profile and data points names.
- DataPointValue(String, String, Value) - Constructor for class com.smartgridready.communicator.common.api.dto.DataPointValue
-
Constructs a data point value.
- DataType - Enum in com.smartgridready.communicator.common.api.values
-
Defines enumerations of data types supported by SGr data points.
- DataTypeInfo - Class in com.smartgridready.communicator.common.api.values
-
Defines extended information for SGr data types.
- DataTypeInfo(DataType, Function<DataTypeProduct, Object>, Function<ModbusDataType, Object>, BiConsumer<DataTypeProduct, EmptyType>, BiConsumer<ModbusDataType, EmptyType>, List<Value>) - Constructor for class com.smartgridready.communicator.common.api.values.DataTypeInfo
-
Constructs a new instance.
- DATE_TIME - com.smartgridready.communicator.common.api.values.DataType
-
Time stamp
- DateTimeValue - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a date/time value.
- DEFAULT_BAUDRATE - Static variable in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Default baud rate.
- DEFAULT_DATABITS - Static variable in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Default data bits.
- DEFAULT_MODBUS_TCP_PORT - Static variable in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Default TCP port.
- DEFAULT_MODBUS_TCP_TIMEOUT - Static variable in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Default connection timeout in milliseconds.
- DEFAULT_PARITY - Static variable in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Default parity.
- DEFAULT_SLAVE_ID - Static variable in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Default slave ID.
- DEFAULT_STOPBITS - Static variable in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Default stop bits.
- defaultInstance() - Static method in class com.smartgridready.communicator.modbus.impl.SGrModbusGatewayRegistry
-
Gets the default singleton instance of the Modbus gateway registry.
- detachAllGateways() - Method in interface com.smartgridready.communicator.modbus.api.ModbusGatewayRegistry
-
Disconnects all Modbus transport gateways.
- detachAllGateways() - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusGatewayRegistry
- detachGateway(ModbusInterfaceDescription, String) - Method in interface com.smartgridready.communicator.modbus.api.ModbusGatewayRegistry
-
Disconnects the Modbus transport gateway of a given device.
- detachGateway(ModbusInterfaceDescription, String) - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusGatewayRegistry
- detachGateway(String, String) - Method in interface com.smartgridready.communicator.modbus.api.ModbusGatewayRegistry
-
Disconnects the Modbus transport gateway of a given device.
- detachGateway(String, String) - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusGatewayRegistry
- device - Variable in class com.smartgridready.communicator.common.impl.SGrDeviceBase
-
The interface-specific device specification.
- DeviceDescriptionLoader - Class in com.smartgridready.communicator.common.helper
-
Implements a loader that deserializes EI-XML into device descriptions.
- DeviceDescriptionLoader() - Constructor for class com.smartgridready.communicator.common.helper.DeviceDescriptionLoader
-
Constructs a new instance.
- DeviceInfo - Class in com.smartgridready.communicator.common.api.dto
-
Implements a generic device information facade.
- DeviceInfo(String, String, String, String, String, DeviceCategory, InterfaceType, OperationEnvironment, List<GenericAttribute>, List<ConfigurationValue>, List<FunctionalProfile>) - Constructor for class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Constructs a new instance.
- DeviceReadCallable<T> - Class in com.smartgridready.communicator.async.callable
-
Callable that wraps a device read command.
- DeviceReadCallable(ReadFunction<T>, String, String) - Constructor for class com.smartgridready.communicator.async.callable.DeviceReadCallable
-
Constructs a new instance.
- DeviceWriteCallable<T> - Class in com.smartgridready.communicator.async.callable
-
Callable that wraps a device write command.
- DeviceWriteCallable(WriteFunction<T>, String, String) - Constructor for class com.smartgridready.communicator.async.callable.DeviceWriteCallable
-
Constructs a new instance.
- disconnect() - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Disconnect the device.
- disconnect() - Method in class com.smartgridready.communicator.contacts.impl.SGrContactsDevice
- disconnect() - Method in class com.smartgridready.communicator.generic.impl.SGrGenericDevice
- disconnect() - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- disconnect() - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusDevice
- disconnect() - Method in class com.smartgridready.communicator.rest.impl.SGrRestApiDevice
- disconnect(String) - Method in class com.smartgridready.communicator.modbus.api.ModbusGateway
-
Disconnects a specific device.
- disconnectAll() - Method in class com.smartgridready.communicator.modbus.api.ModbusGateway
-
Disconnect all devices.
- divide(double, double) - Static method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
-
Divides two numbers.
- doFunctionCall() - Method in class com.smartgridready.communicator.async.callable.DeviceReadCallable
- doFunctionCall() - Method in class com.smartgridready.communicator.async.callable.DeviceWriteCallable
- doubleToRegisters(double) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts a double value to four Modbus registers.
- DriverFactoryLoader - Class in com.smartgridready.communicator.common.helper
-
Implements a driver factory loader.
- DummyHttpAuthenticator - Class in com.smartgridready.communicator.rest.http.authentication
-
Dummy implementation of an HTTP authenticator.
- DummyHttpAuthenticator() - Constructor for class com.smartgridready.communicator.rest.http.authentication.DummyHttpAuthenticator
-
Constructs a new instance.
- DynamicRequestParameter - Class in com.smartgridready.communicator.common.api.dto
-
Implements a dynamic request parameter.
- DynamicRequestParameter(String, String, DataTypeInfo, Map<Language, InfoText>) - Constructor for class com.smartgridready.communicator.common.api.dto.DynamicRequestParameter
-
Constructs a new instance.
E
- eid(DeviceFrame) - Method in class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Sets the EID source to a pre-loaded
DeviceFrame. - eid(InputStream) - Method in class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Sets the EID source to an input stream.
- eid(String) - Method in class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Sets the EID source to XML content.
- eid(Path) - Method in class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Sets the EID source to a file system path.
- EndiannessConversionHelper - Class in com.smartgridready.communicator.modbus.helper
-
A helper class for conversion of endianness.
- ENUM - com.smartgridready.communicator.common.api.values.DataType
-
Discrete enumeration
- EnumRecord - Class in com.smartgridready.communicator.common.api.values
-
Implements a custom enumeration record.
- EnumRecord(String, Long, String) - Constructor for class com.smartgridready.communicator.common.api.values.EnumRecord
-
Constructs a new instance.
- enumToOrdinalValue(EnumMapProduct) - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- enumToOrdinalValue(EnumMapProduct) - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the ordinal value of an enumeration.
- EnumValue - Class in com.smartgridready.communicator.common.api.values
-
Implements a SGr enumeration value.
- equals(Object) - Method in class com.smartgridready.communicator.common.api.dto.GenericAttribute
- equals(Object) - Method in class com.smartgridready.communicator.common.api.values.BitmapRecord
- equals(Object) - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- equals(Object) - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- equals(Object) - Method in class com.smartgridready.communicator.common.api.values.DataTypeInfo
- equals(Object) - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- equals(Object) - Method in class com.smartgridready.communicator.common.api.values.EnumRecord
- equals(Object) - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- equals(Object) - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- equals(Object) - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- equals(Object) - Method in class com.smartgridready.communicator.common.api.values.StringValue
- equals(Object) - Method in class com.smartgridready.communicator.common.helper.JsonReader.Key
- equals(Object) - Method in class com.smartgridready.communicator.messaging.impl.MessageCacheKey
- equals(Object) - Method in class com.smartgridready.communicator.modbus.api.ModbusGateway
- ERROR - com.smartgridready.communicator.async.process.ExecStatus
-
Completed with error.
- ExecStatus - Enum in com.smartgridready.communicator.async.process
-
Defines execution states of an asynchronous process.
- Executable - Interface in com.smartgridready.communicator.async.process
-
Defines the interface of an asynchronous process.
F
- findDataPoint(String, String) - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
-
Finds a data point by functional profile and data point name.
- findDataPointForProfile(ContactFunctionalProfile, String) - Method in class com.smartgridready.communicator.contacts.impl.SGrContactsDevice
- findDataPointForProfile(GenericFunctionalProfile, String) - Method in class com.smartgridready.communicator.generic.impl.SGrGenericDevice
- findDataPointForProfile(MessagingFunctionalProfile, String) - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- findDataPointForProfile(ModbusFunctionalProfile, String) - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusDevice
- findDataPointForProfile(RestApiFunctionalProfile, String) - Method in class com.smartgridready.communicator.rest.impl.SGrRestApiDevice
-
Finds a data point.
- findDataPointForProfile(F, String) - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
-
Finds a data point of a given functional profile by name.
- findProfile(String) - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
-
Finds a functional profile by name.
- findProfile(String) - Method in class com.smartgridready.communicator.contacts.impl.SGrContactsDevice
- findProfile(String) - Method in class com.smartgridready.communicator.generic.impl.SGrGenericDevice
- findProfile(String) - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- findProfile(String) - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusDevice
- findProfile(String) - Method in class com.smartgridready.communicator.rest.impl.SGrRestApiDevice
-
Finds a functional profile.
- FLOAT32 - com.smartgridready.communicator.common.api.values.DataType
-
32-bit floating-point
- Float32Value - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a 32-bit floating point value.
- FLOAT64 - com.smartgridready.communicator.common.api.values.DataType
-
64-bit floating-point
- Float64Value - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a 64-bit floating point value.
- floatToRegisters(float) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts a float value to two Modbus registers.
- fromDiscreteInput(ModbusDataType, boolean[]) - Static method in class com.smartgridready.communicator.common.api.values.Value
-
Gets a value from a Modbus discrete input.
- fromModbusRegister(ModbusDataType, int[]) - Static method in class com.smartgridready.communicator.common.api.values.Value
-
Converts a list of Modbus registers to a given value.
- fromString(DataTypeProduct, String) - Static method in class com.smartgridready.communicator.common.api.values.Value
-
Converts a string to a different to a
Value. - FunctionalProfile - Class in com.smartgridready.communicator.common.api.dto
-
Implements a generic functional profile facade.
- FunctionalProfile(String, String, FunctionalProfileCategory, List<GenericAttribute>, List<DataPoint>) - Constructor for class com.smartgridready.communicator.common.api.dto.FunctionalProfile
-
Constructs a new instance.
G
- GenDeviceApi - Interface in com.smartgridready.communicator.common.api
-
Defines the generic API supported by all SGr device types.
- GenDeviceApi4Messaging - Interface in com.smartgridready.communicator.messaging.api
-
Defines the interface of a message-based device communication interface.
- GenDeviceApi4Modbus - Interface in com.smartgridready.communicator.modbus.api
-
The API defines read and write operations for SmartGridReady devices.
- GenDeviceApi4Rest - Interface in com.smartgridready.communicator.rest.api
-
Defines the communication interface API for HTTP/REST devices.
- GENERIC - com.smartgridready.communicator.common.api.dto.InterfaceType
-
Generic
- GenericAttribute - Class in com.smartgridready.communicator.common.api.dto
-
Implements a generic attribute facade.
- GenericAttribute(String, Value, DataTypeInfo, Units, List<GenericAttribute>) - Constructor for class com.smartgridready.communicator.common.api.dto.GenericAttribute
-
Construct a new instance.
- getAllContactsDrivers() - Static method in class com.smartgridready.communicator.common.helper.DriverFactoryLoader
-
Gets all implementations of contacts driver factories.
- getAllGatewayIdentifiers() - Method in interface com.smartgridready.communicator.modbus.api.ModbusGatewayRegistry
-
Gets all transport identifiers.
- getAllGatewayIdentifiers() - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusGatewayRegistry
- getAllMessagingDrivers() - Static method in class com.smartgridready.communicator.common.helper.DriverFactoryLoader
-
Gets all implementations of messaging driver factories.
- getAllModbusDrivers() - Static method in class com.smartgridready.communicator.common.helper.DriverFactoryLoader
-
Gets all implementations of Modbus driver factories.
- getAllRestApiDrivers() - Static method in class com.smartgridready.communicator.common.helper.DriverFactoryLoader
-
Gets all implementations of HTTP / REST driver factories.
- getArrayLen() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Gets the number of array elements of the data point value.
- getAuthenticator(RestApiAuthenticationMethod) - Static method in class com.smartgridready.communicator.rest.http.authentication.AuthenticatorFactory
-
Creates a new HTTP authenticator using reflection.
- getAuthorizationHeaderValue(DeviceFrame, GenHttpClientFactory) - Method in interface com.smartgridready.communicator.rest.http.authentication.Authenticator
-
Retrieves the value of the authorization header of HTTP requests.
- getAuthorizationHeaderValue(DeviceFrame, GenHttpClientFactory) - Method in class com.smartgridready.communicator.rest.http.authentication.BasicAuthenticator
- getAuthorizationHeaderValue(DeviceFrame, GenHttpClientFactory) - Method in class com.smartgridready.communicator.rest.http.authentication.BearerTokenAuthenticator
- getAuthorizationHeaderValue(DeviceFrame, GenHttpClientFactory) - Method in class com.smartgridready.communicator.rest.http.authentication.DummyHttpAuthenticator
- getBaseUri() - Method in class com.smartgridready.communicator.rest.http.client.RestServiceClient
-
Gets the request's base URI.
- getBitmap() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getBitmap() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getBitmap() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getBitmap() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getBitmap() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getBitmap() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getBitmap() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getBitmap() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getBitmap() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getBitmap() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as SGr bitmap.
- getBoolean() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getBoolean() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getBoolean() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getBoolean() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getBoolean() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getBoolean() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getBoolean() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getBoolean() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getBoolean() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getBoolean() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as boolean.
- getCategory() - Method in class com.smartgridready.communicator.common.api.dto.FunctionalProfile
-
Gets the functional profile category.
- getChildren() - Method in class com.smartgridready.communicator.common.api.dto.GenericAttribute
-
Gets the attribute's sub-attributes.
- getConfigurationInfo() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Gets the configuration parameters.
- getContactsDriver() - Static method in class com.smartgridready.communicator.common.helper.DriverFactoryLoader
-
Gets the primary contacts driver factory.
- getDataPoint(String, String) - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Get a data point
- getDataPoint(String, String) - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
- getDataPointName() - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Gets the data point name.
- getDataPointName() - Method in class com.smartgridready.communicator.async.callable.BaseCallable
-
Gets the functional profile name.
- getDataPointName() - Method in class com.smartgridready.communicator.common.api.dto.DataPointValue
-
Gets the data point name.
- getDataPoints() - Method in class com.smartgridready.communicator.common.api.dto.FunctionalProfile
-
Gets the data points.
- getDataPoints(String) - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Get all data points of a functional profile
- getDataPoints(String) - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
- getDataType() - Method in class com.smartgridready.communicator.common.api.dto.ConfigurationValue
-
Gets the parameter's data type.
- getDataType() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Gets the data type.
- getDataType() - Method in class com.smartgridready.communicator.common.api.dto.DynamicRequestParameter
-
Gets the parameter's data type.
- getDataType() - Method in class com.smartgridready.communicator.common.api.dto.GenericAttribute
-
Gets the value's data type.
- getDataTypeInfo(DataType) - Static method in enum com.smartgridready.communicator.common.api.values.DataType
-
Gets additional information from a data type enumeration.
- getDataTypeInfo(DataTypeProduct) - Static method in enum com.smartgridready.communicator.common.api.values.DataType
-
Gets additional information from a data type specification.
- getDataTypeInfo(ModbusDataType) - Static method in enum com.smartgridready.communicator.common.api.values.DataType
-
Gets additional information from a Modbus data type specification.
- getDateTime() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getDateTime() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getDateTime() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getDateTime() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getDateTime() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getDateTime() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getDateTime() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getDateTime() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getDateTime() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getDateTime() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as time stamp.
- getDefaultValue() - Method in class com.smartgridready.communicator.common.api.dto.ConfigurationValue
-
Gets the parameter's default value.
- getDefaultValue() - Method in class com.smartgridready.communicator.common.api.dto.DynamicRequestParameter
-
Gets the parameter's default value.
- getDescription() - Method in class com.smartgridready.communicator.common.api.dto.InfoText
-
Gets the descriptive text.
- getDescription() - Method in class com.smartgridready.communicator.common.api.values.BitmapRecord
-
Gets the record description.
- getDescription() - Method in class com.smartgridready.communicator.common.api.values.EnumRecord
-
Gets the record description.
- getDescriptions() - Method in class com.smartgridready.communicator.common.api.dto.ConfigurationValue
-
Gets the text descriptions.
- getDescriptions() - Method in class com.smartgridready.communicator.common.api.dto.DynamicRequestParameter
-
Gets the text descriptions.
- getDeviceCategory() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Gets the device category, defined by XML schema.
- getDeviceConfigurationInfo() - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Get the device interface configuration parameters
- getDeviceConfigurationInfo() - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
- getDeviceInfo() - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Get device information
- getDeviceInfo() - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
- getDynamicRequestParameters() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Gets the available dynamic request parameters that need to be provided as
Propertieswhen calling the methodGenDeviceApi.getVal(String, String, Properties). - getEnum() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getEnum() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getEnum() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getEnum() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getEnum() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getEnum() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getEnum() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getEnum() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getEnum() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getEnum() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as SGr enumeration record.
- getExecStatus() - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Gets the process status.
- getExecStatus() - Method in interface com.smartgridready.communicator.async.process.Executable
-
Gets the execution status.
- getExecStatus() - Method in class com.smartgridready.communicator.async.process.ReadExec
-
Gets the execution status.
- getExecStatus() - Method in class com.smartgridready.communicator.async.process.WriteExec
-
Gets the execution status.
- getExecThrowable() - Method in class com.smartgridready.communicator.async.process.ReadExec
-
Gets the exception that was thrown.
- getExecThrowable() - Method in class com.smartgridready.communicator.async.process.WriteExec
-
Gets the exception that was thrown.
- getFloat32() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getFloat32() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getFloat32() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getFloat32() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getFloat32() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getFloat32() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getFloat32() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getFloat32() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getFloat32() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getFloat32() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as 32-bit floating-point.
- getFloat64() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getFloat64() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getFloat64() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getFloat64() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getFloat64() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getFloat64() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getFloat64() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getFloat64() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getFloat64() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getFloat64() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as 64-bit floating-point.
- getFunctionalProfile(String) - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Get a functional profile
- getFunctionalProfile(String) - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
- getFunctionalProfileName() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Gets the functional profile name.
- getFunctionalProfileName() - Method in class com.smartgridready.communicator.common.api.dto.DataPointValue
-
Gets the functional profile name.
- getFunctionalProfiles() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Gets the functional profiles.
- getFunctionalProfiles() - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Get all functional profiles
- getFunctionalProfiles() - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
- getGenDataTypeName(DataTypeProduct) - Static method in enum com.smartgridready.communicator.common.api.values.DataType
-
Gets the name of a data type specification.
- getGenericAttributes() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Gets the generic attributes of the data point.
- getGenericAttributes() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Gets the generic attributes at device-level.
- getGenericAttributes() - Method in class com.smartgridready.communicator.common.api.dto.FunctionalProfile
-
Gets the generic attributes.
- getGetGenValMethod() - Method in class com.smartgridready.communicator.common.api.values.DataTypeInfo
-
Gets the function that gets the correct data type from specification.
- getGetModbusValMethod() - Method in class com.smartgridready.communicator.common.api.values.DataTypeInfo
-
Gets the function that gets the correct Modbus data type from specification.
- getHardwareVersion() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Gets the device hardware version compatible with the EID.
- getHwRevision() - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Gets the product hardware version.
- getIdentifier() - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Gets the EID identifier.
- getIdentifier() - Method in class com.smartgridready.communicator.modbus.api.ModbusGateway
-
Gets the unique identifier.
- getInt16() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getInt16() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getInt16() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getInt16() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getInt16() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getInt16() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getInt16() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getInt16() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getInt16() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getInt16() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as 16-bit integer.
- getInt16U() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getInt16U() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getInt16U() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getInt16U() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getInt16U() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getInt16U() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getInt16U() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getInt16U() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getInt16U() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getInt16U() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as unsigned 16-bit integer.
- getInt32() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getInt32() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getInt32() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getInt32() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getInt32() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getInt32() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getInt32() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getInt32() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getInt32() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getInt32() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as 32-bit integer.
- getInt32U() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getInt32U() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getInt32U() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getInt32U() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getInt32U() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getInt32U() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getInt32U() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getInt32U() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getInt32U() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getInt32U() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as unsigned 32-bit integer.
- getInt64() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getInt64() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getInt64() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getInt64() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getInt64() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getInt64() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getInt64() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getInt64() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getInt64() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getInt64() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as 64-bit integer.
- getInt64U() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getInt64U() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getInt64U() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getInt64U() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getInt64U() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getInt64U() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getInt64U() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getInt64U() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getInt64U() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getInt64U() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as unsigned 64-bit integer.
- getInt8() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getInt8() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getInt8() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getInt8() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getInt8() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getInt8() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getInt8() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getInt8() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getInt8() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getInt8() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as 8-bit integer.
- getInt8U() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getInt8U() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getInt8U() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getInt8U() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getInt8U() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getInt8U() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getInt8U() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getInt8U() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getInt8U() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getInt8U() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as unsigned 8-bit integer.
- getInterface() - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Gets the communication interface type.
- getInterfaceDescription() - Method in class com.smartgridready.communicator.modbus.api.ModbusGateway
-
Gets the interface specification.
- getInterfaceType() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Gets the type of communication interface.
- getJson() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getJson() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getJson() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getJson() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getJson() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getJson() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getJson() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getJson() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getJson() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getJson() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as JSON.
- getJson(Class<T>) - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getJson(Class<T>) - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as JSON and converts to an instance of a given class.
- getLabel() - Method in class com.smartgridready.communicator.common.api.dto.InfoText
-
Gets the label text.
- getLastAccess() - Method in class com.smartgridready.communicator.messaging.impl.MessageCacheRecord
-
Gets the access timestamp.
- getLevel() - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Gets the SGr level.
- getLiteral() - Method in class com.smartgridready.communicator.common.api.values.BitmapRecord
-
Gets the map key name.
- getLiteral() - Method in class com.smartgridready.communicator.common.api.values.EnumRecord
-
Gets the text literal.
- getManufacturer() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Gets the device manufacturer name.
- getManufacturer() - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Gets the manufacturer name.
- getMaximumValue() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Gets the maximal allowed data point value for
setVal(). - getMbbitresp() - Method in class com.smartgridready.communicator.modbus.helper.ModbusReaderResponse
-
Gets all discrete inputs a boolean array.
- getMbbitresp(int, int) - Method in class com.smartgridready.communicator.modbus.helper.ModbusReaderResponse
-
Gets some discrete inputs a boolean array.
- getMbregresp() - Method in class com.smartgridready.communicator.modbus.helper.ModbusReaderResponse
-
Gets all register values as array of int.
- getMbregresp(int, int) - Method in class com.smartgridready.communicator.modbus.helper.ModbusReaderResponse
-
Gets some register values as array of int.
- getMessageFilter() - Method in class com.smartgridready.communicator.messaging.impl.MessageCacheKey
-
Gets the message filter.
- getMessagingDriver(MessagingPlatformType) - Static method in class com.smartgridready.communicator.common.helper.DriverFactoryLoader
-
Gets the primary messaging driver factory.
- getMinimumValue() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Gets the maximal allowed data point value for
setVal(). - getModbusDataTypeName(ModbusDataType) - Static method in enum com.smartgridready.communicator.common.api.values.DataType
-
Gets the name of a Modbus data type specification.
- getModbusDriver() - Static method in class com.smartgridready.communicator.common.helper.DriverFactoryLoader
-
Gets the primary Modbus driver factory.
- getModbusGatewayIdentifier(ModbusInterfaceDescription) - Static method in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Gets the unique gateway identifier of a Modbus device.
- getModbusSlaveId(ModbusInterfaceDescription) - Static method in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Gets the Modbus device slave ID.
- getModbusType(ModbusInterfaceDescription) - Static method in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Gets the Modbus interface type.
- getName() - Method in class com.smartgridready.communicator.common.api.dto.ConfigurationValue
-
Gets the parameter name.
- getName() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Gets the data point name.
- getName() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Gets the device name.
- getName() - Method in class com.smartgridready.communicator.common.api.dto.DynamicRequestParameter
-
Gets the parameter name.
- getName() - Method in class com.smartgridready.communicator.common.api.dto.FunctionalProfile
-
Gets the functional profile name.
- getName() - Method in class com.smartgridready.communicator.common.api.dto.GenericAttribute
-
Gets the attribute name.
- getOperationEnvironment() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Gets the device's operation environment.
- getOrdinal() - Method in class com.smartgridready.communicator.common.api.values.EnumRecord
-
Gets the numeric ordinal.
- getOrEmpty(String) - Static method in class com.smartgridready.utils.StringUtil
-
Gets a string or an empty string if the given string is null.
- getPermissions() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Gets the read-write permissions of the data point.
- getProductEidXml(String) - Method in class com.smartgridready.communicator.common.api.SGrDeclarationLibrary
-
Gets product EI-XML data.
- getProductInfo(String) - Method in class com.smartgridready.communicator.common.api.SGrDeclarationLibrary
-
Gets information about a product EID.
- getProductName() - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Gets the product name.
- getProductType() - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Gets the product type.
- getProfileName() - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Gets the functional profile name.
- getProfileName() - Method in class com.smartgridready.communicator.async.callable.BaseCallable
-
Gets the functional profile name.
- getProfileType() - Method in class com.smartgridready.communicator.common.api.dto.FunctionalProfile
-
Gets the functional profile type.
- getRange() - Method in class com.smartgridready.communicator.common.api.values.DataTypeInfo
-
Gets the range of allowed values.
- getReadValue() - Method in class com.smartgridready.communicator.async.process.ReadExec
-
Gets the value of the read result.
- getReleaseState() - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Gets the release state.
- getRequestTime() - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Gets the time stamp of sending the request.
- getRequestTime() - Method in class com.smartgridready.communicator.async.process.ReadExec
-
Gets the time stamp of sending the request.
- getRequestTime() - Method in class com.smartgridready.communicator.async.process.WriteExec
-
Gets the time stamp of sending the request.
- getResponseTime() - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Gets the time stamp of getting the response.
- getResponseTime() - Method in class com.smartgridready.communicator.async.process.ReadExec
-
Gets the time stamp of receiving the response.
- getResponseTime() - Method in class com.smartgridready.communicator.async.process.WriteExec
-
Gets the time stamp of receiving the response.
- getRestApiDriver() - Static method in class com.smartgridready.communicator.common.helper.DriverFactoryLoader
-
Gets the primary HTTP / REST driver factory.
- getRestServiceCall() - Method in class com.smartgridready.communicator.rest.http.client.RestServiceClient
-
Gets the SGr specification of the service call.
- getResult() - Method in class com.smartgridready.communicator.async.callable.BaseCallable
-
Gets the process result.
- getResult() - Method in interface com.smartgridready.communicator.async.process.Executable
-
Gets the process result.
- getResult() - Method in class com.smartgridready.communicator.async.process.ReadExec
- getResult() - Method in class com.smartgridready.communicator.async.process.WriteExec
- getSerialBaudrate(String) - Static method in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Gets the serial baud rate.
- getSerialDataBits(String) - Static method in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Gets the data bits configuration.
- getSerialParity(String) - Static method in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Gets the parity configuration.
- getSerialStopBits(String) - Static method in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Gets the stop bits configuration.
- getSetGenValMethod() - Method in class com.smartgridready.communicator.common.api.values.DataTypeInfo
-
Gets the function that sets the correct data type in specification.
- getSetModbusValMethod() - Method in class com.smartgridready.communicator.common.api.values.DataTypeInfo
-
Gets the function that sets the correct Modbus data type in specification.
- getSoftwareVersion() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Gets the device software version compatible with the EID.
- getString() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- getString() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- getString() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- getString() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- getString() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- getString() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- getString() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- getString() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- getString() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- getString() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Gets the value as string.
- getSwRevision() - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Gets the product software version.
- getTestState() - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Gets the test state.
- getThrowable() - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Gets the exception that was thrown.
- getTopic() - Method in class com.smartgridready.communicator.messaging.impl.MessageCacheKey
-
Gets the message topic.
- getTransport() - Method in class com.smartgridready.communicator.modbus.api.ModbusGateway
-
Gets the wrapped driver instance.
- getType() - Method in class com.smartgridready.communicator.common.api.values.DataTypeInfo
-
Gets the data type enumeration.
- getTypeName() - Method in class com.smartgridready.communicator.common.api.values.DataTypeInfo
-
Gets the data type name.
- getUnit() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Gets the unit of measurement.
- getUnit() - Method in class com.smartgridready.communicator.common.api.dto.GenericAttribute
-
Gets the value's unit of measurement.
- getVal() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Read the value from this data point.
- getVal(long) - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Gets a value from the device by reading.
- getVal(String, String) - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Get a value for a given data point
- getVal(String, String) - Method in class com.smartgridready.communicator.contacts.impl.SGrContactsDevice
- getVal(String, String) - Method in class com.smartgridready.communicator.generic.impl.SGrGenericDevice
- getVal(String, String) - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- getVal(String, String) - Method in interface com.smartgridready.communicator.modbus.api.GenDeviceApi4Modbus
-
Read a value from the modbus device in its generic data point representation (see
Value). - getVal(String, String) - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusDevice
- getVal(String, String) - Method in interface com.smartgridready.communicator.rest.api.GenDeviceApi4Rest
-
Reads a value in its string representation from the REST API device.
- getVal(String, String) - Method in class com.smartgridready.communicator.rest.impl.SGrRestApiDevice
- getVal(String, String, long) - Method in interface com.smartgridready.communicator.messaging.api.GenDeviceApi4Messaging
-
Gets a value from the device by reading
- getVal(String, String, long) - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- getVal(String, String, Properties) - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Get a value for a given data point, with request-specific parameters
- getVal(String, String, Properties) - Method in class com.smartgridready.communicator.contacts.impl.SGrContactsDevice
- getVal(String, String, Properties) - Method in class com.smartgridready.communicator.generic.impl.SGrGenericDevice
- getVal(String, String, Properties) - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- getVal(String, String, Properties) - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusDevice
- getVal(String, String, Properties) - Method in interface com.smartgridready.communicator.rest.api.GenDeviceApi4Rest
-
Reads a value in its string representation from the REST API device.
- getVal(String, String, Properties) - Method in class com.smartgridready.communicator.rest.impl.SGrRestApiDevice
- getVal(String, String, Properties, long) - Method in interface com.smartgridready.communicator.messaging.api.GenDeviceApi4Messaging
-
Gets a value from the device by reading
- getVal(String, String, Properties, long) - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- getVal(Properties) - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Read the value from this data point, with request-specific parameters.
- getVal(Properties, long) - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Gets a value from the device by reading.
- getValue() - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Gets the result value.
- getValue() - Method in class com.smartgridready.communicator.common.api.dto.DataPointValue
-
Gets the data point value.
- getValue() - Method in class com.smartgridready.communicator.common.api.dto.GenericAttribute
-
Gets the attribute value.
- getValue() - Method in class com.smartgridready.communicator.common.api.values.BitmapRecord
-
Gets the bit value.
- getValue() - Method in class com.smartgridready.communicator.messaging.impl.MessageCacheRecord
-
Gets the cached value.
- getValue() - Method in class com.smartgridready.communicator.modbus.helper.CacheRecord
-
Gets the cached value.
- getValues() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Reads all data point values from device.
- getValues() - Method in class com.smartgridready.communicator.common.api.dto.FunctionalProfile
-
Reads all data point values from device.
- getValues() - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Get value of all data points in one go
- getValues() - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
- getVersion() - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Gets the EID version.
- getVersionNumber() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Gets the EID version number.
H
- handleError(Throwable) - Method in class com.smartgridready.communicator.async.process.ReadExec
-
Handles an error.
- handleSuccess(AsyncResult<R>) - Method in class com.smartgridready.communicator.async.process.ReadExec
-
Handles a finished process.
- hashCode() - Method in class com.smartgridready.communicator.common.api.dto.GenericAttribute
- hashCode() - Method in class com.smartgridready.communicator.common.api.values.BitmapRecord
- hashCode() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- hashCode() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- hashCode() - Method in class com.smartgridready.communicator.common.api.values.DataTypeInfo
- hashCode() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- hashCode() - Method in class com.smartgridready.communicator.common.api.values.EnumRecord
- hashCode() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- hashCode() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- hashCode() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- hashCode() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- hashCode() - Method in class com.smartgridready.communicator.common.helper.JsonReader.Key
- hashCode() - Method in class com.smartgridready.communicator.messaging.impl.MessageCacheKey
- hashCode() - Method in class com.smartgridready.communicator.modbus.api.ModbusGateway
- HighLow - com.smartgridready.communicator.modbus.helper.RegisterOrder
-
MSR first.
I
- IDLE - com.smartgridready.communicator.async.process.ExecStatus
-
Idle.
- indexAt(int) - Method in class com.smartgridready.communicator.common.helper.JsonReader.Key
-
Gets the element at a given position.
- InfoText - Class in com.smartgridready.communicator.common.api.dto
-
Implements an object label and description.
- InfoText(String, String) - Constructor for class com.smartgridready.communicator.common.api.dto.InfoText
-
Constructs a new instance.
- INSTANCE - Static variable in interface com.smartgridready.communicator.messaging.mapper.MessageBrokerMapper
-
The default singleton instance.
- INSTANCE - Static variable in interface com.smartgridready.communicator.messaging.mapper.MessagingInterfaceDescMapper
-
The default singleton instance.
- INT16 - com.smartgridready.communicator.common.api.values.DataType
-
16-bit signed integer
- INT16U - com.smartgridready.communicator.common.api.values.DataType
-
16-bit unsigned integer
- Int16UValue - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a 16-bit unsigned integer value.
- Int16Value - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a 16-bit signed integer value.
- INT32 - com.smartgridready.communicator.common.api.values.DataType
-
32-bit signed integer
- INT32U - com.smartgridready.communicator.common.api.values.DataType
-
32-bit unsigned integer
- Int32UValue - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a 32-bit unsigned integer value.
- Int32Value - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a 32-bit signed integer value.
- INT64 - com.smartgridready.communicator.common.api.values.DataType
-
64-bit signed integer
- INT64U - com.smartgridready.communicator.common.api.values.DataType
-
64-bit unsigned integer
- Int64UValue - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a 64-bit unsigned integer value.
- Int64Value - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a 64-bit signed integer value.
- INT8 - com.smartgridready.communicator.common.api.values.DataType
-
8-bit signed integer
- INT8U - com.smartgridready.communicator.common.api.values.DataType
-
8-bit unsigned integer
- Int8UValue - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a 8-bit unsigned integer value.
- Int8Value - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a 8-bit signed integer value.
- interfaceParametersMatch(ModbusInterfaceDescription, ModbusInterfaceDescription) - Static method in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Tells if interface specifications of two devices match.
- InterfaceType - Enum in com.smartgridready.communicator.common.api.dto
-
Defines the supported types of communication interfaces.
- intToRegisters(int) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts an int value to two Modbus registers.
- isbGotDiscrete() - Method in class com.smartgridready.communicator.modbus.helper.ModbusReaderResponse
-
Tells if the reponse contains discrete inputs.
- isbGotRegisters() - Method in class com.smartgridready.communicator.modbus.helper.ModbusReaderResponse
-
Tells if the reponse contains register values.
- isConnected() - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Checks if the device is connected.
- isConnected() - Method in class com.smartgridready.communicator.contacts.impl.SGrContactsDevice
- isConnected() - Method in class com.smartgridready.communicator.generic.impl.SGrGenericDevice
- isConnected() - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- isConnected() - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusDevice
- isConnected() - Method in class com.smartgridready.communicator.rest.impl.SGrRestApiDevice
- isConnected(String) - Method in class com.smartgridready.communicator.modbus.api.ModbusGateway
-
Tells if a specific device is connected.
- isExpired(Long) - Method in class com.smartgridready.communicator.modbus.helper.CacheRecord
-
Tells if the cache has expired.
- isFilterMatch(String) - Method in class com.smartgridready.communicator.messaging.impl.MessageFilterHandlerImpl
- isNotEmpty(String) - Static method in class com.smartgridready.utils.StringUtil
-
Tells if a string is not empty.
- isNotProcessed() - Method in enum com.smartgridready.communicator.async.process.ExecStatus
-
Tells if the process is not yet finished.
- isNumeric(Value) - Static method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
-
Tells if a value contains a number.
- isSerial(ModbusInterfaceDescription) - Static method in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Tells if the interface uses a serial connection.
- isShared() - Method in class com.smartgridready.communicator.modbus.api.ModbusGateway
-
Tells if shared access is possible.
- isTcp(ModbusInterfaceDescription) - Static method in class com.smartgridready.communicator.modbus.helper.ModbusUtil
-
Tells if the interface uses a TCP/IP connection.
- isTokenRenewalSupported() - Method in interface com.smartgridready.communicator.rest.http.authentication.Authenticator
-
Tells if access tokens can be renewed instead of re-authenticating.
- isTokenRenewalSupported() - Method in class com.smartgridready.communicator.rest.http.authentication.BasicAuthenticator
- isTokenRenewalSupported() - Method in class com.smartgridready.communicator.rest.http.authentication.BearerTokenAuthenticator
- isVerifyCertificate() - Method in class com.smartgridready.communicator.rest.http.client.RestServiceClient
-
Tells if SSL certificates are to be verified.
J
- JSON - com.smartgridready.communicator.common.api.values.DataType
-
JSON
- JsonBase - Class in com.smartgridready.communicator.common.helper
-
Base class for JSON reader and writer.
- JsonBase(Map<String, String>) - Constructor for class com.smartgridready.communicator.common.helper.JsonBase
-
Constructs a new instance.
- JsonHelper - Class in com.smartgridready.communicator.common.helper
-
Provides helper methods for JSON.
- JsonReader - Class in com.smartgridready.communicator.common.helper
-
Maps a received JSON value into the required SmartGridready JSON output value.
- JsonReader(Map<String, String>) - Constructor for class com.smartgridready.communicator.common.helper.JsonReader
-
Constructs a new instance.
- JsonReader.Key - Class in com.smartgridready.communicator.common.helper
-
Implements a map key.
- JsonValue - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a JSON node.
- JsonWriter - Class in com.smartgridready.communicator.common.helper
-
Converts data to JSON.
- JsonWriter(Map<String, String>) - Constructor for class com.smartgridready.communicator.common.helper.JsonWriter
-
Constructs a new instance.
K
- key() - Method in class com.smartgridready.communicator.common.helper.JsonReader.Key
-
Gets the key as string.
- keywordMapInput - Variable in class com.smartgridready.communicator.common.helper.JsonBase
-
The keyword map.
L
- load(String) - Method in class com.smartgridready.communicator.common.helper.DeviceDescriptionLoader
-
Load an external device description from its EI-XML content.
- load(String, InputStream) - Method in class com.smartgridready.communicator.common.helper.DeviceDescriptionLoader
-
Load an external device description from an EI-XML input stream.
- load(String, InputStream, Properties) - Method in class com.smartgridready.communicator.common.helper.DeviceDescriptionLoader
-
Load an external device description from an EI-XML input stream and replace placeholder tags with the values given by the
propertiesparameter. - load(String, String) - Method in class com.smartgridready.communicator.common.helper.DeviceDescriptionLoader
-
Load an external device description from its EI-XML file.
- load(String, String, boolean) - Method in class com.smartgridready.communicator.common.helper.XmlResourceLoader
-
Deserializes XML into an object.
- load(String, String, Properties) - Method in class com.smartgridready.communicator.common.helper.DeviceDescriptionLoader
-
Load an external device description from its EI-XML file and replace placeholder tags with the values given by the
propertiesparameter. - load(String, Properties) - Method in class com.smartgridready.communicator.common.helper.DeviceDescriptionLoader
-
Load an external device description from its EI-XML file and replace placeholder tags with the values given by the
propertiesparameter. - LOCAL - com.smartgridready.communicator.common.api.dto.OperationEnvironment
-
Local environment like LAN.
- longToRegisters(long) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts a long value to four Modbus registers.
- LowHigh - com.smartgridready.communicator.modbus.helper.RegisterOrder
-
LSR first.
M
- mapGenericAttributes(List<GenericAttributeProductEnd>) - Static method in class com.smartgridready.communicator.common.api.dto.GenericAttribute
-
Maps a list of generic attributes.
- mapJsonResponse(JMESPathMapping, String) - Static method in class com.smartgridready.communicator.common.helper.JsonHelper
-
Evaluates a JMESPath mapping on a JSON string and returns as SGr value.
- mapToDriverApi(MessageBrokerListElement) - Method in interface com.smartgridready.communicator.messaging.mapper.MessageBrokerMapper
-
Maps the message broker specification to its driver equivalent.
- mapToDriverApi(MessagingInterfaceDescription) - Method in interface com.smartgridready.communicator.messaging.mapper.MessagingInterfaceDescMapper
-
Maps the interface specification to its driver equivalent.
- mapToDriverApi(MessagingPlatformType) - Static method in class com.smartgridready.communicator.messaging.mapper.PlatformTypeMapper
-
Maps platform type of specification to driver type.
- mapToFlatList(String, Map<String, String>) - Static method in class com.smartgridready.communicator.common.helper.JsonReader
-
Converts a JSON string to a data structure of key-value pairs, using a keyword map.
- match(String, String) - Static method in class com.smartgridready.communicator.common.helper.RegexHelper
-
Matches a string.
- MAX - com.smartgridready.communicator.common.impl.SGrDeviceBase.Comparator
-
Maximum.
- MessageBrokerMapper - Interface in com.smartgridready.communicator.messaging.mapper
-
Defines the interface of a message broker specification mapper.
- MessageCacheKey - Class in com.smartgridready.communicator.messaging.impl
-
Implements a message cache key.
- MessageCacheRecord - Class in com.smartgridready.communicator.messaging.impl
-
Implements a message cache record.
- MessageFilterHandlerImpl - Class in com.smartgridready.communicator.messaging.impl
-
Implements a message filter handler.
- MessageFilterHandlerImpl(MessageFilter) - Constructor for class com.smartgridready.communicator.messaging.impl.MessageFilterHandlerImpl
-
Constructs a new instance.
- MESSAGING - com.smartgridready.communicator.common.api.dto.InterfaceType
-
Messaging
- MessagingInterfaceDescMapper - Interface in com.smartgridready.communicator.messaging.mapper
-
Defines the interface of an interface description mapper.
- MIN - com.smartgridready.communicator.common.impl.SGrDeviceBase.Comparator
-
Minimum.
- MODBUS - com.smartgridready.communicator.common.api.dto.InterfaceType
-
Modbus
- ModbusGateway - Class in com.smartgridready.communicator.modbus.api
-
Implements a Modbus "gateway" wrapper, allowing shared use of Modbus RTU serial connections.
- ModbusGateway(String, ModbusInterfaceDescription, GenDriverAPI4Modbus) - Constructor for class com.smartgridready.communicator.modbus.api.ModbusGateway
-
Constructs a new instance with no shared access.
- ModbusGateway(String, ModbusInterfaceDescription, GenDriverAPI4Modbus, boolean) - Constructor for class com.smartgridready.communicator.modbus.api.ModbusGateway
-
Constructs a new instance.
- ModbusGatewayRegistry - Interface in com.smartgridready.communicator.modbus.api
-
An interface for a Modbus gateway registry.
- ModbusReader - Class in com.smartgridready.communicator.modbus.helper
-
Implements Modbus read commands.
- ModbusReaderResponse - Class in com.smartgridready.communicator.modbus.helper
-
Implements a Modbus read command response.
- ModbusTransportUtil - Class in com.smartgridready.communicator.modbus.helper
-
A helper class to create instances of Modbus transport connections.
- ModbusType - Enum in com.smartgridready.communicator.modbus.helper
-
Defines types of Modbus transports.
- ModbusUtil - Class in com.smartgridready.communicator.modbus.helper
-
Utility methods for Modbus.
- multiply(double, double) - Static method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
-
Multiplies two numbers.
N
- NumberValue<T extends java.lang.Number> - Class in com.smartgridready.communicator.common.api.values
-
Base class for numeric SGr value types.
- NumberValue() - Constructor for class com.smartgridready.communicator.common.api.values.NumberValue
-
Constructs a new instance.
O
- objectMapper - Static variable in class com.smartgridready.communicator.common.helper.JsonBase
-
The JSON object mapper.
- of(boolean) - Static method in class com.smartgridready.communicator.common.api.values.BooleanValue
-
Creates a new instance from a boolean.
- of(byte) - Static method in class com.smartgridready.communicator.common.api.values.Int8Value
-
Creates a new instance from byte.
- of(double) - Static method in class com.smartgridready.communicator.common.api.values.Float64Value
-
Creates a new instance.
- of(float) - Static method in class com.smartgridready.communicator.common.api.values.Float32Value
-
Creates a new instance.
- of(int) - Static method in class com.smartgridready.communicator.common.api.values.Int16UValue
-
Creates a new instance from int.
- of(int) - Static method in class com.smartgridready.communicator.common.api.values.Int32Value
-
Creates a new instance from int.
- of(int[], BitmapProduct) - Static method in class com.smartgridready.communicator.common.api.values.BitmapValue
-
Creates a new instance from Modbus registers.
- of(long) - Static method in class com.smartgridready.communicator.common.api.values.DateTimeValue
-
Creates a new instance from UNIX milliseconds since epoch.
- of(long) - Static method in class com.smartgridready.communicator.common.api.values.EnumValue
-
Creates a new instance with only an ordinal.
- of(long) - Static method in class com.smartgridready.communicator.common.api.values.Int32UValue
-
Creates a new instance from long.
- of(long) - Static method in class com.smartgridready.communicator.common.api.values.Int64Value
-
Creates a new instance from long.
- of(short) - Static method in class com.smartgridready.communicator.common.api.values.Int16Value
-
Creates a new instance from short.
- of(short) - Static method in class com.smartgridready.communicator.common.api.values.Int8UValue
-
Creates a new instance from short.
- of(JsonNode) - Static method in class com.smartgridready.communicator.common.api.values.JsonValue
-
Creates a new instance from a JSON node.
- of(Value) - Static method in class com.smartgridready.communicator.messaging.impl.MessageCacheRecord
-
Creates a new instance from a value.
- of(Value...) - Static method in class com.smartgridready.communicator.common.api.values.ArrayValue
-
Creates a new instance.
- of(GenericAttributeProduct) - Static method in class com.smartgridready.communicator.common.api.dto.GenericAttribute
-
Creates a new instance.
- of(GenericAttributeProductEnd) - Static method in class com.smartgridready.communicator.common.api.dto.GenericAttribute
-
Creates a new instance.
- of(Long, EnumMapProduct) - Static method in class com.smartgridready.communicator.common.api.values.EnumValue
-
Creates a new instance from an ordinal and enumeration specification.
- of(Object) - Static method in class com.smartgridready.communicator.common.api.values.JsonValue
-
Creates a new instance from a POJO.
- of(String) - Static method in class com.smartgridready.communicator.common.api.values.DateTimeValue
-
Creates a new instance from a string.
- of(String) - Static method in class com.smartgridready.communicator.common.api.values.EnumValue
-
Creates a new instance with only a literal.
- of(String) - Static method in class com.smartgridready.communicator.common.api.values.JsonValue
-
Creates a new instance from a JSON string.
- of(String) - Static method in class com.smartgridready.communicator.common.api.values.StringValue
-
Creates a new instance.
- of(String, boolean, RestApiServiceCall, GenHttpClientFactory) - Static method in class com.smartgridready.communicator.rest.http.client.RestServiceClient
-
Creates a new instance.
- of(String, boolean, RestApiServiceCall, GenHttpClientFactory, Map<String, String>) - Static method in class com.smartgridready.communicator.rest.http.client.RestServiceClient
-
Creates a new instance.
- of(String, EnumMapProduct) - Static method in class com.smartgridready.communicator.common.api.values.EnumValue
-
Creates a new instance from a literal and enumeration specification.
- of(String, MessageFilter) - Static method in class com.smartgridready.communicator.messaging.impl.MessageCacheKey
-
Creates a new instance.
- of(String, Long, String) - Static method in class com.smartgridready.communicator.common.api.values.EnumValue
-
Creates a new instance.
- of(String, String, Value) - Static method in class com.smartgridready.communicator.common.api.dto.DataPointValue
-
Constructs a data point value.
- of(BigInteger) - Static method in class com.smartgridready.communicator.common.api.values.Int64UValue
-
Creates a new instance from BigInteger.
- of(Instant) - Static method in class com.smartgridready.communicator.common.api.values.DateTimeValue
-
Creates a new instance from
Instant. - of(Map<String, Boolean>) - Static method in class com.smartgridready.communicator.common.api.values.BitmapValue
-
Creates a new instance from a map.
- OperationEnvironment - Enum in com.smartgridready.communicator.common.api.dto
-
Defines operation environment enumerations.
P
- Parallel - Class in com.smartgridready.communicator.async.process
-
Implements a process which is executed in parallel.
- Parallel() - Constructor for class com.smartgridready.communicator.async.process.Parallel
-
Constructs a new instance.
- PARALLEL - com.smartgridready.communicator.async.process.ProcessingType
-
Parallel.
- parseJsonResponse(String, String) - Static method in class com.smartgridready.communicator.common.helper.JsonHelper
-
Evaluates a JMESPath expression on a JSON string and returns as SGr value.
- parseJsonResponseWithJsonata(String, String) - Static method in class com.smartgridready.communicator.common.helper.JsonHelper
-
Evaluates a JSONata expression on a JSON string and returns as SGr value.
- parseXmlResponse(String, String) - Static method in class com.smartgridready.communicator.common.helper.XPathHelper
-
Evaluates an XPath expression on an XML string and returns as SGr value.
- PlatformTypeMapper - Class in com.smartgridready.communicator.messaging.mapper
-
Maps platform types of specification to driver types.
- printServiceCall(RestApiServiceCall) - Static method in class com.smartgridready.communicator.rest.http.client.RestServiceClientUtils
-
Prints info about an HTTP call specification.
- process() - Method in class com.smartgridready.communicator.async.process.Processor
-
Executes the processes in parallel.
- process(ProcessingType) - Method in class com.smartgridready.communicator.async.process.Parallel
- process(ProcessingType) - Method in class com.smartgridready.communicator.async.process.Processor
-
Executes the processes.
- process(ProcessingType) - Method in class com.smartgridready.communicator.async.process.ReadExec
- process(ProcessingType) - Method in class com.smartgridready.communicator.async.process.Sequence
- process(ProcessingType) - Method in class com.smartgridready.communicator.async.process.WriteExec
- PROCESSING - com.smartgridready.communicator.async.process.ExecStatus
-
Processing.
- ProcessingType - Enum in com.smartgridready.communicator.async.process
-
Defines types of process execution.
- Processor - Class in com.smartgridready.communicator.async.process
-
Base class for task processors.
- ProductInfo - Class in com.smartgridready.communicator.common.api.dto
-
Provides an EID information DTO.
- ProductInfo() - Constructor for class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Constructs.
- profileName - Variable in class com.smartgridready.communicator.async.callable.BaseCallable
-
The functional profile name.
- properties(Properties) - Method in class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Sets the EID configuration parameters.
Q
- query(String, String) - Static method in class com.smartgridready.communicator.common.helper.RegexHelper
-
Extracts a substring using a regular expression.
R
- read(GenDriverAPI4Modbus, short, RegisterType, int, boolean, int) - Static method in class com.smartgridready.communicator.modbus.helper.ModbusReader
-
Reads from Modbus transport.
- READ - com.smartgridready.communicator.common.impl.SGrDeviceBase.RwpDirections
-
Data point is readable.
- readData() - Method in class com.smartgridready.communicator.common.api.dto.DeviceInfo
-
Deprecated, for removal: This API element is subject to removal in a future version.Since version 2.1.0
- readData() - Method in class com.smartgridready.communicator.common.api.dto.FunctionalProfile
-
Deprecated, for removal: This API element is subject to removal in a future version.Since version 2.1.0
- ReadExec<R> - Class in com.smartgridready.communicator.async.process
-
Implements an asynchronous read method.
- ReadExec(String, String, ReadFunction<R>) - Constructor for class com.smartgridready.communicator.async.process.ReadExec
-
Constructs a new instance.
- ReadExec(String, String, ReadFunction<R>, Scheduler) - Constructor for class com.smartgridready.communicator.async.process.ReadExec
-
Constructs a new instance with a custom scheduler.
- ReadFunction<R> - Interface in com.smartgridready.communicator.async.callable
-
Defines the interface of a read function.
- RegexHelper - Class in com.smartgridready.communicator.common.helper
-
Provides Regular expression helper methods.
- RegisterOrder - Enum in com.smartgridready.communicator.modbus.helper
-
Defines the order of Modbus registers.
- renewToken(DeviceFrame, GenHttpClientFactory) - Method in interface com.smartgridready.communicator.rest.http.authentication.Authenticator
-
Renews the access token.
- renewToken(DeviceFrame, GenHttpClientFactory) - Method in class com.smartgridready.communicator.rest.http.authentication.BasicAuthenticator
- renewToken(DeviceFrame, GenHttpClientFactory) - Method in class com.smartgridready.communicator.rest.http.authentication.BearerTokenAuthenticator
- RESTAPI - com.smartgridready.communicator.common.api.dto.InterfaceType
-
REST/HTTP
- RestApiAuthenticationException - Exception in com.smartgridready.communicator.rest.exception
-
Implments an exception for HTTP authentication failures.
- RestApiAuthenticationException(String) - Constructor for exception com.smartgridready.communicator.rest.exception.RestApiAuthenticationException
-
Constructs a new instance.
- RestApiAuthenticationException(String, Throwable) - Constructor for exception com.smartgridready.communicator.rest.exception.RestApiAuthenticationException
-
Constructs a new instance.
- RestApiResponseParseException - Exception in com.smartgridready.communicator.rest.exception
-
Implements an exception for errors in HTTP responses.
- RestApiResponseParseException(String) - Constructor for exception com.smartgridready.communicator.rest.exception.RestApiResponseParseException
-
Constructs a new instance.
- RestApiResponseParseException(String, Throwable) - Constructor for exception com.smartgridready.communicator.rest.exception.RestApiResponseParseException
-
Constructs a new instance.
- RestApiServiceCallException - Exception in com.smartgridready.communicator.rest.exception
-
Implements an exception of failed HTTP calls.
- RestApiServiceCallException(GenHttpResponse) - Constructor for exception com.smartgridready.communicator.rest.exception.RestApiServiceCallException
-
Constructs a new instance.
- RestServiceClient - Class in com.smartgridready.communicator.rest.http.client
-
Implements an HTTP / REST client.
- RestServiceClient(String, boolean, RestApiServiceCall, GenHttpClientFactory) - Constructor for class com.smartgridready.communicator.rest.http.client.RestServiceClient
-
Constructs a new instance with empty substitution properties.
- RestServiceClient(String, boolean, RestApiServiceCall, GenHttpClientFactory, Map<String, String>) - Constructor for class com.smartgridready.communicator.rest.http.client.RestServiceClient
-
Constructs a new instance.
- RestServiceClientUtils - Class in com.smartgridready.communicator.rest.http.client
-
Implements utility functions for HTTP / REST APIs.
- result - Variable in class com.smartgridready.communicator.async.callable.BaseCallable
-
The execution result.
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.ArrayValue
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.BooleanValue
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.DateTimeValue
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.Float32Value
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.Float64Value
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.Int16UValue
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.Int16Value
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.Int32UValue
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.Int32Value
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.Int64Value
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.Int8UValue
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.Int8Value
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- roundToInt() - Method in class com.smartgridready.communicator.common.api.values.Value
-
Rounds the instance's value to the nearest integer, if possible.
- RTU - com.smartgridready.communicator.modbus.helper.ModbusType
-
Modbus RTU over serial.
- RTU_ASCII - com.smartgridready.communicator.modbus.helper.ModbusType
-
Modbus RTU over serial, with ASCII encoding.
- RTU_TCP - com.smartgridready.communicator.modbus.helper.ModbusType
-
Modbus RTU over TCP.
S
- scaleDown(int, int) - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
-
Scales down by powers of 10.
- scaleDown(int, int) - Method in class com.smartgridready.communicator.common.api.values.NumberValue
-
Scales down by powers of 10.
- scaleDown(int, int) - Method in class com.smartgridready.communicator.common.api.values.StringValue
-
Scales down by powers of 10.
- scaleUp(int, int) - Method in class com.smartgridready.communicator.common.api.values.Int64UValue
-
Scales up by powers of 10.
- scaleUp(int, int) - Method in class com.smartgridready.communicator.common.api.values.NumberValue
-
Scales up by powers of 10.
- scaleUp(int, int) - Method in class com.smartgridready.communicator.common.api.values.StringValue
-
Scales up by powers of 10.
- Sequence - Class in com.smartgridready.communicator.async.process
-
Implements a process which is executed sequentially.
- Sequence() - Constructor for class com.smartgridready.communicator.async.process.Sequence
-
Constructs a new instance.
- SEQUENCE - com.smartgridready.communicator.async.process.ProcessingType
-
Sequential.
- setDataPointName(String) - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Sets the data point name.
- setExecStatus(ExecStatus) - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Sets the process status.
- setFinishedNotificationReceiver(Object) - Method in interface com.smartgridready.communicator.async.process.Executable
-
Sets an object which should receive notifications of status changes.
- setFinishedNotificationReceiver(Object) - Method in class com.smartgridready.communicator.async.process.ReadExec
- setFinishedNotificationReceiver(Object) - Method in class com.smartgridready.communicator.async.process.WriteExec
- setHwRevision(String) - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Sets the product hardware version.
- setIdentifier(String) - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Sets the EID identifier.
- setInterface(String) - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Sets the communication interface type.
- setLevel(String) - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Sets the SGr level.
- setManufacturer(String) - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Sets the manufacturer name.
- setMbbitresp(boolean[]) - Method in class com.smartgridready.communicator.modbus.helper.ModbusReaderResponse
-
Sets the discrete inputs.
- setMbregresp(int[]) - Method in class com.smartgridready.communicator.modbus.helper.ModbusReaderResponse
-
Sets the register values.
- setProductName(String) - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Sets the product name.
- setProductType(String) - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Sets the product type.
- setProfileName(String) - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Sets the functional profile name.
- setReleaseState(String) - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Sets the release state.
- setRequestTime(Instant) - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Sets the time stamp of sending the request.
- setResponseTime(Instant) - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Sets the time stamp of getting the response.
- setSwRevision(String) - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Sets the product software version.
- setTestState(String) - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Sets the test state.
- setThrowable(Throwable) - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Sets the exception that was thrown.
- setVal(Value) - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Write a value to the data point.
- setVal(String, String, Value) - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Set a value for a given data point
- setVal(String, String, Value) - Method in class com.smartgridready.communicator.contacts.impl.SGrContactsDevice
- setVal(String, String, Value) - Method in class com.smartgridready.communicator.generic.impl.SGrGenericDevice
- setVal(String, String, Value) - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- setVal(String, String, Value) - Method in interface com.smartgridready.communicator.modbus.api.GenDeviceApi4Modbus
-
Write a value to the modbus device using the generic data point representation (see
Value). - setVal(String, String, Value) - Method in class com.smartgridready.communicator.modbus.impl.SGrModbusDevice
- setVal(String, String, Value) - Method in interface com.smartgridready.communicator.rest.api.GenDeviceApi4Rest
-
Writes a value to the REST API device.
- setVal(String, String, Value) - Method in class com.smartgridready.communicator.rest.impl.SGrRestApiDevice
- setValue(double) - Method in class com.smartgridready.communicator.common.api.values.Float32Value
- setValue(double) - Method in class com.smartgridready.communicator.common.api.values.Float64Value
- setValue(double) - Method in class com.smartgridready.communicator.common.api.values.Int16UValue
- setValue(double) - Method in class com.smartgridready.communicator.common.api.values.Int16Value
- setValue(double) - Method in class com.smartgridready.communicator.common.api.values.Int32UValue
- setValue(double) - Method in class com.smartgridready.communicator.common.api.values.Int32Value
- setValue(double) - Method in class com.smartgridready.communicator.common.api.values.Int64Value
- setValue(double) - Method in class com.smartgridready.communicator.common.api.values.Int8UValue
- setValue(double) - Method in class com.smartgridready.communicator.common.api.values.Int8Value
- setValue(double) - Method in class com.smartgridready.communicator.common.api.values.NumberValue
-
Updates the numeric value.
- setValue(T) - Method in class com.smartgridready.communicator.async.callable.AsyncResult
-
Sets the result value.
- setVersion(String) - Method in class com.smartgridready.communicator.common.api.dto.ProductInfo
-
Sets the EID version.
- setWriteValue(T) - Method in class com.smartgridready.communicator.async.callable.DeviceWriteCallable
-
Updates the value to write.
- setWriteValue(V) - Method in class com.smartgridready.communicator.async.process.WriteExec
-
Sets the value to write.
- SGrContactsDevice - Class in com.smartgridready.communicator.contacts.impl
-
Implements a communication interface based on digital contacts.
- SGrContactsDevice(DeviceFrame, GenDriverAPI4ContactsFactory) - Constructor for class com.smartgridready.communicator.contacts.impl.SGrContactsDevice
-
Constructs a new instance.
- SGrDeclarationLibrary - Class in com.smartgridready.communicator.common.api
-
Provides a client for the SGr declaration library.
- SGrDeclarationLibrary() - Constructor for class com.smartgridready.communicator.common.api.SGrDeclarationLibrary
-
Constructs with default HTTP implementation.
- SGrDeclarationLibrary(GenHttpClientFactory) - Constructor for class com.smartgridready.communicator.common.api.SGrDeclarationLibrary
-
Constructs with custom HTTP implementation.
- SGrDeviceBase<D extends com.smartgridready.ns.v0.DeviceFrame,F extends com.smartgridready.ns.v0.FunctionalProfileBase,P extends com.smartgridready.ns.v0.DataPointBase> - Class in com.smartgridready.communicator.common.impl
-
Base class for all kinds of device communication interfaces.
- SGrDeviceBase(D) - Constructor for class com.smartgridready.communicator.common.impl.SGrDeviceBase
-
Constructs a new instance.
- SGrDeviceBase.Comparator - Enum in com.smartgridready.communicator.common.impl
-
Comparators.
- SGrDeviceBase.RwpDirections - Enum in com.smartgridready.communicator.common.impl
-
Collection of access permissions.
- SGrDeviceBuilder - Class in com.smartgridready.communicator.common.api
-
Implements a generic SGr device builder.
- SGrDeviceBuilder() - Constructor for class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Constructs new instance with defaults.
- SGrGenericDevice - Class in com.smartgridready.communicator.generic.impl
-
Implements a generic device, which has no actual communication interface.
- SGrGenericDevice(DeviceFrame) - Constructor for class com.smartgridready.communicator.generic.impl.SGrGenericDevice
-
Constructs a new instance.
- SGrMessagingDevice - Class in com.smartgridready.communicator.messaging.impl
-
Implements a messaging-based device communication interface.
- SGrMessagingDevice(DeviceFrame, GenMessagingClientFactory) - Constructor for class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
-
Constructs a new instance.
- SGrMessagingDevice(DeviceFrame, Map<MessagingPlatformType, GenMessagingClientFactory>) - Constructor for class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
-
Constructs a new instance.
- SGrModbusDevice - Class in com.smartgridready.communicator.modbus.impl
-
Implements a Modbus device communication interface.
- SGrModbusDevice(DeviceFrame, GenDriverAPI4Modbus) - Constructor for class com.smartgridready.communicator.modbus.impl.SGrModbusDevice
-
Construct with pre-defined transport (legacy method).
- SGrModbusDevice(DeviceFrame, GenDriverAPI4ModbusFactory) - Constructor for class com.smartgridready.communicator.modbus.impl.SGrModbusDevice
-
Construct with custom Modbus gateway factory.
- SGrModbusDevice(DeviceFrame, GenDriverAPI4ModbusFactory, ModbusGatewayRegistry) - Constructor for class com.smartgridready.communicator.modbus.impl.SGrModbusDevice
-
Construct with pre-defined shared Modbus gateway registry.
- SGrModbusGatewayRegistry - Class in com.smartgridready.communicator.modbus.impl
-
Default implementation of a shared Modbus gateway registry.
- SGrModbusGatewayRegistry() - Constructor for class com.smartgridready.communicator.modbus.impl.SGrModbusGatewayRegistry
-
Constructs a new instance.
- SGrRestApiDevice - Class in com.smartgridready.communicator.rest.impl
-
Implements a device interface for HTTP / REST APIs.
- SGrRestApiDevice(DeviceFrame, GenHttpClientFactory) - Constructor for class com.smartgridready.communicator.rest.impl.SGrRestApiDevice
-
Constructs a new instance.
- shortToRegister(short) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts a short value to a Modbus register.
- STRING - com.smartgridready.communicator.common.api.values.DataType
-
String
- StringUtil - Class in com.smartgridready.utils
-
Implements utility methods for strings.
- StringValue - Class in com.smartgridready.communicator.common.api.values
-
Implements an SGr value containing a string value.
- subscribe(String, String, Consumer<Either<Throwable, Value>>) - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Subscribes to messages that are related to the given data point
- subscribe(String, String, Consumer<Either<Throwable, Value>>) - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
- subscribe(String, String, Consumer<Either<Throwable, Value>>) - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- subscribe(Consumer<Either<Throwable, Value>>) - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Subscribes to messages that are related to the given data point.
- SUCCESS - com.smartgridready.communicator.async.process.ExecStatus
-
Completed successfully.
T
- TCP - com.smartgridready.communicator.modbus.helper.ModbusType
-
Modbus TCP.
- toByteArray(int) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts an int to a byte array.
- toModbusDiscreteVal(ModbusDataType) - Method in class com.smartgridready.communicator.common.api.values.Value
-
Converts the value to a list of Modbus discrete inputs.
- toModbusRegister(ModbusDataType) - Method in class com.smartgridready.communicator.common.api.values.Value
-
Converts the value to a list of Modbus registers.
- toModbusRegisters(int, BitmapProduct) - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
-
Converts to Modbus registers.
- toString() - Method in class com.smartgridready.communicator.async.callable.AsyncResult
- toString() - Method in class com.smartgridready.communicator.async.callable.DeviceReadCallable
- toString() - Method in class com.smartgridready.communicator.async.callable.DeviceWriteCallable
- toString() - Method in class com.smartgridready.communicator.async.process.ReadExec
- toString() - Method in class com.smartgridready.communicator.async.process.WriteExec
- toString() - Method in class com.smartgridready.communicator.common.api.dto.DataPointValue
- toString() - Method in class com.smartgridready.communicator.common.api.dto.GenericAttribute
- toString() - Method in class com.smartgridready.communicator.common.api.values.BitmapRecord
- toString() - Method in class com.smartgridready.communicator.common.api.values.BitmapValue
- toString() - Method in class com.smartgridready.communicator.common.api.values.EnumRecord
- toString() - Method in class com.smartgridready.communicator.common.api.values.EnumValue
- toString() - Method in class com.smartgridready.communicator.common.api.values.JsonValue
- toString() - Method in class com.smartgridready.communicator.common.api.values.NumberValue
- toString() - Method in class com.smartgridready.communicator.common.api.values.StringValue
- toString() - Method in class com.smartgridready.communicator.modbus.helper.CacheRecord
- toString() - Method in class com.smartgridready.communicator.modbus.helper.ModbusReaderResponse
U
- UDP - com.smartgridready.communicator.modbus.helper.ModbusType
-
Modbus UDP.
- uintToRegisters(long) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts an unsigned int value to two Modbus registers.
- UNDEFINED_LITERAL - Static variable in class com.smartgridready.communicator.common.api.values.EnumRecord
-
Placeholder for undefined literals.
- UNDEFINED_ORDINAL - Static variable in class com.smartgridready.communicator.common.api.values.EnumRecord
-
Placeholder for undefined ordinal.
- UNKNOWN - com.smartgridready.communicator.common.api.dto.InterfaceType
-
Unknown
- UNKNOWN - com.smartgridready.communicator.common.api.values.DataType
-
Unknown
- UNKNOWN - com.smartgridready.communicator.modbus.helper.ModbusType
-
Unknown, not supported.
- UNSIGNED_LONG_MASK - Static variable in class com.smartgridready.communicator.common.api.values.Value
-
A bit mask to convert to unsigned 64-bit integers, which are not natively supported by Java.
- unsignedLongToRegister(BigInteger) - Static method in class com.smartgridready.communicator.modbus.helper.ConversionHelper
-
Converts an unsigned long value to four Modbus registers.
- unsubscribe() - Method in class com.smartgridready.communicator.common.api.dto.DataPoint
-
Unsubscribes from messages that are related to a given data point.
- unsubscribe(String, String) - Method in interface com.smartgridready.communicator.common.api.GenDeviceApi
-
Unsubscribes from messages that are related to a given data point
- unsubscribe(String, String) - Method in class com.smartgridready.communicator.common.impl.SGrDeviceBase
- unsubscribe(String, String) - Method in class com.smartgridready.communicator.messaging.impl.SGrMessagingDevice
- useContactsDriverFactory(GenDriverAPI4ContactsFactory) - Method in class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Sets the contacts driver factory explicitly.
- useMessagingClientFactory(GenMessagingClientFactory, MessagingPlatformType) - Method in class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Sets the messaging client factory to be used explicitly.
- useModbusClientFactory(GenDriverAPI4ModbusFactory) - Method in class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Sets the Modbus client factory explicitly.
- useRestServiceClientFactory(GenHttpClientFactory) - Method in class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Sets the REST API service client factory.
- useSharedModbusGatewayRegistry(ModbusGatewayRegistry) - Method in class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Sets a custom shared Modbus RTU driver registry.
- useSharedModbusRtu(boolean) - Method in class com.smartgridready.communicator.common.api.SGrDeviceBuilder
-
Enables or disables shared instances of Modbus RTU drivers.
V
- validate() - Method in class com.smartgridready.communicator.messaging.impl.MessageFilterHandlerImpl
- value - Variable in class com.smartgridready.communicator.common.api.values.NumberValue
-
The internal value.
- Value - Class in com.smartgridready.communicator.common.api.values
-
The base class for all SGr value types.
- Value() - Constructor for class com.smartgridready.communicator.common.api.values.Value
-
Constructs a new instance.
- valueOf(String) - Static method in enum com.smartgridready.communicator.async.process.ExecStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.smartgridready.communicator.async.process.ProcessingType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.smartgridready.communicator.common.api.dto.InterfaceType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.smartgridready.communicator.common.api.dto.OperationEnvironment
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.smartgridready.communicator.common.api.values.DataType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.smartgridready.communicator.common.impl.SGrDeviceBase.Comparator
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.smartgridready.communicator.common.impl.SGrDeviceBase.RwpDirections
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.smartgridready.communicator.modbus.helper.ModbusType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.smartgridready.communicator.modbus.helper.RegisterOrder
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.smartgridready.communicator.async.process.ExecStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.smartgridready.communicator.async.process.ProcessingType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.smartgridready.communicator.common.api.dto.InterfaceType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.smartgridready.communicator.common.api.dto.OperationEnvironment
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.smartgridready.communicator.common.api.values.DataType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.smartgridready.communicator.common.impl.SGrDeviceBase.Comparator
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.smartgridready.communicator.common.impl.SGrDeviceBase.RwpDirections
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.smartgridready.communicator.modbus.helper.ModbusType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.smartgridready.communicator.modbus.helper.RegisterOrder
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- WRITE - com.smartgridready.communicator.common.impl.SGrDeviceBase.RwpDirections
-
Data point is writable.
- WriteExec<V> - Class in com.smartgridready.communicator.async.process
-
Implements an asynchronous read method.
- WriteExec(String, String, WriteFunction<V>) - Constructor for class com.smartgridready.communicator.async.process.WriteExec
-
Constructs a new instance.
- WriteExec(String, String, WriteFunction<V>, Scheduler) - Constructor for class com.smartgridready.communicator.async.process.WriteExec
-
Constructs a new instance with a custom scheduler.
- WriteFunction<V> - Interface in com.smartgridready.communicator.async.callable
-
Defines the interface of a write function.
X
- XmlResourceLoader<T> - Class in com.smartgridready.communicator.common.helper
-
Implements a generic XML deserializer that loads resources.
- XmlResourceLoader(Class<T>) - Constructor for class com.smartgridready.communicator.common.helper.XmlResourceLoader
-
Constructs a new instance.
- XPathHelper - Class in com.smartgridready.communicator.common.helper
-
Provides helper methods for XML and XPath.
All Classes All Packages