DataBlock (mbus4j-core 1.0.0 API)

java.lang.Object
- net.sf.mbus4j.dataframes.datablocks.DataBlock

All Implemented Interfaces:

Serializable, Cloneable, JSONSerializable

Direct Known Subclasses:

BigDecimalDataBlock, ByteDataBlock, DateAndTimeDataBlock, DateDataBlock, EmptyDataBlock, EnhancedIdentificationDataBlock, IntegerDataBlock, LongDataBlock, RawDataBlock, ReadOutDataBlock, RealDataBlock, ShortDataBlock, StringDataBlock, VariableLengthDataBlock
```
public abstract class DataBlock
extends Object
implements Serializable, JSONSerializable, Cloneable
```
Version:

$Id: DataBlock.java 163 2016-10-07 18:53:55Z arnep $

Author:

arnep@users.sourceforge.net

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Vife[] EMPTY_VIFE

Fields
Modifier and Type	Field and Description
`static Vife[]`	`EMPTY_VIFE`

Constructor Summary

Constructors
Constructor and Description
`DataBlock()`
`DataBlock(DataFieldCode dif, FunctionField functionField, short subUnit, int tariff, long storageNumber, Vif vif, Vife... vifes)` Deprecated.
`DataBlock(DataFieldCode dif, Vif vif, Vife... vifes)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`accumulateDatatoJSON(net.sf.json.JSONObject json)`
`boolean`	`addVife(Vife vife)`
`void`	`clearVifes()`
`protected String`	`formatBcdError(String bcdError)`
`void`	`fromJSON(net.sf.json.JSONObject json)`
`ObjectAction`	`getAction()`
`double`	`getCorrectionConstant()`
`int`	`getCorrectionExponent(SiPrefix siPrefix)`
`static Class<? extends DataBlock>`	`getDataBlockClass(Vif vif, Vife[] vifes, DataFieldCode dfc, VariableLengthType variableLengthType)`
`DataFieldCode`	`getDataFieldCode()`
`Integer`	`getExponent()`
`FunctionField`	`getFunctionField()`
`String`	`getParamDescr()`
`SiPrefix`	`getSiPrefix()`
`long`	`getStorageNumber()`
`short`	`getSubUnit()`
`int`	`getTariff()`
`UnitOfMeasurement`	`getUnitOfMeasurement()`
`abstract String`	`getValueAsString()`
`Vif`	`getVif()`
`static Vif`	`getVif(String vifTypeLabel, String vifLabel, UnitOfMeasurement unitOfMeasurement, SiPrefix siPrefix, Integer exponent)`
`static Vife`	`getVife(String vifeTypeLabel, String vifeLabel)`
`Vife[]`	`getVifes()`
`void`	`setAction(ObjectAction action)`
`void`	`setDataFieldCode(DataFieldCode dataFieldCode)`
`void`	`setFunctionField(FunctionField functionField)`
`void`	`setStorageNumber(long storageNumber)`
`void`	`setSubUnit(short subUnit)`
`void`	`setTariff(int tariff)`
`abstract void`	`setValue(String text)`
`void`	`setVif(Vif vif)`
`net.sf.json.JSONObject`	`toJSON(JsonSerializeType jsonSerializeType)`
`String`	`toString()`
`void`	`toString(StringBuilder sb, String inset)`
`static Vife[]`	`vifesFromJSON(VifTypes vifType, net.sf.json.JSONArray jsonVifes)`
`static Vif`	`vifFromJSON(net.sf.json.JSONObject jsonVif)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- EMPTY_VIFE
```
public static final Vife[] EMPTY_VIFE
```

Constructor Detail

DataBlock
```
public DataBlock()
```

DataBlock

@Deprecated
public DataBlock(DataFieldCode dif,
                             FunctionField functionField,
                             short subUnit,
                             int tariff,
                             long storageNumber,
                             Vif vif,
                             Vife... vifes)

Deprecated.

DataBlock

@Deprecated
public DataBlock(DataFieldCode dif,
                             Vif vif,
                             Vife... vifes)

Deprecated.

Method Detail

getDataBlockClass

public static Class<? extends DataBlock> getDataBlockClass(Vif vif,
                                                           Vife[] vifes,
                                                           DataFieldCode dfc,
                                                           VariableLengthType variableLengthType)

getVif

public static Vif getVif(String vifTypeLabel,
                         String vifLabel,
                         UnitOfMeasurement unitOfMeasurement,
                         SiPrefix siPrefix,
                         Integer exponent)

vifFromJSON

public static Vif vifFromJSON(net.sf.json.JSONObject jsonVif)

getVife

public static Vife getVife(String vifeTypeLabel,
                           String vifeLabel)

vifesFromJSON

public static Vife[] vifesFromJSON(VifTypes vifType,
                                   net.sf.json.JSONArray jsonVifes)

addVife
```
public boolean addVife(Vife vife)
```

getAction
```
public ObjectAction getAction()
```
Returns:

the action

getDataFieldCode

public DataFieldCode getDataFieldCode()

getExponent
```
public Integer getExponent()
```

getFunctionField

public FunctionField getFunctionField()

getParamDescr
```
public String getParamDescr()
```

getSiPrefix
```
public SiPrefix getSiPrefix()
```

getStorageNumber
```
public long getStorageNumber()
```

getSubUnit
```
public short getSubUnit()
```
Returns:

the deviceUnit

getTariff
```
public int getTariff()
```

getUnitOfMeasurement

public UnitOfMeasurement getUnitOfMeasurement()

getValueAsString

public abstract String getValueAsString()

getVif
```
public Vif getVif()
```

getVifes
```
public Vife[] getVifes()
```

setAction

public void setAction(ObjectAction action)

Parameters:: action - the action to set

setFunctionField

public void setFunctionField(FunctionField functionField)

setStorageNumber

public void setStorageNumber(long storageNumber)

setSubUnit
```
public void setSubUnit(short subUnit)
```
Parameters:

subUnit - the subUnit to set

setTariff
```
public void setTariff(int tariff)
```

setVif
```
public void setVif(Vif vif)
```

toString

public void toString(StringBuilder sb,
                     String inset)

toString
```
public String toString()
```
Overrides:

toString in class Object

accumulateDatatoJSON

protected void accumulateDatatoJSON(net.sf.json.JSONObject json)

toJSON

public net.sf.json.JSONObject toJSON(JsonSerializeType jsonSerializeType)

Specified by:: toJSON in interface JSONSerializable

fromJSON
```
public void fromJSON(net.sf.json.JSONObject json)
```
Specified by:

fromJSON in interface JSONSerializable

setValue

public abstract void setValue(String text)

setDataFieldCode
```
public void setDataFieldCode(DataFieldCode dataFieldCode)
```
Parameters:

dataFieldCode - the dataFieldCode to set

clearVifes
```
public void clearVifes()
```

formatBcdError

protected String formatBcdError(String bcdError)

getCorrectionExponent

public int getCorrectionExponent(SiPrefix siPrefix)

getCorrectionConstant
```
public double getCorrectionConstant()
```

Class DataBlock

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_VIFE

Constructor Detail

DataBlock

DataBlock

DataBlock

Method Detail

getDataBlockClass

getVif

vifFromJSON

getVife

vifesFromJSON

addVife

getAction

getDataFieldCode

getExponent

getFunctionField

getParamDescr

getSiPrefix

getStorageNumber

getSubUnit

getTariff

getUnitOfMeasurement

getValueAsString

getVif

getVifes

setAction

setFunctionField

setStorageNumber

setSubUnit

setTariff

setVif

toString

toString

accumulateDatatoJSON

toJSON

fromJSON

setValue

setDataFieldCode

clearVifes

formatBcdError

getCorrectionExponent

getCorrectionConstant