vib.servers
Class DIOReadBackBit

java.lang.Object
  |
  +--vib.servers.SimpleDataSource
        |
        +--vib.servers.DaliDataSourceSuper
              |
              +--vib.servers.DIOReadBackBit
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 DIOReadBackBit
extends DaliDataSourceSuper

DIOReadBackBit class provides DIO Read Back Bit data source. Runs on trigger and time base value. Reads from the Dali Server the last DIO bit value written to the port/channel's specified bit

See Also:
Serialized Form

Field Summary
 boolean authen
           
 int bit
           
 int channel
           
 java.lang.String label
           
 java.lang.String Password
           
 java.lang.String ServerURL
           
 java.lang.String Username
           
 
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
DIOReadBackBit()
          DIOReadBackBit Contructor.
 
Method Summary
 boolean getAuthen()
          Gets value of whether Authentication is used
 int getBit()
          Gets the current bit
 int getChannel()
          Gets the current channel value
 java.lang.String getLabel()
          This will return the current label without any characters switched.
 java.lang.String getPassword()
          Gets password
 java.lang.String getServerURL()
          Gets current Dali Server URL
 java.lang.String getUsername()
          Gets Username
 void refreshCurrentValue()
          On time base value.
 void setAuthen(boolean newAuthen)
          Sets true or false as to whether to use Authentication
 void setBit(int newBit)
          Sets the bit to be written to
 void setChannel(int newChannel)
          Sets the channel 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 setPassword(java.lang.String newPassword)
          Sets password for authentication
 void setServerURL(java.lang.String newURL)
          Sets the Dali Server URL.
 void setUsername(java.lang.String newUsername)
          Sets username for authentication
 void setValueObject(vib.utils.ValueObjectInterface newValue)
          Function called upon trigger.
 
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, 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

Username

public java.lang.String Username

Password

public java.lang.String Password

authen

public boolean authen

channel

public int channel

bit

public int bit
Constructor Detail

DIOReadBackBit

public DIOReadBackBit()
DIOReadBackBit Contructor. Sets channel, Dali Server URL, etc to defaults.
Method Detail

refreshCurrentValue

public void refreshCurrentValue()
On time base value. Performs a Dali Java call of DIOReadBackBit. Reads back the last bit value written to the port/channel's specified bit.
Overrides:
refreshCurrentValue in class vib.servers.SimpleDataSource

setValueObject

public void setValueObject(vib.utils.ValueObjectInterface newValue)
                    throws vib.utils.VIBUpdateFailedException
Function called upon trigger. Performs a Dali Java call of DIOReadBackBit. Reads back the last bit value written to the port/channel's specified bit.
Overrides:
setValueObject in class vib.servers.SimpleDataSource
Parameters:
newValue - parameter not used

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)

setChannel

public void setChannel(int newChannel)
Sets the channel value
Parameters:
newChannel - the new channel value to be set

getChannel

public int getChannel()
Gets the current channel value
Returns:
the current channel

setBit

public void setBit(int newBit)
Sets the bit to be written to
Parameters:
newBit - the new bit value to be set

getBit

public int getBit()
Gets the current bit
Returns:
the current bit

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

setAuthen

public void setAuthen(boolean newAuthen)
Sets true or false as to whether to use Authentication
Parameters:
newAuthen - boolean value of whether to use authentication

getAuthen

public boolean getAuthen()
Gets value of whether Authentication is used
Returns:
true/false

setUsername

public void setUsername(java.lang.String newUsername)
Sets username for authentication
Parameters:
newUsername - username to set

getUsername

public java.lang.String getUsername()
Gets Username
Returns:
current username

setPassword

public void setPassword(java.lang.String newPassword)
Sets password for authentication
Parameters:
newPassword - password to set

getPassword

public java.lang.String getPassword()
Gets password
Returns:
current password