vib.servers
Class Ping

java.lang.Object
  |
  +--vib.servers.SimpleDataSource
        |
        +--vib.servers.DaliDataSourceSuper
              |
              +--vib.servers.Ping
All Implemented Interfaces:
vib.servers.DataSourceInterface, java.util.EventListener, java.io.Serializable, vib.utils.StaticMethodEventListener, vib.utils.Timeable, vib.utils.ValueChangedListener, vib.utils.VIBEventProducer

public class Ping
extends DaliDataSourceSuper

Pingt class provides Ping data source. Runs on time base value only. Pings the server to see if it is active

See Also:
Serialized Form

Field Summary
 java.lang.String label
           
 java.lang.String ServerURL
           
 
Fields inherited from class vib.servers.SimpleDataSource
alwaysSend, authGroups, autoKill, autoSuspend, colorHi, colorHiHi, colorLo, colorLoLo, currentColor, currentValue, customTimer, deadband, dontConnect, groups, initialValue, interlock, lastSentValue, myListeners, myRequiresSyncWrite, mySyncWriteTimeout, priority, requiresSyncWrite, sendColors, sendIfQualityIsBetterThan, sendIfQualityIsBetterThen, sharedTimer, started, suspended, syncTime, syncUserName, syncWriteTimeout, tagAgent, theEventHandler, theTagController, timebase, useInitialValue, valueHi, valueHiHi, valueLo, valueLoLo
 
Fields inherited from interface vib.servers.DataSourceInterface
INITIALVALUE, REQUESTCURRENTVALUE, REQUESTHISTORICAL
 
Fields inherited from interface vib.utils.VIBEventProducer
ACTIVEGRAPHIC_STOPPED, CLIENT_ATTACHED, CLIENT_REMOVED, SERVER_DISCONNECTING, SERVER_RESUMED, SERVER_STOPPED, SERVER_SUSPENDED, TAG_NAME_CREATED, TAG_NAME_UPDATED, UPDATE_FAILED
 
Constructor Summary
Ping()
          Ping Contructor.
 
Method Summary
 java.lang.String getLabel()
          This will return the current label without any characters switched.
 java.lang.String getServerURL()
          Gets current Dali Server URL
 void refreshCurrentValue()
          On time base value.
 void setLabel(java.lang.String newValue)
          This will update (change) the string being displayed as a marquee output.
 void setOption(java.lang.String newValue)
          This method is called for every single entry in the parameter list.
 void setServerURL(java.lang.String newURL)
          Sets the Dali Server URL.
 
Methods inherited from class vib.servers.SimpleDataSource
addListener, addListenerForId, addValueChangedListener, authenticatedClientRequest, authenticatedValueChanged, clientRequest, finalize, forceUpdate, getAlwaysSend, getBoolValue, getByteValue, getCharValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getCurrentColor, getCustomTimer, getDataSource, getDeadband, getDoubleValue, getFloatValue, getGroups, getInitialValue, getInterlock, getIntValue, getLongValue, getPriority, getRequiresSyncWrite, getSendColors, getSendIfQualityIsBetterThan, getSerializableObject, getServerList, getShortValue, getStaticLocationFor, getStringValue, getSyncWriteTimeout, getTagAgent, getTagName, getTimebase, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, getValueObject, getWritableDataSource, isAutoSuspend, isSuspended, isUseInitialValue, passesDeadband, registerTagName, removeListener, removeListenerForId, removeValueChangedListener, requestSyncWrite, resume, setAlwaysSend, setAutoSuspend, setBoolValue, setBoolValueInternal, setByteValue, setByteValueInternal, setCharValue, setCharValueInternal, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setCustomTimer, setDeadband, setDoubleValue, setDoubleValueInternal, setFloatValue, setFloatValueInternal, setGroups, setInitialValue, setInitialValueObject, setInterlock, setIntValue, setIntValueInternal, setLongValue, setLongValueInternal, setParameters, setPriority, setRequiresSyncWrite, setSendColors, setSendIfQualityIsBetterThan, setSerializableObject, setSerializableObjectInternal, setServerList, setShortValue, setShortValueInternal, setStringValue, setStringValueInternal, setSuspended, setSuspendedInternal, setSyncWriteTimeout, setTagAgent, setTagName, setTimebase, setUseInitialValue, setValue, setValueHi, setValueHiHi, setValueLo, setValueLoLo, setValueObject, setValueObjectInternal, stop, suspend, tick, toString, unregisterTagName, updateColor, updateCurrentColor, updateListener, updateListeners, valueChanged, valueChanged
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

label

public java.lang.String label

ServerURL

public java.lang.String ServerURL
Constructor Detail

Ping

public Ping()
Ping Contructor. Sets Dali Server URL, time base, etc to defaults.
Method Detail

refreshCurrentValue

public void refreshCurrentValue()
On time base value. Pings the Dali Server. If server active will return true, else false
Overrides:
refreshCurrentValue in class vib.servers.SimpleDataSource

setOption

public void setOption(java.lang.String newValue)
This method is called for every single entry in the parameter list. NOTICE: This can be called multiple times in one parameter list.
Parameters:
newValue - the new String value to display

setLabel

public void setLabel(java.lang.String newValue)
This will update (change) the string being displayed as a marquee output.
Parameters:
newValue - the string being displayed as a marquee output
See Also:
Writing VIB Data Sources: Get/Set Methods, getLabel()

getLabel

public java.lang.String getLabel()
This will return the current label without any characters switched.
Returns:
the current label
See Also:
Writing VIB Data Sources: Get/Set Methods, setLabel(java.lang.String)

setServerURL

public void setServerURL(java.lang.String newURL)
Sets the Dali Server URL. The Dali Server URL consists of the following:

An example URL is the following: "http://192.168.1:444/dali/soap/prom

Parameters:
newURL - the Dali Server url to set

getServerURL

public java.lang.String getServerURL()
Gets current Dali Server URL
Returns:
current Dali Server URL