This class is a wrapper for the Message Panel VI. This VI is where sample environment VIs should send their error messages or user questions; SECI should then collect the messages from the VI. Any replies are then sent back to the Message Panel VI which then forwards the reply to the original VI. More...

Collaboration diagram for Seci.Standard.MessageQueue:

Static Public Member Functions
static void	HideVI ()
	This method hides the message panel VI. More...

static void	InitialiseMessQVI ()
	This method load the message panel VI and starts it running. More...

static void	SendReply (String questionMessage, String source, Boolean reply)
	This method handles any user replies to messages, just updates the SECI copy. More...

static void	ShowVI ()
	This method makes the message panel VI visible (only recommended when debugging). More...

static Boolean	UpdateMessages ()
	This method is called when it is time to check for changes to the message panel VI. It checks to see if any new messages have arrived, if any old messages have timed out, and if the user has dismissed any messages. More...

Properties
static SerialisableList < MessageInfo >	Messages `[get]`

Static Private Member Functions
static Boolean	getMessageQ ()
	This method get the latest message information from the messgae panel VI. The method checks for any new messages and returns true if it finds any. If the message is a repeat of an existing message, the count attribute of the existing message is incremented. The messages are in a cluster on the VI. More...

static Boolean	removeMessages ()
	This method checks to see if any messages have been responded to by the user or timed out. If so the answer is sent back to the message panel VI. More...

Static Private Attributes
static int	_defaultPeriod = 60

static String	_filePath

static SerialisableList < MessageInfo >	_messages = new SerialisableList<MessageInfo>()
	The messages get put in here. More...

static int	_timeoutTime = 1

Detailed Description

This class is a wrapper for the Message Panel VI. This VI is where sample environment VIs should send their error messages or user questions; SECI should then collect the messages from the VI. Any replies are then sent back to the Message Panel VI which then forwards the reply to the original VI.

Definition at line 16 of file LabViewMessageQueue.cs.

Member Function Documentation

static Boolean Seci.Standard.MessageQueue.getMessageQ ( )

inlinestaticprivate

This method get the latest message information from the messgae panel VI. The method checks for any new messages and returns true if it finds any. If the message is a repeat of an existing message, the count attribute of the existing message is incremented. The messages are in a cluster on the VI.

Returns: Boolean indicating whether a new message has been found

Definition at line 82 of file LabViewMessageQueue.cs.

References Seci.Standard.MessageInfo.Message, Seci.Standard.MessageInfo.Timestamp, and Seci.Standard.MessageInfo.UserReplied.

static void Seci.Standard.MessageQueue.HideVI ( )

inlinestatic

This method hides the message panel VI.

Definition at line 55 of file LabViewMessageQueue.cs.

static void Seci.Standard.MessageQueue.InitialiseMessQVI ( )

inlinestatic

This method load the message panel VI and starts it running.

Definition at line 33 of file LabViewMessageQueue.cs.

static Boolean Seci.Standard.MessageQueue.removeMessages ( )

inlinestaticprivate

This method checks to see if any messages have been responded to by the user or timed out. If so the answer is sent back to the message panel VI.

Returns: Boolean indicating whether a reply was sent

Definition at line 199 of file LabViewMessageQueue.cs.

static void Seci.Standard.MessageQueue.SendReply	(	String	questionMessage,
		String	source,
		Boolean	reply
	)

inlinestatic

This method handles any user replies to messages, just updates the SECI copy.

Parameters

questionMessage	The message from the VI
source	The VI from which the message came from
reply	The reply from the user

Definition at line 287 of file LabViewMessageQueue.cs.

static void Seci.Standard.MessageQueue.ShowVI ( )

inlinestatic

This method makes the message panel VI visible (only recommended when debugging).

Definition at line 47 of file LabViewMessageQueue.cs.

static Boolean Seci.Standard.MessageQueue.UpdateMessages ( )

inlinestatic

This method is called when it is time to check for changes to the message panel VI. It checks to see if any new messages have arrived, if any old messages have timed out, and if the user has dismissed any messages.

Returns: Boolean representing whether the messages have changed since the last check

Definition at line 66 of file LabViewMessageQueue.cs.

Member Data Documentation

int Seci.Standard.MessageQueue._defaultPeriod = 60

staticprivate

Definition at line 25 of file LabViewMessageQueue.cs.

String Seci.Standard.MessageQueue._filePath

staticprivate

Definition at line 18 of file LabViewMessageQueue.cs.

SerialisableList<MessageInfo> Seci.Standard.MessageQueue._messages = new SerialisableList<MessageInfo>()

staticprivate

The messages get put in here.

Definition at line 21 of file LabViewMessageQueue.cs.

int Seci.Standard.MessageQueue._timeoutTime = 1

staticprivate

Definition at line 24 of file LabViewMessageQueue.cs.

Property Documentation

SerialisableList<MessageInfo> Seci.Standard.MessageQueue.Messages

staticget

Definition at line 28 of file LabViewMessageQueue.cs.

The documentation for this class was generated from the following file:

/isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Seci/Standard/LabViewMessageQueue.cs

Static Public Member Functions

Properties

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation