public interface ValueObjectInterface
GenericValueObject
Modifier and Type | Field and Description |
---|---|
static char |
ANYTYPE
This is used by the beans to say that can handle any type of class.
|
static char |
ARRAYTYPE |
static char |
BINARYTYPE |
static char |
BOOLEANTYPE |
static char |
BYTETYPE |
static char |
CHARTYPE |
static java.lang.String |
DISPLAYVALUE
This will be called by active controls to ask a server for their in
current value.
|
static char |
DOUBLETYPE |
static char |
FLOATTYPE |
static java.lang.String |
GROUP_NAME
The property name for the current group.
|
static java.lang.String |
INITIALVALUE
This is used with the clientRequest when a client has a value that
should be stored in the datasource.
|
static char |
INTTYPE |
static java.lang.String |
LOG_MESSAGE
The property name for the message to be logged with the value.
|
static char |
LONGTYPE |
static java.lang.String |
NAME
The property name for the name (presumably of the source).
|
static char |
OBJECTTYPE |
static java.lang.String |
ORDER
This is used by the Connection Manager to add an order to the values for the client.
|
static java.lang.String |
PASSWORD_DIGEST
The property name for the current password digest.
|
static char |
PROPERTYTYPE |
static int |
QUALITY_BAD
This is used for any control or data source that has a problem,
or when a server just starts up and the data value has not yet been initialized.
|
static int |
QUALITY_COMM_FAILURE
This may be used for servers that connect to devices and the connection is lost.
|
static int |
QUALITY_DEVICE_FAILURE |
static int |
QUALITY_EGU_EXCEEDED |
static int |
QUALITY_EVALUATION_EXPIRED |
static int |
QUALITY_GOOD
The best data quality.
|
static int |
QUALITY_IMPOSSIBLE
Impossible quality caused by a connector loop (connector will be disabled)
|
static int |
QUALITY_INITIAL
Widely used.
|
static int |
QUALITY_LAST_USABLE
This value is sent as the server is removing a listener.
|
static int |
QUALITY_OUT_OF_SERVICE |
static int |
QUALITY_PROPERTYONLY |
static int |
QUALITY_REMOTE_PROXY_INIT |
static int |
QUALITY_SIMULATED
Indicate the that data is not real data, but simulated.
|
static int |
QUALITY_SOURCE_REMOVED
When a Connector is removed from a graphic, or some fundamental change occurs that causes the existing
value to be invalid then the quality is changed to SOURCE_REMOVED.
|
static int |
QUALITY_TRANSITIONAL
This is used when an active control has not "settled" on a value
|
static int |
QUALITY_UNKNOWN
This is a quality that is between good and bad, but still defined as unknown.
|
static int |
QUALITY_WARNING |
static int |
QUALITY_WORST
The worst (highest number) quality.
|
static int |
QUALITY_WRITE_IN_PROGRESS
When writing to some servers (notably PLCs) the value will be returned with this quality.
|
static java.lang.String |
REQUESTCURRENTVALUE
This will be called by active controls to ask a server for their in
current value.
|
static java.lang.String |
REQUESTHISTORICAL
This is used with the clientRequest when a client is requesting
historical data.
|
static long |
serialVersionUID |
static char |
SHORTTYPE |
static char |
STRINGTYPE |
static java.lang.String |
TRACE
If a property with this name exists and starts with a 'y' or 'Y' then
the value will be considered "traceable".
|
static char |
TWODTYPE |
static char |
UNSIGNEDBYTETYPE |
static char |
UNSIGNEDINTTYPE |
static char |
UNSIGNEDLONGTYPE |
static char |
UNSIGNEDSHORTTYPE |
static java.lang.String |
USER_NAME
The property name for the current user.
|
Modifier and Type | Method and Description |
---|---|
void |
acquirePropertiesFrom(ValueObjectInterface sourceValueObject)
This will use all the settings (other than the value and type) in sourceValueObject to "fill" these
corresponding attributes of this ValueObject.
|
java.util.Enumeration<java.lang.String> |
attributeNames()
This will return the enumeration of attributes.
|
int |
compareTo(ValueObjectInterface otherValueObject)
This is our implementation (for JDK 1.1 compatibility) of the Comparable
interface of Java 2.
|
ValueObjectInterface |
convertToLowestPrecisionNumber()
This will convert the value object type to the lowest precision numeric type,
without loss of precision.
|
ValueObjectInterface |
copy()
This will return a full copy of the ValueObject.
|
int |
decrementTTL()
Decrements and returns the ttl field.
|
boolean |
equals(java.lang.Object otherValueObject)
This method is in every subclass of Object.
|
boolean |
getAlwaysSend()
This will force the value to be sent to the client, even if the value hasn't
changed.
|
byte[] |
getBinaryValue()
This will return the current value of the ValueObject as a byte array.
|
boolean |
getBoolValue()
This will return the current value of the ValueObject as a boolean.
|
byte |
getByteValue()
This will return the current value of the ValueObject as a byte.
|
java.awt.Color |
getColor()
This will return the current Color of the Value Object.
|
java.util.Date |
getDate()
This will return the date that the value was created.
|
double |
getDoubleValue()
This will return the current value of the ValueObject as a double.
|
float |
getFloatValue()
This will return the current value of the ValueObject as a float.
|
int |
getIntValue()
This will return the current value of the ValueObject as a int.
|
java.util.Locale |
getLocale()
This method returns the Locale that this object was created in.
|
long |
getLongValue()
This will return the current value of the ValueObject as a long.
|
double |
getNumericValue()
This will return the current value as a double.
|
java.lang.Object |
getObjectValue()
This will return the current value of the ValueObject as an Object.
|
java.lang.Object |
getProperty(java.lang.String attribute)
This is additional information that is sent with the property.
|
int |
getQuality()
This will return the quality of the reading.
|
short |
getShortValue()
This will return the current value of the ValueObject as a short.
|
java.lang.String |
getStringValue()
This will return the current value of the ValueObject as a String.
|
double |
getTime()
This will return the time the value was created.
|
long |
getTimeMillis()
This will return the number of milliseconds since Jan 1st 1970.
|
int |
getTTL() |
char |
getType()
Returns the type that the was used to create the valueObject.
|
boolean |
replaces(ValueObjectInterface oldValue,
double deadband)
This will determine if this ValueObject should be sent out to
replace another ValueObject.
|
void |
setAlwaysSend(boolean newValue)
This will force the value to be sent to the client, even if the value hasn't
changed.
|
void |
setColor(java.awt.Color newValue)
This will set the ValueObject's color.
|
void |
setProperty(java.lang.String attribute,
java.lang.Object value)
This is additional information that is sent with the property.
|
void |
setQuality(int newValue)
This will set the quality of the reading.
|
void |
setTimeMillis(long dateTime)
This will set the time as the number of milliseconds since Jan 1st 1970.
|
void |
setTTL(int ttl) |
void |
setType(char newValue)
sets the type that the was used to create the valueObject.
|
java.lang.String |
toJSON()
Build a json representation of the object, structured:
{
"type": "object"|"array"|"2d",
"value": \
|
static final char ANYTYPE
static final char ARRAYTYPE
static final char BINARYTYPE
static final char BOOLEANTYPE
static final char BYTETYPE
static final char CHARTYPE
static final java.lang.String DISPLAYVALUE
static final char DOUBLETYPE
static final char FLOATTYPE
static final java.lang.String GROUP_NAME
static final java.lang.String INITIALVALUE
static final char INTTYPE
static final java.lang.String LOG_MESSAGE
static final char LONGTYPE
static final java.lang.String NAME
static final char OBJECTTYPE
static final java.lang.String ORDER
static final java.lang.String PASSWORD_DIGEST
static final char PROPERTYTYPE
static final int QUALITY_BAD
static final int QUALITY_COMM_FAILURE
static final int QUALITY_DEVICE_FAILURE
static final int QUALITY_EGU_EXCEEDED
static final int QUALITY_EVALUATION_EXPIRED
static final int QUALITY_GOOD
static final int QUALITY_IMPOSSIBLE
static final int QUALITY_INITIAL
static final int QUALITY_LAST_USABLE
static final int QUALITY_OUT_OF_SERVICE
static final int QUALITY_PROPERTYONLY
static final int QUALITY_REMOTE_PROXY_INIT
static final int QUALITY_SIMULATED
static final int QUALITY_SOURCE_REMOVED
static final int QUALITY_TRANSITIONAL
static final int QUALITY_UNKNOWN
static final int QUALITY_WARNING
static final int QUALITY_WORST
static final int QUALITY_WRITE_IN_PROGRESS
static final java.lang.String REQUESTCURRENTVALUE
static final java.lang.String REQUESTHISTORICAL
clientRequest
,
Constant Field Valuesstatic final long serialVersionUID
static final char SHORTTYPE
static final char STRINGTYPE
static final java.lang.String TRACE
static final char TWODTYPE
static final char UNSIGNEDBYTETYPE
static final char UNSIGNEDINTTYPE
static final char UNSIGNEDLONGTYPE
static final char UNSIGNEDSHORTTYPE
static final java.lang.String USER_NAME
void acquirePropertiesFrom(ValueObjectInterface sourceValueObject)
java.util.Enumeration<java.lang.String> attributeNames()
int compareTo(ValueObjectInterface otherValueObject)
otherValueObject
- the object to be compared toValueObjectInterface convertToLowestPrecisionNumber()
ValueObjectInterface copy()
int decrementTTL()
boolean equals(java.lang.Object otherValueObject)
equals
in class java.lang.Object
boolean getAlwaysSend()
setAlwaysSend(boolean)
byte[] getBinaryValue()
boolean getBoolValue()
byte getByteValue()
java.awt.Color getColor()
java.util.Date getDate()
double getDoubleValue()
getNumericValue()
float getFloatValue()
int getIntValue()
java.util.Locale getLocale()
long getLongValue()
double getNumericValue() throws java.lang.NumberFormatException
java.lang.NumberFormatException
getDoubleValue()
java.lang.Object getObjectValue()
java.lang.Object getProperty(java.lang.String attribute)
attribute
- additional informationsetProperty(java.lang.String, java.lang.Object)
int getQuality()
setQuality(int)
short getShortValue()
java.lang.String getStringValue()
double getTime()
long getTimeMillis()
int getTTL()
char getType()
Z boolean B byte C char S short I int J long F float D double s Sting L Object P Property A Any
boolean replaces(ValueObjectInterface oldValue, double deadband)
void setAlwaysSend(boolean newValue)
newValue
- a boolean setting the "always send" stategetAlwaysSend()
void setColor(java.awt.Color newValue)
the
- ValueObject Colorvoid setProperty(java.lang.String attribute, java.lang.Object value)
attribute
- the attribute Stringvalue
- the Serializable value of this attributegetProperty(java.lang.String)
void setQuality(int newValue)
newValue
- the data qualitygetQuality()
void setTimeMillis(long dateTime)
void setTTL(int ttl)
ttl
- The ttl to set.void setType(char newValue)
Z boolean B byte C char S short I int J long F float D double s Sting L Object P Property A Any
java.lang.String toJSON()
Copyright © 1999-2025 ErgoTech Systems, Inc. All Rights Reserved.