Sample_Environment_Control_Interface.Group Class Reference

#include <Group.cs>

Collaboration diagram for Sample_Environment_Control_Interface.Group:

Public Member Functions
void	AddProgMember (String filePath)
void	AddVIMember (String viName)
void	ClearGroup ()
Boolean	ContainsProg (String filePath)
	Group ()
	Group (String groupName)
void	HideGroup ()
void	RemoveInvalidMembers ()
void	RemoveProgMember (String filePath)
void	RemoveVIMember (String viName)
void	ShowGroup ()

Properties
String	GroupName [get, set]
String[]	ProgMembers [get, set]
String[]	VIMembers [get, set]

Private Attributes
String	_name
	The page name - must be unique. More...
List< String >	_progMembers = new List<String>()
	Stores the filepaths for the executables. More...
List< String >	_viMembers = new List<String>()
	Stores the filepaths for the VIs. More...

Detailed Description

Author

Matt Clarke, ISIS

The Group class. This class is used to group VIs and executables together. The items in the group can then be displayed or hidden as required.

Definition at line 16 of file Group.cs.

Constructor & Destructor Documentation

Sample_Environment_Control_Interface.Group.Group ( )

inline

Standard constructor - required for XML deserialisation.

Definition at line 37 of file Group.cs.

Sample_Environment_Control_Interface.Group.Group ( String  groupName )

inline

Overloaded constructor.

Parameters

groupName

:: The name of the group.

Definition at line 46 of file Group.cs.

References Sample_Environment_Control_Interface.Group._name.

Member Function Documentation

void Sample_Environment_Control_Interface.Group.AddProgMember ( String  filePath )

inline

Method for adding an executable to the group. Is a wrapper for the standard List "Add" command, but ignores duplicates.

Parameters

filePath

:: The file path of the executable.

Definition at line 90 of file Group.cs.

References Sample_Environment_Control_Interface.Group._progMembers.

void Sample_Environment_Control_Interface.Group.AddVIMember ( String  viName )

inline

Method for adding a VI to the group. Is a wrapper for the standard List "Add" command, but ignores duplicates.

Parameters

viName

:: The full path of the VI.

Definition at line 56 of file Group.cs.

References Sample_Environment_Control_Interface.Group._viMembers.

void Sample_Environment_Control_Interface.Group.ClearGroup ( )

inline

Method for clearing a group. Is a wrapper for the standard List "Clear" command for both VIs and executables.

Definition at line 112 of file Group.cs.

Boolean Sample_Environment_Control_Interface.Group.ContainsProg ( String  filePath )

inline

Method for checking whether a specified executable is part of the group. Is a wrapper for the standard List "Contains" command.

Parameters

filePath

:: The file path of the executable.

Returns

Boolean result.

Definition at line 80 of file Group.cs.

void Sample_Environment_Control_Interface.Group.HideGroup ( )

inline

Method for making the members of the group invisible.

Definition at line 166 of file Group.cs.

References Sample_Environment_Control_Interface.Group._progMembers, and Sample_Environment_Control_Interface.Group._viMembers.

void Sample_Environment_Control_Interface.Group.RemoveInvalidMembers ( )

inline

Definition at line 200 of file Group.cs.

References Sample_Environment_Control_Interface.Group._progMembers, and Sample_Environment_Control_Interface.Group._viMembers.

void Sample_Environment_Control_Interface.Group.RemoveProgMember ( String  filePath )

inline

Method for removing an executable from the group. Is a wrapper for the standard List "Remove" command.

Parameters

filePath

:: The full path of the VI.

Definition at line 103 of file Group.cs.

void Sample_Environment_Control_Interface.Group.RemoveVIMember ( String  viName )

inline

Method for removing a VI from the group. Is a wrapper for the standard List "Remove" command.

Parameters

viName

:: The full path of the VI.

Definition at line 69 of file Group.cs.

void Sample_Environment_Control_Interface.Group.ShowGroup ( )

inline

Method for making the members of the group visible.

Definition at line 121 of file Group.cs.

References Sample_Environment_Control_Interface.Group._progMembers, and Sample_Environment_Control_Interface.Group._viMembers.

Member Data Documentation

String Sample_Environment_Control_Interface.Group._name

private

The page name - must be unique.

Definition at line 18 of file Group.cs.

Referenced by Sample_Environment_Control_Interface.Group.Group().

List<String> Sample_Environment_Control_Interface.Group._progMembers = new List<String>()

private

Stores the filepaths for the executables.

Definition at line 20 of file Group.cs.

Referenced by Sample_Environment_Control_Interface.Group.AddProgMember(), Sample_Environment_Control_Interface.Group.HideGroup(), Sample_Environment_Control_Interface.Group.RemoveInvalidMembers(), and Sample_Environment_Control_Interface.Group.ShowGroup().

List<String> Sample_Environment_Control_Interface.Group._viMembers = new List<String>()

private

Stores the filepaths for the VIs.

Definition at line 19 of file Group.cs.

Referenced by Sample_Environment_Control_Interface.Group.AddVIMember(), Sample_Environment_Control_Interface.Group.HideGroup(), Sample_Environment_Control_Interface.Group.RemoveInvalidMembers(), and Sample_Environment_Control_Interface.Group.ShowGroup().

Property Documentation

String Sample_Environment_Control_Interface.Group.GroupName

getset

Definition at line 22 of file Group.cs.

Referenced by Sample_Environment_Control_Interface.SECI_GUI.SetUpGroupsMenu().

String [] Sample_Environment_Control_Interface.Group.ProgMembers

getset

Definition at line 29 of file Group.cs.

String [] Sample_Environment_Control_Interface.Group.VIMembers

getset

Definition at line 24 of file Group.cs.

---

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

• /isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Sample_Environment_Control_Interface/Classes/Group.cs