gov.nasa.gsfc.drl.rtstps.core.status
Class TextStatusItem

java.lang.Object
  extended by gov.nasa.gsfc.drl.rtstps.core.status.StatusItem
      extended by gov.nasa.gsfc.drl.rtstps.core.status.TextStatusItem
All Implemented Interfaces:
java.io.Serializable

public final class TextStatusItem
extends StatusItem
implements java.io.Serializable

This is a text status item. It usually holds states.

See Also:
Serialized Form

Field Summary
private static long serialVersionUID
           
 java.lang.String value
          The string status value.
 
Fields inherited from class gov.nasa.gsfc.drl.rtstps.core.status.StatusItem
clearable
 
Constructor Summary
TextStatusItem(java.lang.String label)
          Create a TextStatusItem with the given name.
TextStatusItem(java.lang.String label, java.lang.String initialValue)
          Create a TextStatusItem with the given name and initial value.
 
Method Summary
 void clear()
          Clear this status item.
 java.lang.String getValue()
          Get this item's value as a string.
 
Methods inherited from class gov.nasa.gsfc.drl.rtstps.core.status.StatusItem
getName, isClearable, setClearable, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

value

public java.lang.String value
The string status value. It is public because the RT-STPS nodes that set it will access it directly.


serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

TextStatusItem

public TextStatusItem(java.lang.String label)
Create a TextStatusItem with the given name.


TextStatusItem

public TextStatusItem(java.lang.String label,
                      java.lang.String initialValue)
Create a TextStatusItem with the given name and initial value.

Method Detail

getValue

public final java.lang.String getValue()
Get this item's value as a string.

Specified by:
getValue in class StatusItem

clear

public void clear()
Clear this status item. Nothing happens if the item is not clearable. By default, it is set to an empty string if clearable.

Specified by:
clear in class StatusItem