This class inherits from LVControl class and is specialised for Ring controls. A Ring is like an enum, except rather than have a numeric value it can be a string. Its functionality is almost exactly the same as that of the LVRadioButton class. More...

Inheritance diagram for Seci.LabView.Controls.LvRing:

Collaboration diagram for Seci.LabView.Controls.LvRing:

Public Member Functions
override String	GetControlType ()

override String	GetNameAndType ()
	Overriden method which return the name and type of the control. More...

override String[]	GetValue (ref strongnameLabview.VirtualInstrument vi)
	Overriden method for getting the current selected value of the Control. LabVIEW returns an int corresponding to the selected item, so that value is used to find the corresponding value in _items. If _items is null then return the raw value as a String. More...

	LvRing (String name, String[] items, SerialisableList< int > indices)
	Constructor More...

override void	SetValue (ref strongnameLabview.VirtualInstrument vi, Object value)
	Overriden method for setting the selected value in the Control. The value received could be a String or an int corresponding to the selected value or the index respectively. If it is a String, then the matching index has to be looked up in _items. More...

Private Attributes
String[]	_items
	Stores the values of the selectable options. More...

Additional Inherited Members
Protected Member Functions inherited from Seci.LabView.Controls.LvControl
Object[]	GetValueFromCluster (strongnameLabview.VirtualInstrument vi)
	Method for returning a cluster value from the front panel. The cluster contains the required control value for this class. More...

void	SetValueInCluster (ref strongnameLabview.VirtualInstrument vi, Object value)
	Method for setting a value in a cluster. Individual values in the cluster cannot be set, the whole thing must be set. This method reads the whole cluster, changes the relevant value and sends the whole cluster back. There is a risk that the actual cluster may have be changed between the reading and writing, and those changes will be overwritten with the older values. As this method is quick it is hoped that this won't be a problem. A better solution would be not to have clusters that contain values that might need to be set via DCOM, but this is not always possible. More...

Protected Attributes inherited from Seci.LabView.Controls.LvControl
SerialisableList< int >	_clusterIndices
	If the control is in a cluster then the index is stored in a SerialisableList. A SerialisableList is used as it provides a Clone method. More...

String	_name
	The name of the control. More...

Properties inherited from Seci.LabView.Controls.LvControl
String	Name `[get]`

Detailed Description

This class inherits from LVControl class and is specialised for Ring controls. A Ring is like an enum, except rather than have a numeric value it can be a string. Its functionality is almost exactly the same as that of the LVRadioButton class.

Definition at line 13 of file LVRing.cs.

Constructor & Destructor Documentation

Seci.LabView.Controls.LvRing.LvRing	(	String	name,
		String[]	items,
		SerialisableList< int >	indices
	)

inline

Constructor

Parameters

name	The control name
items	The radio button options
indices	The indices to find this control if it is in a cluster

Definition at line 26 of file LVRing.cs.

Member Function Documentation

override String Seci.LabView.Controls.LvRing.GetControlType ( )

inlinevirtual

Implements Seci.LabView.Controls.LvControl.

Definition at line 47 of file LVRing.cs.

override String Seci.LabView.Controls.LvRing.GetNameAndType ( )

inlinevirtual

Overriden method which return the name and type of the control.

Returns: String of the form "Name (Ring)"

Implements Seci.LabView.Controls.LvControl.

Definition at line 42 of file LVRing.cs.

override String [] Seci.LabView.Controls.LvRing.GetValue ( ref strongnameLabview.VirtualInstrument vi )

inlinevirtual

Overriden method for getting the current selected value of the Control. LabVIEW returns an int corresponding to the selected item, so that value is used to find the corresponding value in _items. If _items is null then return the raw value as a String.

Parameters

vi	The VI containing the control

Returns: String Array

Reimplemented from Seci.LabView.Controls.LvControl.

Definition at line 60 of file LVRing.cs.

override void Seci.LabView.Controls.LvRing.SetValue	(	ref strongnameLabview.VirtualInstrument	vi,
		Object	value
	)

inlinevirtual

Overriden method for setting the selected value in the Control. The value received could be a String or an int corresponding to the selected value or the index respectively. If it is a String, then the matching index has to be looked up in _items.

Parameters

vi	The VI containing the control
value	The value to set (String or int)

Reimplemented from Seci.LabView.Controls.LvControl.

Definition at line 101 of file LVRing.cs.

Member Data Documentation

String [] Seci.LabView.Controls.LvRing._items

private

Stores the values of the selectable options.

Definition at line 18 of file LVRing.cs.

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

/isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Seci/LabView/Controls/LVRing.cs

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation