READERNAME ReaderModuleOnPowerState.java - Revision history

Matt: Reverted edits by Amesycyxa (Talk); changed back to last version by Kyle

2010-11-26T19:40:00Z

Reverted edits by Amesycyxa (Talk); changed back to last version by Kyle

Amesycyxa at 08:32, 24 November 2010

2010-11-24T08:32:27Z

Kyle at 00:35, 12 February 2008

2008-02-12T00:35:49Z

Kyle: /* turnOff */

2008-02-11T22:57:24Z

‎turnOff

Kyle: New page: This class needs to be implemented for each reader to handle the state transitions from on->off and from on->suspend. It should extend AbstractOnPowerState. =turnOff= This method should...

2008-02-11T22:50:48Z

New page: This class needs to be implemented for each reader to handle the state transitions from on->off and from on->suspend. It should extend AbstractOnPowerState. =turnOff= This method should...

New page

This class needs to be implemented for each reader to handle the state transitions from on->off and from on->suspend. It should extend AbstractOnPowerState.

=turnOff=

This method should turn the reader and all of its components off.

<pre>public void turnOff(PowerControllable pcObject, Class callingClass) </pre>

==Arguments==
#pcObject - The ReaderModule
#callingClass - The class that called the turnOff method

==Reference Implementation==
This is the implementation of the turnOff() method in the Symbol Reader. It basically turns off its two communication objects and controllers. It turns off the controllers by calling their respective turn off methods. It then turns off the communication by turning off each communication object's power and connection signal (Each Communication object has a control signal that represents the whether or not the communication is 'on', and another control signal that represents whether or not the communication is 'connected' to client). Finally, this method moves the symbol reader into the 'off' state by calling the 'changePowerState' method. This method doesn't do anything but declare that the reader is now off.

This method is typical of what needs to happen to turn a reader off; however some reader may need to do other things. For example, if the reader has an autonomous mode, the autonomous mode may need to be turned off.
<pre>
public void turnOff(PowerControllable pcObject, Class callingClass) {
SymbolReaderModule rm = (SymbolReaderModule) pcObject;
rm.getInteractiveBitController().turnOff(this.getClass());
rm.getInteractiveHttpController().turnOff(this.getClass());

rm.getSharedResources().getInteractiveBytePowerSignal()
.setControlVariableValue(false);
rm.getSharedResources().getInteractiveHttpPowerSignal()
.setControlVariableValue(false);
rm.getSharedResources().getInteractiveByteConnectionSignal()
.setControlVariableValue(false);
rm.getSharedResources().getInteractiveHttpConnectionSignal()
.setControlVariableValue(false);

SymbolReaderSharedResources ssr = rm.getSharedResources();

rm.changePowerState(SymbolReaderModuleOffPowerState.getInstance());

String readername = rm.getSharedResources().getReaderName();
LogFactory.getLog("console." + readername).info(readername + " off");
}
</pre>

=turnOff=

This method should turn the reader and all of its components off.

<pre>public void turnOff(PowerControllable pcObject, Class callingClass) </pre>

==Arguments==
#pcObject - The ReaderModule
#callingClass - The class that called the turnOff method

==Reference Implementation==
This is the implementation of the turnOff() method in the Symbol Reader. It basically turns off its two communication objects and controllers. It turns off the controllers by calling their respective turn off methods. It then turns off the communication by turning off each communication object's power and connection signal (Each Communication object has a control signal that represents the whether or not the communication is 'on', and another control signal that represents whether or not the communication is 'connected' to client). Finally, this method moves the symbol reader into the 'off' state by calling the 'changePowerState' method. This method doesn't do anything but declare that the reader is now off.

This method is typical of what needs to happen to turn a reader off; however some reader may need to do other things. For example, if the reader has an autonomous mode, the autonomous mode may need to be turned off.
<pre>
public void turnOff(PowerControllable pcObject, Class callingClass) {
SymbolReaderModule rm = (SymbolReaderModule) pcObject;
rm.getInteractiveBitController().turnOff(this.getClass());
rm.getInteractiveHttpController().turnOff(this.getClass());

rm.getSharedResources().getInteractiveBytePowerSignal()
.setControlVariableValue(false);
rm.getSharedResources().getInteractiveHttpPowerSignal()
.setControlVariableValue(false);
rm.getSharedResources().getInteractiveByteConnectionSignal()
.setControlVariableValue(false);
rm.getSharedResources().getInteractiveHttpConnectionSignal()
.setControlVariableValue(false);

SymbolReaderSharedResources ssr = rm.getSharedResources();

rm.changePowerState(SymbolReaderModuleOffPowerState.getInstance());

String readername = rm.getSharedResources().getReaderName();
LogFactory.getLog("console." + readername).info(readername + " off");
}
</pre>

@@ Line 1: / Line 1: @@
 [[category:developerDoc]][[category:emulatorDoc]]
-This class needs to be implemented for each reader to handle the state transitions from on-&gt;off and from on-&gt;suspend.  It should extend AbstractOnPowerState.
+This class needs to be implemented for each reader to handle the state transitions from on->off and from on->suspend.  It should extend AbstractOnPowerState.
 =turnOff=
@@ Line 7: / Line 6: @@
 This method should turn the reader and all of its components off.
-&lt;pre&gt;public void turnOff(PowerControllable pcObject, Class callingClass) &lt;/pre&gt;
+<pre>public void turnOff(PowerControllable pcObject, Class callingClass) </pre>
 ==Arguments==
@@ Line 18: / Line 17: @@
 This method is typical of what needs to happen to turn a reader off; however some reader may need to do other things.  For example, if the reader has an autonomous mode, the autonomous mode may need to be turned off.
-&lt;pre&gt;
+<pre>
 	public void turnOff(PowerControllable pcObject, Class callingClass) {
 		SymbolReaderModule rm = (SymbolReaderModule) pcObject;
@@ Line 38: / Line 37: @@
 		String readername = rm.getSharedResources().getReaderName();
-		LogFactory.getLog(&quot;console.&quot; + readername).info(readername + &quot; off&quot;);
+		LogFactory.getLog("console." + readername).info(readername + " off");
+	}
-&lt;/pre&gt;
+</pre>
@@ Line 47: / Line 46: @@
 This method moves the reader into the suspended state.  Readers should be able to be 'suspended' and 'resumed' so that functions like 'pause' will work in Rifidi Designer.  For the most part, suspend should just queue incoming and outgoing messages.  This functionality works by just suspending the communication that the reader is using.  The complication comes in when a reader needs to be suspended while in autonomous mode.
-&lt;pre&gt;public void suspend(PowerControllable pcObject) &lt;/pre&gt;
+<pre>public void suspend(PowerControllable pcObject) </pre>
 ==Arguments==
@@ Line 56: / Line 55: @@
 Note that because the reader does not have an autonomous mode that is implemented it does not need to do anything else.  The LLRP reader does, however, have an autonomous mode, and so it needs to make sure the autonomous mode is suspended.  See that reader's OnPowerState class to see how it suspends its autonomous mode.
-&lt;pre&gt;
+<pre>
 	public void suspend(PowerControllable pcObject) {
 		SymbolReaderModule rm = (SymbolReaderModule) pcObject;
@@ Line 71: / Line 70: @@
 		String readername = rm.getSharedResources().getReaderName();
-		LogFactory.getLog(&quot;console.&quot; + readername).info(readername + &quot; suspended&quot;);
+		LogFactory.getLog("console." + readername).info(readername + " suspended");
+	}
-&lt;/pre&gt;
+</pre>

@@ Line 1: / Line 1: @@
 [[category:developerDoc]][[category:emulatorDoc]]
-This class needs to be implemented for each reader to handle the state transitions from on->off and from on->suspend.  It should extend AbstractOnPowerState.
+This class needs to be implemented for each reader to handle the state transitions from on-&gt;off and from on-&gt;suspend.  It should extend AbstractOnPowerState.
 =turnOff=
@@ Line 6: / Line 7: @@
 This method should turn the reader and all of its components off.
-<pre>public void turnOff(PowerControllable pcObject, Class callingClass) </pre>
+&lt;pre&gt;public void turnOff(PowerControllable pcObject, Class callingClass) &lt;/pre&gt;
 ==Arguments==
@@ Line 17: / Line 18: @@
 This method is typical of what needs to happen to turn a reader off; however some reader may need to do other things.  For example, if the reader has an autonomous mode, the autonomous mode may need to be turned off.
-<pre>
+&lt;pre&gt;
 	public void turnOff(PowerControllable pcObject, Class callingClass) {
 		SymbolReaderModule rm = (SymbolReaderModule) pcObject;
@@ Line 37: / Line 38: @@
 		String readername = rm.getSharedResources().getReaderName();
-		LogFactory.getLog("console." + readername).info(readername + " off");
+		LogFactory.getLog(&quot;console.&quot; + readername).info(readername + &quot; off&quot;);
+	}
-</pre>
+&lt;/pre&gt;
@@ Line 46: / Line 47: @@
 This method moves the reader into the suspended state.  Readers should be able to be 'suspended' and 'resumed' so that functions like 'pause' will work in Rifidi Designer.  For the most part, suspend should just queue incoming and outgoing messages.  This functionality works by just suspending the communication that the reader is using.  The complication comes in when a reader needs to be suspended while in autonomous mode.
-<pre>public void suspend(PowerControllable pcObject) </pre>
+&lt;pre&gt;public void suspend(PowerControllable pcObject) &lt;/pre&gt;
 ==Arguments==
@@ Line 55: / Line 56: @@
 Note that because the reader does not have an autonomous mode that is implemented it does not need to do anything else.  The LLRP reader does, however, have an autonomous mode, and so it needs to make sure the autonomous mode is suspended.  See that reader's OnPowerState class to see how it suspends its autonomous mode.
-<pre>
+&lt;pre&gt;
 	public void suspend(PowerControllable pcObject) {
 		SymbolReaderModule rm = (SymbolReaderModule) pcObject;
@@ Line 70: / Line 71: @@
 		String readername = rm.getSharedResources().getReaderName();
-		LogFactory.getLog("console." + readername).info(readername + " suspended");
+		LogFactory.getLog(&quot;console.&quot; + readername).info(readername + &quot; suspended&quot;);
+	}
-</pre>
+&lt;/pre&gt;

← Older revision		Revision as of 00:35, 12 February 2008
Line 1:		Line 1:
		+	[[category:developerDoc]][[category:emulatorDoc]]
	This class needs to be implemented for each reader to handle the state transitions from on->off and from on->suspend. It should extend AbstractOnPowerState.		This class needs to be implemented for each reader to handle the state transitions from on->off and from on->suspend. It should extend AbstractOnPowerState.

@@ Line 41: / Line 41: @@
-=turnOff=
+=suspend=
-This method should turn the reader and all of its components off.
+This method moves the reader into the suspended state.  Readers should be able to be 'suspended' and 'resumed' so that functions like 'pause' will work in Rifidi Designer.  For the most part, suspend should just queue incoming and outgoing messages.  This functionality works by just suspending the communication that the reader is using.  The complication comes in when a reader needs to be suspended while in autonomous mode.
-<pre>public void turnOff(PowerControllable pcObject, Class callingClass) </pre>
+<pre>public void suspend(PowerControllable pcObject) </pre>
 ==Arguments==
 #pcObject - The ReaderModule
 ==Reference Implementation==
-This is the implementation of the turnOff() method in the Symbol Reader.  It basically turns off its two communication objects and controllers.  It turns off the controllers by calling their respective turn off methods.  It then turns off the communication by turning off each communication object's power and connection signal (Each Communication object has a control signal that represents the whether or not the communication is 'on', and another control signal that represents whether or not the communication is 'connected' to client).  Finally, this method moves the symbol reader into the 'off' state by calling the 'changePowerState' method.  This method doesn't do anything but declare that the reader is now off.
+This is the implementation of the suspend() method in the Symbol Reader. It works by suspending its communication and controllers.  Then it moves the reader into the SuspendedState by calling the changePowerState() method.
-This method is typical of what needs to happen to turn a reader off; however some reader may need to do other things.  For example, if the reader has an autonomous mode, the autonomous mode may need to be turned off.
+Note that because the reader does not have an autonomous mode that is implemented it does not need to do anything else.  The LLRP reader does, however, have an autonomous mode, and so it needs to make sure the autonomous mode is suspended.  See that reader's OnPowerState class to see how it suspends its autonomous mode.
 <pre>
-	public void turnOff(PowerControllable pcObject, Class callingClass) {
+	public void suspend(PowerControllable pcObject) {
 		SymbolReaderModule rm = (SymbolReaderModule) pcObject;
-		rm.getInteractiveBitController().turnOff(this.getClass());
+		rm.getHttpComm().suspend();
-		rm.getInteractiveHttpController().turnOff(this.getClass());
+		rm.getByteComm().suspend();
+		rm.getInteractiveBitController().suspend();
-		rm.getSharedResources().getInteractiveBytePowerSignal()
+		rm.getInteractiveHttpController().suspend();
-				.setControlVariableValue(false);
-		rm.getSharedResources().getInteractiveHttpPowerSignal()
-				.setControlVariableValue(false);
-		rm.getSharedResources().getInteractiveByteConnectionSignal()
-				.setControlVariableValue(false);
-		rm.getSharedResources().getInteractiveHttpConnectionSignal()
-				.setControlVariableValue(false);
 		SymbolReaderSharedResources ssr = rm.getSharedResources();
-		rm.changePowerState(SymbolReaderModuleOffPowerState.getInstance());
+		rm.changePowerState(SymbolReaderModuleSuspendedPowerState.getInstance());
 		String readername = rm.getSharedResources().getReaderName();
-		LogFactory.getLog("console." + readername).info(readername + " off");
+		LogFactory.getLog("console." + readername).info(readername + " suspended");
+	}
 </pre>