[Jmri-commits] jmri Sensor.java,1.11,1.12

[Kevin D. <kev...@us...>]

Update of /cvsroot/jmri/jmri
In directory vz-cvs-3.sog:/tmp/cvs-serv14287

Modified Files:
	Sensor.java 
Log Message:
Update java doc

Index: Sensor.java
===================================================================
RCS file: /cvsroot/jmri/jmri/Sensor.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** Sensor.java	17 May 2011 17:35:06 -0000	1.11
--- Sensor.java	18 May 2011 15:42:40 -0000	1.12
***************
*** 84,96 ****
      public void dispose();  // remove _all_ connections!
      
      public void setSensorDebounceGoingActiveTimer(long timer);
      public long getSensorDebounceGoingActiveTimer();
      
      public void setSensorDebounceGoingInActiveTimer(long timer);
      public long getSensorDebounceGoingInActiveTimer();
      
      public void useDefaultTimerSettings(boolean boo);
      public boolean useDefaultTimerSettings();
- 
  }
  
--- 84,126 ----
      public void dispose();  // remove _all_ connections!
      
+     /**
+      * Used to return the Raw state of a sensor prior to the known state of a 
+      * sensor being set. The raw state value can be different when the sensor 
+      * debounce option is used.
+      * @return raw state value
+      */
+     public int getRawState();
+     
+     /**
+     * Set the Active debounce delay in milliSeconds.
+     * If a zero value is entered then debounce delay is de-activated.
+     */
      public void setSensorDebounceGoingActiveTimer(long timer);
+     
+     /**
+     * Get the Active debounce delay in milliSeconds.
+     */
      public long getSensorDebounceGoingActiveTimer();
      
+     /**
+     * Set the InActive debounce delay in milliSeconds.
+     * If a zero value is entered then debounce delay is de-activated.
+     */
      public void setSensorDebounceGoingInActiveTimer(long timer);
+     
+     /**
+     * Get the InActive debounce delay in milliSeconds.
+     */
      public long getSensorDebounceGoingInActiveTimer();
      
+     /**
+     * Use the timers specified in the Sensor manager, for the debounce delay
+     */
      public void useDefaultTimerSettings(boolean boo);
+     
+     /**
+     * Does this sensor use the default timers for 
+     */
      public boolean useDefaultTimerSettings();
  }