Seci.LabView.Controls.LvControl Class Reference

This class is the abstract base class of the objects used to store the VI control information. Contains the methods for writing and reading control values. More...

Inheritance diagram for Seci.LabView.Controls.LvControl:

Collaboration diagram for Seci.LabView.Controls.LvControl:

Public Member Functions
abstract String	GetControlType ()
abstract String	GetNameAndType ()
	Returns the name of the control and the type as a String of the form: "name (type)". This must be overridden in the derived classes. More...
virtual String[]	GetValue (ref strongnameLabview.VirtualInstrument vi)
	Method for returning a value from the actual front panel control which this class corresponds to. More...
virtual void	SetValue (ref strongnameLabview.VirtualInstrument vi, Object value)
	Virtual method for setting a value on the actual front panel control which this class corresponds to. More...

Protected Member Functions
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
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
String	Name [get]

Detailed Description

This class is the abstract base class of the objects used to store the VI control information. Contains the methods for writing and reading control values.

Definition at line 12 of file LVControl.cs.

Member Function Documentation

abstract String Seci.LabView.Controls.LvControl.GetControlType ( )

pure virtual

Implemented in Seci.LabView.Controls.LvRing, Seci.LabView.Controls.LvRadioButtons, Seci.LabView.Controls.LvArray, Seci.LabView.Controls.LvBoolean, Seci.LabView.Controls.LvEnum, Seci.LabView.Controls.LvNumeric, and Seci.LabView.Controls.LvString.

abstract String Seci.LabView.Controls.LvControl.GetNameAndType ( )

pure virtual

Returns the name of the control and the type as a String of the form: "name (type)". This must be overridden in the derived classes.

Returns

The type as a bracketed string

Implemented in Seci.LabView.Controls.LvRing, Seci.LabView.Controls.LvRadioButtons, Seci.LabView.Controls.LvArray, Seci.LabView.Controls.LvBoolean, Seci.LabView.Controls.LvEnum, Seci.LabView.Controls.LvNumeric, and Seci.LabView.Controls.LvString.

virtual String [] Seci.LabView.Controls.LvControl.GetValue ( ref strongnameLabview.VirtualInstrument  vi )

inlinevirtual

Method for returning a value from the actual front panel control which this class corresponds to.

Parameters

vi	The VI containing the control

Returns

Returns an array because some sub-classes return arrays while some return single values

Reimplemented in Seci.LabView.Controls.LvRing, Seci.LabView.Controls.LvRadioButtons, and Seci.LabView.Controls.LvArray.

Definition at line 38 of file LVControl.cs.

Object [] Seci.LabView.Controls.LvControl.GetValueFromCluster ( strongnameLabview.VirtualInstrument  vi )

inlineprotected

Method for returning a cluster value from the front panel. The cluster contains the required control value for this class.

Parameters

vi	The VI containing the control

Returns

An Object array as it is not certain what will be returned

Definition at line 84 of file LVControl.cs.

virtual void Seci.LabView.Controls.LvControl.SetValue ( ref strongnameLabview.VirtualInstrument  vi, Object  value  )

inlinevirtual

Virtual method for setting a value on the actual front panel control which this class corresponds to.

Parameters

vi	The VI containing the control
value	The new value

Reimplemented in Seci.LabView.Controls.LvRing, Seci.LabView.Controls.LvRadioButtons, and Seci.LabView.Controls.LvArray.

Definition at line 66 of file LVControl.cs.

void Seci.LabView.Controls.LvControl.SetValueInCluster ( ref strongnameLabview.VirtualInstrument  vi, Object  value  )

inlineprotected

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.

Parameters

vi	The VI containing the control
value	The new value

Definition at line 112 of file LVControl.cs.

Member Data Documentation

SerialisableList<int> Seci.LabView.Controls.LvControl._clusterIndices

protected

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.

Definition at line 18 of file LVControl.cs.

String Seci.LabView.Controls.LvControl._name

protected

The name of the control.

Definition at line 21 of file LVControl.cs.

Property Documentation

String Seci.LabView.Controls.LvControl.Name

get

Definition at line 22 of file LVControl.cs.

---

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

• /isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Seci/LabView/Controls/LVControl.cs