This class is used for checking to see if the LabVIEW messages received from the message panel VI have changed. It contains an instance of the BackgroundWorker class that is used as a separate thread for retrieving the current information, and an instance of the Timer class which fires off the BackgroundWorker every x milliseconds. An event is raised if the messages have changed.
More...
|
void | Dispose () |
| The dispose method to be called from code. More...
|
|
| LvmqUpdater (int updateRate) |
| Constructor. Initialises the BackgroundWorker object. More...
|
|
void | PauseUpdater () |
| Method for pausing the timer. This is done by setting the delay and period to infinity. More...
|
|
void | ResumeUpdater () |
| Method for resuming the timer. This is done by setting the delay and period to their normal values. More...
|
|
void | StartUpdater () |
| Method for starting the timer that fires off the update thread. More...
|
|
|
virtual void | Dispose (bool disposing) |
| If the value passed it true then the method has been called directly or indirectly from SECI code. If the value passed is false then the method has been called by the runtime from inside the finalizer. More...
|
|
|
void | backgroundUpdater_DoWork (object sender, System.ComponentModel.DoWorkEventArgs e) |
| The method that is run on the BackgroundWorker thread. More...
|
|
void | backgroundUpdater_RunWorkerCompleted (object sender, System.ComponentModel.RunWorkerCompletedEventArgs e) |
| The method that is run once the BackgroundWorker thread is finished. This raises an OnChangeToLVMessages event. More...
|
|
void | updateTimer_Tick (object obj) |
| The method that is called when the timer ticks. If the BackgroundWorker thread is not busy it will request that it starts running. More...
|
|
This class is used for checking to see if the LabVIEW messages received from the message panel VI have changed. It contains an instance of the BackgroundWorker class that is used as a separate thread for retrieving the current information, and an instance of the Timer class which fires off the BackgroundWorker every x milliseconds. An event is raised if the messages have changed.
Definition at line 17 of file LVMQUpdater.cs.
Seci.LabView.LvmqUpdater.LvmqUpdater |
( |
int |
updateRate | ) |
|
|
inline |
Constructor. Initialises the BackgroundWorker object.
- Parameters
-
updateRate | The rate at which the values should be updated in milliseconds |
Definition at line 36 of file LVMQUpdater.cs.
void Seci.LabView.LvmqUpdater.backgroundUpdater_DoWork |
( |
object |
sender, |
|
|
System.ComponentModel.DoWorkEventArgs |
e |
|
) |
| |
|
inlineprivate |
void Seci.LabView.LvmqUpdater.backgroundUpdater_RunWorkerCompleted |
( |
object |
sender, |
|
|
System.ComponentModel.RunWorkerCompletedEventArgs |
e |
|
) |
| |
|
inlineprivate |
The method that is run once the BackgroundWorker thread is finished. This raises an OnChangeToLVMessages event.
- Parameters
-
sender | The sender |
e | The event arguments |
Definition at line 143 of file LVMQUpdater.cs.
void Seci.LabView.LvmqUpdater.Dispose |
( |
| ) |
|
|
inline |
The dispose method to be called from code.
Definition at line 158 of file LVMQUpdater.cs.
virtual void Seci.LabView.LvmqUpdater.Dispose |
( |
bool |
disposing | ) |
|
|
inlineprotectedvirtual |
If the value passed it true then the method has been called directly or indirectly from SECI code. If the value passed is false then the method has been called by the runtime from inside the finalizer.
- Parameters
-
disposing | Indicates where the call has come from |
Definition at line 177 of file LVMQUpdater.cs.
void Seci.LabView.LvmqUpdater.PauseUpdater |
( |
| ) |
|
|
inline |
Method for pausing the timer. This is done by setting the delay and period to infinity.
Definition at line 67 of file LVMQUpdater.cs.
void Seci.LabView.LvmqUpdater.ResumeUpdater |
( |
| ) |
|
|
inline |
Method for resuming the timer. This is done by setting the delay and period to their normal values.
Definition at line 78 of file LVMQUpdater.cs.
void Seci.LabView.LvmqUpdater.StartUpdater |
( |
| ) |
|
|
inline |
Method for starting the timer that fires off the update thread.
Definition at line 55 of file LVMQUpdater.cs.
void Seci.LabView.LvmqUpdater.updateTimer_Tick |
( |
object |
obj | ) |
|
|
inlineprivate |
The method that is called when the timer ticks. If the BackgroundWorker thread is not busy it will request that it starts running.
- Parameters
-
obj | The state of the sender |
Definition at line 91 of file LVMQUpdater.cs.
BackgroundWorker Seci.LabView.LvmqUpdater._backgroundUpdater |
|
private |
Boolean Seci.LabView.LvmqUpdater._messagesChanged |
|
private |
TimerCallback Seci.LabView.LvmqUpdater._updateCallBack |
|
private |
int Seci.LabView.LvmqUpdater._updateRate = 3000 |
|
private |
Timer Seci.LabView.LvmqUpdater._updateTimer |
|
private |
EventHandler Seci.LabView.LvmqUpdater.OnChangeToLVMessages |
Event for indicating to the GUI level that the values were updated.
Definition at line 29 of file LVMQUpdater.cs.
EventHandler Seci.LabView.LvmqUpdater.OnLabviewNotThere |
The documentation for this class was generated from the following file:
- /isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Seci/LabView/LVMQUpdater.cs