com.ergotech.secs.gem

Class SecsFormatValueObject

java.lang.Object

com.ergotech.vib.valueobjects.ValueObject

com.ergotech.secs.gem.SecsFormatValueObject

All Implemented Interfaces:

ValueObjectInterface, java.lang.Cloneable

public class SecsFormatValueObject
extends ValueObject

This value object wraps a SecsFormat object.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev

Fields inherited from class com.ergotech.vib.valueobjects.ValueObject

defaultTTL, locale, traceDefault, valueForTrue

Fields inherited from interface com.ergotech.vib.valueobjects.ValueObjectInterface

ANYTYPE, ARRAYTYPE, BINARYTYPE, BOOLEANTYPE, BYTETYPE, CHARTYPE, DISPLAYVALUE, DOUBLETYPE, FLOATTYPE, GROUP_NAME, INITIALVALUE, INTTYPE, LOG_MESSAGE, LONGTYPE, NAME, OBJECTTYPE, ORDER, PASSWORD_DIGEST, PROPERTYTYPE, QUALITY_BAD, QUALITY_COMM_FAILURE, QUALITY_DEVICE_FAILURE, QUALITY_EGU_EXCEEDED, QUALITY_EVALUATION_EXPIRED, QUALITY_GOOD, QUALITY_IMPOSSIBLE, QUALITY_INITIAL, QUALITY_LAST_USABLE, QUALITY_OUT_OF_SERVICE, QUALITY_PROPERTYONLY, QUALITY_REMOTE_PROXY_INIT, QUALITY_SIMULATED, QUALITY_SOURCE_REMOVED, QUALITY_TRANSITIONAL, QUALITY_UNKNOWN, QUALITY_WARNING, QUALITY_WORST, QUALITY_WRITE_IN_PROGRESS, REQUESTCURRENTVALUE, REQUESTHISTORICAL, SHORTTYPE, STRINGTYPE, TRACE, TWODTYPE, UNSIGNEDBYTETYPE, UNSIGNEDINTTYPE, UNSIGNEDLONGTYPE, UNSIGNEDSHORTTYPE, USER_NAME

Constructor Summary

Constructors

Constructor and Description
SecsFormatValueObject() The default constructor.
SecsFormatValueObject(SecsFormat newValue) Creates a value object with the current value, a null color and QUALITY_GOOD.
SecsFormatValueObject(SecsFormat newValue, int newQuality) Creates a value object with the current SecsFormat value, the color associated with that value (newColor) and QUALITY_GOOD.
SecsFormatValueObject(SecsFormat newValue, int newQuality, java.util.Date timeStamp) Creates a value object with the current SecsFormat value, the color associated with that value (newColor) and QUALITY_GOOD.
SecsFormatValueObject(SecsFormat newValue, int newQuality, java.util.Date timeStamp, java.awt.Color newColor) Creates a value object with the current SecsFormat value, the color associated with that value (newColor) and the quality.

Method Summary

Modifier and Type	Method and Description
ValueObjectInterface	copy() Returns a deep copy of the value object.
boolean	equals(java.lang.Object theObject) Compare the string values
byte[]	getBinaryValue() This will return the current value of the ValueObject as a byte array.
boolean	getBoolValue() Returns the current value represented as a boolean.
byte	getByteValue() Returns the current value represented as an byte.
char	getCharValue() Returns the current value represented as a char.
double	getDoubleValue() Returns the current value represented as a float.
float	getFloatValue() Returns the current value represented as an float.
int	getIntValue() Returns the current value represented as an integer.
long	getLongValue() Returns the current value represented as a long.
double	getNumericValue() Returns the double value, but will throw an exception if the object isn't convertable.
java.lang.Object	getObjectValue() Returns the current value represented as an Object.
SecsFormat	getSecsFormat() This will return the SecsFormat.
short	getShortValue() Returns the current value represented as a short.
java.lang.String	getStringValue() Returns the current value represented as an String.

Methods inherited from class com.ergotech.vib.valueobjects.ValueObject

acquireLatestPropertiesFrom, acquirePropertiesFrom, attributeNames, compareTo, convertToLowestPrecisionNumber, decrementTTL, escapeJSON, getAlwaysSend, getColor, getDate, getLocale, getLowestPrecisionValueObject, getProperties, getProperty, getQuality, getQualityString, getTime, getTimeMillis, getTTL, getType, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, hashCode, replaces, setAlwaysSend, setColor, setDate, setLocale, setProperty, setQuality, setTimeMillis, setTTL, setType, setValueForTrue, shouldTrace, toJSON, toJSON, toJSON, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

Constructor Detail

SecsFormatValueObject

public SecsFormatValueObject()

The default constructor. It sets the current value to a SecsFormat34 value of 0.

SecsFormatValueObject

public SecsFormatValueObject(SecsFormat newValue)

Creates a value object with the current value, a null color and QUALITY_GOOD.

Parameters:

newValue - The value stored

SecsFormatValueObject

public SecsFormatValueObject(SecsFormat newValue,
                             int newQuality)

Creates a value object with the current SecsFormat value, the color associated with that value (newColor) and QUALITY_GOOD.

Parameters:

newValue - the value stored

timeStamp - the Date assocaiated with the newValue.

SecsFormatValueObject

public SecsFormatValueObject(SecsFormat newValue,
                             int newQuality,
                             java.util.Date timeStamp)

Creates a value object with the current SecsFormat value, the color associated with that value (newColor) and QUALITY_GOOD.

Parameters:

newValue - the value stored

timeStamp - the Date assocaiated with the newValue.

SecsFormatValueObject

public SecsFormatValueObject(SecsFormat newValue,
                             int newQuality,
                             java.util.Date timeStamp,
                             java.awt.Color newColor)

Creates a value object with the current SecsFormat value, the color associated with that value (newColor) and the quality.

Parameters:

newValue - the value stored

newColor - the color assocaiated with the newValue.

newQuality - the quality associated with this value

Method Detail

copy

public ValueObjectInterface copy()

Returns a deep copy of the value object.

Returns:

a deep copy of the value object

equals

public boolean equals(java.lang.Object theObject)

Description copied from class: ValueObject

Compare the string values

Specified by:

equals in interface ValueObjectInterface

Overrides:

equals in class ValueObject

Returns:

a boolean result of the equals operation

getBinaryValue

public byte[] getBinaryValue()

This will return the current value of the ValueObject as a byte array. This is currently implmented only for a SecsFormat10 (binary) where it returns the byte array. All other SecsFormats will return the default which is the string value as a byte array.

Specified by:

getBinaryValue in interface ValueObjectInterface

Overrides:

getBinaryValue in class ValueObject

Returns:

the value as a String

getBoolValue

public boolean getBoolValue()

Returns the current value represented as a boolean. This is defined as true if the currentValue is not equal to 0, and false if it is.

Returns:

the current value as a boolean

getByteValue

public byte getByteValue()

Returns the current value represented as an byte.

Returns:

the current value as a byte

getCharValue

public char getCharValue()

Returns the current value represented as a char. In this case this means getStringValue().toCharArray()[0];

Returns:

the current value as a char

getDoubleValue

public double getDoubleValue()

Returns the current value represented as a float.

Returns:

the current value as a double

See Also:

ValueObjectInterface.getNumericValue()

getFloatValue

public float getFloatValue()

Returns the current value represented as an float.

Returns:

the current value as an float

getIntValue

public int getIntValue()

Returns the current value represented as an integer.

Returns:

the current value as an integer

getLongValue

public long getLongValue()

Returns the current value represented as a long.

Returns:

the current value as a long

getNumericValue

public double getNumericValue()
                       throws java.lang.NumberFormatException

Returns the double value, but will throw an exception if the object isn't convertable.

Returns:

the current value as a double

Throws:

java.lang.NumberFormatException

See Also:

ValueObjectInterface.getDoubleValue()

getObjectValue

public java.lang.Object getObjectValue()

Returns the current value represented as an Object.

Returns:

the current value as an Object

getSecsFormat

public SecsFormat getSecsFormat()

This will return the SecsFormat.

Returns:

the current value as a SecsFormat

getShortValue

public short getShortValue()

Returns the current value represented as a short.

Returns:

the current value as a short

getStringValue

public java.lang.String getStringValue()

Returns the current value represented as an String.

Returns:

the current value as a String