|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.monitor.TWGMonCurrentData
This is the TWGMonCurrentData. It is used to contain all relativent data associated with a datapoint that is received from a client. It is normally created by a subsystem in response to a get data or get recording data call. It may also be created to record return code information that indicates why a data was not available to create a data point. The set of return codes that are checked for from this class are:
This class is serialized between the console and the server.
,
Serialized FormConstructor Summary | |
---|---|
TWGMonCurrentData(int rc)
This is the constructor for the current data class. |
|
TWGMonCurrentData(IntelByteBuffer iBuf)
This is the constructor for building a monitor data point from data in an Intel Byte Buffer. |
|
TWGMonCurrentData(int rc,
int flags,
double numberData,
java.lang.String stringData,
java.lang.String formatStr)
This is the constructor for the current data class. |
|
TWGMonCurrentData(int rc,
int flags,
double numberData,
java.lang.String stringData,
java.lang.String formatStr,
long time)
This is the constructor for the current data class. |
|
TWGMonCurrentData(int rc,
int flags,
double numberData,
java.lang.String stringData,
java.lang.String formatStr,
long time,
java.lang.String unitsStr,
java.lang.String enumStr)
This is the constructor for the current data class. |
Method Summary | |
---|---|
void |
clearEnumType()
function to remove the enumerated data point id |
java.lang.Object |
clone()
Returns a clone of this attribute path. |
boolean |
equals(TWGMonCurrentData that)
THis method provides an equivalence check for data points |
int |
getDataType()
Gets the data type for the data point |
java.lang.String |
getDisplayString()
returns the object as a formatted string |
java.lang.String |
getEnumStr()
getter function to return enumeration string data from current data object |
java.lang.String |
getFormatStr()
getter function to return the format string |
IntelByteBuffer |
getIntelByteBuffer()
Writes the class variables out to a new'ed IntelByteBuffer |
int |
getIntelByteBufferSize()
Determines the IntelByteBuffer size requirement for this object |
double |
getNumberData()
getter function to return numeric data from current data object |
int |
getRC()
getter function to return return code from current data object |
java.lang.String |
getStringData()
getter function to return string data from current data object |
long |
getTimeStamp()
getter function to return the time stamp for the data object |
boolean |
isEnumType()
function to determine if this is an enumerated data point |
boolean |
isNumericData()
function to determine if this is a numeric data point |
boolean |
isStringData()
function to determine if this is a string data point |
void |
setEnumStr(java.lang.String parm)
enumeration string setter function |
void |
setFormatStr(java.lang.String parm)
format string setter function |
void |
setRC(int rc)
setter function to set return code for current data object |
void |
setUnitsStr(java.lang.String parm)
units string setter function |
java.lang.String |
toString()
returns the data contained within the object as a string |
IntelByteBuffer |
writeIntelByteBuffer(IntelByteBuffer iBuf)
Writes the state of the objects variables out to the passed in IntelByteBuffer |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public TWGMonCurrentData(int rc)
The description of this class of objects indicates what return code values are expected to be set in the object.
rc
- return code to reflect with the current data pointpublic TWGMonCurrentData(int rc, int flags, double numberData, java.lang.String stringData, java.lang.String formatStr)
The description of this class of objects indicates what return code values are expected to be set in the object.
rc
- return code to reflect with the current data pointflags
- flag word with information on the data present in the objectnumberData
- double value to set as the current value of the data pointstringData
- string value to set as the current value of the data pointformatStr
- string value to use to format the data (uses a simple
form of the format strings used by the printf function
found in the C library, as implemented by the
com.tivoli.libs.Format class).com.tivoli.twg.libs.Format
public TWGMonCurrentData(int rc, int flags, double numberData, java.lang.String stringData, java.lang.String formatStr, long time)
rc
- return code to reflect with the current data pointflags
- flag word with information on the data present in the objectnumberData
- double value to set as the current value of the data pointstringData
- string value to set as the current value of the data pointformatStr
- string value to use to format the data (uses a simple
form of the format strings used by the printf function
found in the C library, as implemented by the
com.tivoli.libs.Format class).time
- timestamp of when this data was collectedcom.tivoli.twg.libs.Format
public TWGMonCurrentData(int rc, int flags, double numberData, java.lang.String stringData, java.lang.String formatStr, long time, java.lang.String unitsStr, java.lang.String enumStr)
The description of this class of objects indicates what return code values are expected to be set in the object.
rc
- return code to reflect with the current data pointflags
- flag word with information on the data present in the objectnumberData
- double value to set as the current value of the data pointstringData
- string value to set as the current value of the data pointformatStr
- string value to use to format the data (uses a simple
form of the format strings used by the printf function
found in the C library, as implemented by the
com.tivoli.libs.Format class).time
- timestamp of when this data was collectedunitsStr
- Java-style format and/or label string to use
to format the data pointenumStr
- locale requested enumeration value to use
for this data pointcom.tivoli.twg.libs.Format
public TWGMonCurrentData(IntelByteBuffer iBuf)
iBuf
- Intel byte buffer with information to construct object fromMethod Detail |
public int getIntelByteBufferSize()
public IntelByteBuffer writeIntelByteBuffer(IntelByteBuffer iBuf)
iBuf
- byte buffer to save the state of the object into
public IntelByteBuffer getIntelByteBuffer()
public java.lang.Object clone()
public boolean isStringData()
public java.lang.String getStringData()
public java.lang.String getFormatStr()
public java.lang.String getEnumStr()
public boolean isNumericData()
public double getNumberData()
public boolean isEnumType()
public void clearEnumType()
public int getRC()
The description of this class of objects indicates what return code values are expected to be set in the object.
public long getTimeStamp()
public int getDataType()
public void setRC(int rc)
The description of this class of objects indicates what return code values are expected to be set in the object.
rc
- return code to set into the objectpublic boolean equals(TWGMonCurrentData that)
This method verifies that this data point and the datapoint tested against represent * equivalent information. The timeStamp, flags, data and return code are checked.
that
- the other data point to check for equality to
public java.lang.String getDisplayString()
public void setFormatStr(java.lang.String parm)
parm
- printf style format string. note: only one substitution
allowed in stringpublic void setEnumStr(java.lang.String parm)
parm
- locale requested enumeration string for this data valuepublic void setUnitsStr(java.lang.String parm)
parm
- locale requested units string for this data valuepublic java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |