org.tango.jhdb.data

Class HdbData

java.lang.Object

org.tango.jhdb.data.HdbData

Direct Known Subclasses:

HdbBoolean, HdbBooleanArray, HdbByte, HdbByteArray, HdbDouble, HdbDoubleArray, HdbFloat, HdbFloatArray, HdbLong, HdbLong64, HdbLong64Array, HdbLongArray, HdbShort, HdbShortArray, HdbState, HdbStateArray, HdbString, HdbStringArray, HdbUChar, HdbUCharArray, HdbULong, HdbULongArray, HdbUShort, HdbUShortArray

public abstract class HdbData
extends Object

HdbData base class

Constructor Summary

Constructors

Constructor and Description
HdbData()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	applyConversionFactor(double f)
HdbData	copy()
static HdbData	createData(int type) Create HdbData accroding to the given type
long	getDataTime() Return time of this datum
String	getErrorMessage() Returns error message if this record has failed
long	getInsertTime() Return receive time of this datum
int	getQualityFactor() Returns quality factor
long	getRecvTime() Return receive time of this datum
int	getType() Return data type
abstract double	getValueAsDouble() Returns the value as double if it can be converted.
abstract double[]	getValueAsDoubleArray() Returns the value as double array it can be converted.
abstract long	getValueAsLong() Returns the value as long if it can be converted.
abstract long[]	getValueAsLongArray() Returns the value as long array it can be converted.
abstract String	getValueAsString() Returns the value as a String
abstract double	getWriteValueAsDouble() Returns the write value as double if it can be converted.
abstract double[]	getWriteValueAsDoubleArray() Returns the write value as double array it can be converted.
abstract long	getWriteValueAsLong() Returns the write value as long if it can be converted.
abstract long[]	getWriteValueAsLongArray() Returns the write value as long array it can be converted.
abstract String	getWriteValueAsString() Returns the write value as a String
boolean	hasFailed() Returns true if this record has failed
boolean	hasWriteValue() Returns true whether this datum has a write value
boolean	isArray() Returns true whether this datum is an array
boolean	isInvalid() Returns true if this value is ATTR_INVALID
void	parse(long data_time, long recv_time, long insert_time, String error_desc, int quality, ArrayList<Object> value_r, ArrayList<Object> value_w) Parse value
abstract void	parseValue(ArrayList<Object> value) Parse value
abstract void	parseWriteValue(ArrayList<Object> value) Parse write value
String	qualitytoStr(int quality)
void	setDataTime(long time) Set the dataTime
void	setRecvTime(long time) Set the receive time
int	size() Return number of item of the read value of this HdbData (1 is returned in case of scalar data).
int	sizeW() Return number of item of the write value of this HdbData (1 is returned in case of scalar data).
String	timeToStr(long time) Return time representation of the give time (ex: 22/07/2015 08:12:15.718908)

Methods inherited from class java.lang.Object

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

Constructor Detail

HdbData

public HdbData()

Method Detail

getDataTime

public long getDataTime()

Return time of this datum

setDataTime

public void setDataTime(long time)

Set the dataTime

getRecvTime

public long getRecvTime()

Return receive time of this datum

setRecvTime

public void setRecvTime(long time)

Set the receive time

getInsertTime

public long getInsertTime()

Return receive time of this datum

getQualityFactor

public int getQualityFactor()

Returns quality factor

getType

public int getType()

Return data type

hasFailed

public boolean hasFailed()

Returns true if this record has failed

size

public int size()

Return number of item of the read value of this HdbData (1 is returned in case of scalar data).

sizeW

public int sizeW()

Return number of item of the write value of this HdbData (1 is returned in case of scalar data).

getErrorMessage

public String getErrorMessage()

Returns error message if this record has failed

hasWriteValue

public boolean hasWriteValue()

Returns true whether this datum has a write value

isArray

public boolean isArray()

Returns true whether this datum is an array

getValueAsDouble

public abstract double getValueAsDouble()
                                 throws HdbFailed

Returns the value as double if it can be converted.

Throws:

HdbFailed - In case of failure

getValueAsDoubleArray

public abstract double[] getValueAsDoubleArray()
                                        throws HdbFailed

Returns the value as double array it can be converted.

Throws:

HdbFailed - In case of failure

getWriteValueAsDouble

public abstract double getWriteValueAsDouble()
                                      throws HdbFailed

Returns the write value as double if it can be converted.

Throws:

HdbFailed - In case of failure

getWriteValueAsDoubleArray

public abstract double[] getWriteValueAsDoubleArray()
                                             throws HdbFailed

Returns the write value as double array it can be converted.

Throws:

HdbFailed - In case of failure

getValueAsLong

public abstract long getValueAsLong()
                             throws HdbFailed

Returns the value as long if it can be converted.

Throws:

HdbFailed - In case of failure

getValueAsLongArray

public abstract long[] getValueAsLongArray()
                                    throws HdbFailed

Returns the value as long array it can be converted.

Throws:

HdbFailed - In case of failure

getWriteValueAsLong

public abstract long getWriteValueAsLong()
                                  throws HdbFailed

Returns the write value as long if it can be converted.

Throws:

HdbFailed - In case of failure

getWriteValueAsLongArray

public abstract long[] getWriteValueAsLongArray()
                                         throws HdbFailed

Returns the write value as long array it can be converted.

Throws:

HdbFailed - In case of failure

parseValue

public abstract void parseValue(ArrayList<Object> value)
                         throws HdbFailed

Parse value

Parameters:

value - Value to be parsed

Throws:

HdbFailed

parseWriteValue

public abstract void parseWriteValue(ArrayList<Object> value)
                              throws HdbFailed

Parse write value

Parameters:

value - Value to be parsed

Throws:

HdbFailed

getValueAsString

public abstract String getValueAsString()

Returns the value as a String

getWriteValueAsString

public abstract String getWriteValueAsString()

Returns the write value as a String

parse

public void parse(long data_time,
         long recv_time,
         long insert_time,
         String error_desc,
         int quality,
         ArrayList<Object> value_r,
         ArrayList<Object> value_w)
           throws HdbFailed

Parse value

Parameters:

data_time - Tango timestamp

recv_time - Event recieve timestamp

insert_time - Recording timestamp

error_desc - Error string

quality - Quality value

value_r - Read value

value_w - Write value

Throws:

HdbFailed

timeToStr

public String timeToStr(long time)

Return time representation of the give time (ex: 22/07/2015 08:12:15.718908)

Parameters:

time - Number of micro second since epoch

isInvalid

public boolean isInvalid()

Returns true if this value is ATTR_INVALID

qualitytoStr

public String qualitytoStr(int quality)

copy

public HdbData copy()
             throws HdbFailed

Throws:

HdbFailed

applyConversionFactor

public abstract void applyConversionFactor(double f)

createData

public static HdbData createData(int type)
                          throws HdbFailed

Create HdbData accroding to the given type

Parameters:

type - Data type

Throws:

HdbFailed - In case of failure