org.openmuc.jmbus

Class DataRecord

java.lang.Object

org.openmuc.jmbus.DataRecord

public class DataRecord
extends java.lang.Object

Representation of a data record (sometimes called variable data block). A data record is the basic data entity of the M-Bus application layer. A variable data structure contains a list of data records. Each data record represents a single data point. A data record consists of three fields: The data information block (DIB), the value information block (VIB) and the data field. The DIB codes the following parameters:

• Storage number - a meter can have several storages e.g. to store historical time series data. The storage number 0 signals an actual value.
• Function - data can have the following four function types: instantaneous value, max value, min value, value during error state.
• Length and coding of the data field.
• Tariff - indicates the tariff number of this data field. The data of tariff 0 is usually the sum of all other tariffs.
• Subunit - can be used by a slave to distinguish several subunits of the metering device

The VIB codes the following parameters:

• Description - the meaning of the data value (e.g. "Energy", "Volume" etc.)
• Unit - the unit of the data value.
• Multiplier - a factor by which the data value coded in the data field has to be multiplied with. getScaledDataValue() returns the result of the data value multiplied with the multiplier.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataRecord.DataValueType The data value type
static class	DataRecord.Description Data description stored in the VIB
static class	DataRecord.FunctionField Function coded in the DIB

Constructor Summary

Constructors

Constructor and Description
DataRecord()

Method Summary

Modifier and Type	Method and Description
int	getDataLength()
java.lang.Object	getDataValue() Returns the decoded data field of the data record as an Object.
DataRecord.DataValueType	getDataValueType()
DataRecord.Description	getDescription()
byte[]	getDib() Returns a byte array containing the DIB (i.e. the DIF and the DIFEs) contained in the data record.
DataRecord.FunctionField	getFunctionField()
int	getMultiplierExponent() The multiplier is coded in the VIF.
java.lang.Double	getScaledDataValue() Returns the data (value) multiplied by the multiplier as a Double.
long	getStorageNumber()
short	getSubunit()
int	getTariff()
DlmsUnit	getUnit()
java.lang.String	getUserDefinedDescription()
byte[]	getVib() Returns a byte array containing the VIB (i.e. the VIF and the VIFEs) contained in the data record.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataRecord

public DataRecord()

Method Detail

getDib

public byte[] getDib()

Returns a byte array containing the DIB (i.e. the DIF and the DIFEs) contained in the data record.

Returns:

a byte array containing the DIB

getVib

public byte[] getVib()

Returns a byte array containing the VIB (i.e. the VIF and the VIFEs) contained in the data record.

Returns:

a byte array containing the VIB

getDataValue

public java.lang.Object getDataValue()

Returns the decoded data field of the data record as an Object. The Object is of one of the four types Long, Double, String or Date depending on information coded in the DIB/VIB. The DataType can be checked using getDataValueType().

Returns:

the data value

getDataValueType

public DataRecord.DataValueType getDataValueType()

getScaledDataValue

public java.lang.Double getScaledDataValue()

Returns the data (value) multiplied by the multiplier as a Double. If the data is not a number than null is returned.

Returns:

the data (value) multiplied by the multiplier as a Double

getFunctionField

public DataRecord.FunctionField getFunctionField()

getStorageNumber

public long getStorageNumber()

getTariff

public int getTariff()

getSubunit

public short getSubunit()

getDescription

public DataRecord.Description getDescription()

getUserDefinedDescription

public java.lang.String getUserDefinedDescription()

getMultiplierExponent

public int getMultiplierExponent()

The multiplier is coded in the VIF. Is always a power of 10. This function returns the exponent. The base is always 10.

Returns:

the exponent of the multiplier.

getUnit

public DlmsUnit getUnit()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDataLength

public int getDataLength()