#include <GUILayout.cs>

Collaboration diagram for Sample_Environment_Control_Interface.GUILayout:

Public Member Functions
void	AddGroup (Group grp)

void	ChangeVIPath (String oldPath, String newPath)

void	CheckGroupsValid ()

Boolean	GroupExists (String name)

void	HideAllGroups ()

GUILayout	Load (String fileName)

void	OverWriteGroups (List< Group > newGroups)

void	RemoveGroup (Group grp)

void	RemoveProgFromAllGroups (String progName)

void	RemoveVIFromAllGroups (String viName)

void	Save (String fileName)

void	ShowGroup (String grpName)

void	UpdateGUIvalues ()

Properties
Seci.SerialisableList < SECI_Controls.Run_Information.Scaling_BlockViewer >	BlockViewers `[get, set]`

Seci.SerialisableList < SECI_Controls.Graph.SECI_Graph >	Graphs `[get, set]`

Group[]	Groups `[get, set]`

Seci.SerialisableList < SECI_Controls.Run_Information.Scaling_RunInfo >	RunInfos `[get, set]`

Private Attributes
Seci.SerialisableList < SECI_Controls.Run_Information.Scaling_BlockViewer >	_blockViewers = new Seci.SerialisableList<SECI_Controls.Run_Information.Scaling_BlockViewer>()
	Serialisable container for any block viewer controls that are part of the layout. More...

Seci.SerialisableList < SECI_Controls.Graph.SECI_Graph >	_graphs = new Seci.SerialisableList<SECI_Controls.Graph.SECI_Graph>()
	Serialisable container for any graph controls that are part of the layout. More...

List< Group >	_groups = new List<Group>()
	Stores the groups that are used to organise the VIs and programmes that are part of the configuration. More...

Seci.SerialisableList < SECI_Controls.Run_Information.Scaling_RunInfo >	_runInfos = new Seci.SerialisableList<SECI_Controls.Run_Information.Scaling_RunInfo>()
	Serialisable container for any run information controls that are part of the layout. More...

Detailed Description

Author: Matt Clarke, ISIS

The GUILayout class. This class contains all the information about the current layout of the SECI GUI. This only applies to Configurations, not Components. When a configuration is loaded or saved, the layout is loaded or saved as well. The filename is of the form "configName.conf.lay".

Definition at line 21 of file GUILayout.cs.

Member Function Documentation

void Sample_Environment_Control_Interface.GUILayout.AddGroup ( Group grp )

inline

Method for adding a group to the layout. Wrapper for the standard List "Add" method.

Parameters

grp	:: The group to add.

Definition at line 137 of file GUILayout.cs.

void Sample_Environment_Control_Interface.GUILayout.ChangeVIPath	(	String	oldPath,
		String	newPath
	)

inline

Method for changing the filepath of a VI. Used when a VI is found in a different location.

Parameters

oldPath	:: The old filepath for the VI.
newPath	:: The new filepath for the VI.

Definition at line 225 of file GUILayout.cs.

References Sample_Environment_Control_Interface.GUILayout._groups.

void Sample_Environment_Control_Interface.GUILayout.CheckGroupsValid ( )

inline

Method for checking groups are valid, for example: are the VIs listed actually part of the configuration. If the group is invalid it will be fixed automatically. An example use for this method is when a component is removed, it will automatically remove any references to VIs that are no longer present.

Definition at line 256 of file GUILayout.cs.

References Sample_Environment_Control_Interface.GUILayout._groups.

Boolean Sample_Environment_Control_Interface.GUILayout.GroupExists ( String name )

inline

Method for finding out if a group name already exists.

Parameters

name	:: The group name to look for.

Returns: Boolean result.

Definition at line 157 of file GUILayout.cs.

References Sample_Environment_Control_Interface.GUILayout._groups.

Referenced by Sample_Environment_Control_Interface.Dialogs.Layout.Groups.AddEditGroup.btnOK_Click().

void Sample_Environment_Control_Interface.GUILayout.HideAllGroups ( )

inline

Method for making all the members of all the groups invisible.

Definition at line 182 of file GUILayout.cs.

References Sample_Environment_Control_Interface.GUILayout._groups.

GUILayout Sample_Environment_Control_Interface.GUILayout.Load ( String fileName )

inline

Method for loading the layout information. Uses the standard DotNet deserialisation method.

Parameters

fileName :: The filename of the layout to load.

Definition at line 97 of file GUILayout.cs.

void Sample_Environment_Control_Interface.GUILayout.OverWriteGroups ( List< Group > newGroups )

inline

Method for replacing the current groups with a new set.

Parameters

newGroups :: The groups to replace the existing ones.

Definition at line 174 of file GUILayout.cs.

References Sample_Environment_Control_Interface.GUILayout._groups.

void Sample_Environment_Control_Interface.GUILayout.RemoveGroup ( Group grp )

inline

Method for removing a group from the layout. Wrapper for the standard List "Remove" method.

Parameters

grp	:: The group to add.

Definition at line 147 of file GUILayout.cs.

void Sample_Environment_Control_Interface.GUILayout.RemoveProgFromAllGroups ( String progName )

inline

Method for removing all occurances of an executable from the groups. Used when an executable is removed from a configuration.

Parameters

progName :: The filepath of the executable to remove.

Definition at line 239 of file GUILayout.cs.

References Sample_Environment_Control_Interface.GUILayout._groups.

void Sample_Environment_Control_Interface.GUILayout.RemoveVIFromAllGroups ( String viName )

inline

Method for removing all occurances of a VI from the groups. Used when a VI is removed from a configuration.

Parameters

viName :: The filepath of the VI to remove.

Definition at line 211 of file GUILayout.cs.

References Sample_Environment_Control_Interface.GUILayout._groups.

void Sample_Environment_Control_Interface.GUILayout.Save ( String fileName )

inline

Method for saving the layout information as XML. Uses the standard DotNet serialisation method.

Parameters

fileName :: The filename to save the layout as.

Definition at line 60 of file GUILayout.cs.

void Sample_Environment_Control_Interface.GUILayout.ShowGroup ( String grpName )

inline

Method for making the members of one group visible.

Parameters

grpName :: The name of the group to show.

Definition at line 194 of file GUILayout.cs.

References Sample_Environment_Control_Interface.GUILayout._groups.

void Sample_Environment_Control_Interface.GUILayout.UpdateGUIvalues ( )

inline

Method for updating the values of any controls in the layout. All controls have an UpdateControl method.

Definition at line 268 of file GUILayout.cs.

References Sample_Environment_Control_Interface.GUILayout._blockViewers, Sample_Environment_Control_Interface.GUILayout._graphs, and Sample_Environment_Control_Interface.GUILayout._runInfos.

Member Data Documentation

Seci.SerialisableList<SECI_Controls.Run_Information.Scaling_BlockViewer> Sample_Environment_Control_Interface.GUILayout._blockViewers = new Seci.SerialisableList<SECI_Controls.Run_Information.Scaling_BlockViewer>()

private

Serialisable container for any block viewer controls that are part of the layout.

Definition at line 32 of file GUILayout.cs.

Referenced by Sample_Environment_Control_Interface.GUILayout.UpdateGUIvalues().

Seci.SerialisableList<SECI_Controls.Graph.SECI_Graph> Sample_Environment_Control_Interface.GUILayout._graphs = new Seci.SerialisableList<SECI_Controls.Graph.SECI_Graph>()

private

Serialisable container for any graph controls that are part of the layout.

Definition at line 36 of file GUILayout.cs.

Referenced by Sample_Environment_Control_Interface.GUILayout.UpdateGUIvalues().

List<Group> Sample_Environment_Control_Interface.GUILayout._groups = new List<Group>()

private

Stores the groups that are used to organise the VIs and programmes that are part of the configuration.

Definition at line 24 of file GUILayout.cs.

Seci.SerialisableList<SECI_Controls.Run_Information.Scaling_RunInfo> Sample_Environment_Control_Interface.GUILayout._runInfos = new Seci.SerialisableList<SECI_Controls.Run_Information.Scaling_RunInfo>()

private

Serialisable container for any run information controls that are part of the layout.

Definition at line 28 of file GUILayout.cs.

Referenced by Sample_Environment_Control_Interface.GUILayout.UpdateGUIvalues().

Property Documentation

Seci.SerialisableList<SECI_Controls.Run_Information.Scaling_BlockViewer> Sample_Environment_Control_Interface.GUILayout.BlockViewers

getset

Definition at line 48 of file GUILayout.cs.

Referenced by Sample_Environment_Control_Interface.SECI_GUI.blockViewersSetupToolStripMenuItem_Click(), Sample_Environment_Control_Interface.SECI_GUI.OpenGuiLayout(), and Sample_Environment_Control_Interface.SECI_GUI.RemoveControls().

Seci.SerialisableList<SECI_Controls.Graph.SECI_Graph> Sample_Environment_Control_Interface.GUILayout.Graphs

getset

Definition at line 51 of file GUILayout.cs.

Referenced by Sample_Environment_Control_Interface.SECI_GUI.deleteGraphToolStripMenuItem_Click(), Sample_Environment_Control_Interface.SECI_GUI.OpenGuiLayout(), and Sample_Environment_Control_Interface.SECI_GUI.RemoveControls().

Group [] Sample_Environment_Control_Interface.GUILayout.Groups

getset

Definition at line 39 of file GUILayout.cs.

Referenced by Sample_Environment_Control_Interface.Dialogs.Layout.Groups.GroupProgs.GroupVIs_Load(), and Sample_Environment_Control_Interface.SECI_GUI.SetUpGroupsMenu().

Seci.SerialisableList<SECI_Controls.Run_Information.Scaling_RunInfo> Sample_Environment_Control_Interface.GUILayout.RunInfos

getset

Definition at line 45 of file GUILayout.cs.

Referenced by Sample_Environment_Control_Interface.SECI_GUI.OpenGuiLayout(), Sample_Environment_Control_Interface.SECI_GUI.RemoveControls(), and Sample_Environment_Control_Interface.SECI_GUI.runInformationSetupToolStripMenuItem_Click().

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

/isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Sample_Environment_Control_Interface/Classes/GUILayout.cs

Public Member Functions

Properties

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation