The manager class for the configuration More...

Collaboration diagram for Seci.Managers.ConfigurationMgr:

Static Public Member Functions

static void AddComponentTabs ()

static void CloseConfiguration (Boolean killIcp)

Closes the configuration - this also kills the LabVIEW process.

Parameters

killIcp Whether to kill the ICP

More...

static void CreateNewConfiguration ()

Creates a new configuration or component. More...

static int[] GetConfigPanelPosition (String filename, Boolean getPrevPosition)

static List< GraphDefinition > GetGraphDefinitions ()

Method for getting the graph definitions from the configuration. More...

static List< String > GetNames ()

Gets a list of the names of the components that are part of the current configuration. More...

static List< String > GetTabOrder ()

Method for getting the tab order from the configuration. More...

static SerialisableList< Tab > GetTabs ()

static void LoadComponentsVisExes ()

Loads the VIs and executables associated to the component More...

static Boolean OkayToSave (Boolean manager)

Checks that the current user has permission to overwrite the configuration. Uses DotNet XPath methods to find answer. More...

static Boolean OpenConfiguration (String fileName)

Opens a configuration or component from a xml file. More...

static Boolean SaveConfiguration (Boolean manager, Boolean autoSave)

Save the current configuration or component with the current user rights. More...

static void SetConfigPanelPosition (String filename, int x, int y)

static void SetGraphDefinitions (List< GraphDefinition > graphs)

Method for adding graph definitions to the configuration for saving. More...

static void SetTabOrder (List< String > tabs)

Method for setting the tab order in the configuration. More...

static void SetTabs (SerialisableList< Tab > tabs)

static void SetTabVisibility (String tabname, Boolean visible)

static void StartVIs ()

static void SwapTabs (String name1, String name2)

Properties
static ComponentList	Components `[get, set]`

static String	ConfigName `[get, set]`

Events
static RemotingEventHandler	ConfigChangeRequested
	This event signals that a different configuration has been requested. More...

Static Private Member Functions
static void	addBlocks (String compName)
	Set the owning name of the blocks then add to the block dictionary. More...

static BlockDictionary	correctOldSeciBlocks (BlockDictionary blocks)
	Method for converting blocks from old SECI in to a format for new Seci. More...

static bool	groupExists (SerialisableList< BlockGroup > groups, string name)

static void	loadAssocFiles (String compName)
	When loading or adding a component this method loads any associated files that are part of the component. More...

static void	loadComponentExes (String compName)
	When loading or adding a component this method loads any executables that are part of the More...

static void	loadComponentVIs (String compName)
	When adding a component to a configuration this method loads all (if any) LabVIEW VIs in the component. More...

static void	loadVIsAndInitialise (SerialisableList< LabView.LabViewPanelInfo > panels)
	Loads all (if any) LabVIEW VIs in the configuration when it is opened. Also loads any VIs in any components that are part of this configuration. More...

static void	openConfig (String fileName)
	Open a configuration or component. Calls LoadConfig to open the configuration file and create a SeciConfiguration object from that file. The new configuration is copied on to the current configuration. Any VIs and executables in the configuration are then loaded. More...

static void	saveConfig (Boolean manager, Boolean isAutosave)
	This method saves the configuration or component in a XML file. More...

static void	startVI (Seci.LabView.LabViewPanelInfo Panel)
	This method starts the VI and waits a specified number of seconds. More...

Detailed Description

The manager class for the configuration

Definition at line 19 of file ConfigurationMgr.cs.

Member Function Documentation

static void Seci.Managers.ConfigurationMgr.addBlocks ( String compName )

inlinestaticprivate

Set the owning name of the blocks then add to the block dictionary.

Parameters

compName The name of the component

Definition at line 789 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.AddComponentTabs ( )

inlinestatic

Definition at line 362 of file ConfigurationMgr.cs.

References Seci.Managers.ComponentMgr.Components, and Seci.Definitions.Tab.Name.

static void Seci.Managers.ConfigurationMgr.CloseConfiguration ( Boolean killIcp )

inlinestatic

Closes the configuration - this also kills the LabVIEW process.

Parameters

killIcp Whether to kill the ICP

Definition at line 467 of file ConfigurationMgr.cs.

static BlockDictionary Seci.Managers.ConfigurationMgr.correctOldSeciBlocks ( BlockDictionary blocks )

inlinestaticprivate

Method for converting blocks from old SECI in to a format for new Seci.

Parameters

blocks BlockDictionary containing the blocks from old SECI

Returns

Definition at line 658 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.CreateNewConfiguration ( )

inlinestatic

Creates a new configuration or component.

Definition at line 35 of file ConfigurationMgr.cs.

static int [] Seci.Managers.ConfigurationMgr.GetConfigPanelPosition	(	String	filename,
		Boolean	getPrevPosition
	)

inlinestatic

Definition at line 692 of file ConfigurationMgr.cs.

static List<GraphDefinition> Seci.Managers.ConfigurationMgr.GetGraphDefinitions ( )

inlinestatic

Method for getting the graph definitions from the configuration.

Returns: A list of graph definitions

Definition at line 625 of file ConfigurationMgr.cs.

static List<String> Seci.Managers.ConfigurationMgr.GetNames ( )

inlinestatic

Gets a list of the names of the components that are part of the current configuration.

Returns: String List of the component names

Definition at line 768 of file ConfigurationMgr.cs.

static List<String> Seci.Managers.ConfigurationMgr.GetTabOrder ( )

inlinestatic

Method for getting the tab order from the configuration.

Returns: A list of strings containing a copy of the tab names in order

Definition at line 528 of file ConfigurationMgr.cs.

static SerialisableList<Tab> Seci.Managers.ConfigurationMgr.GetTabs ( )

inlinestatic

Definition at line 539 of file ConfigurationMgr.cs.

static bool Seci.Managers.ConfigurationMgr.groupExists	(	SerialisableList< BlockGroup >	groups,
		string	name
	)

inlinestaticprivate

Definition at line 350 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.loadAssocFiles ( String compName )

inlinestaticprivate

When loading or adding a component this method loads any associated files that are part of the component.

Parameters

compName The name of the component

Definition at line 882 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.loadComponentExes ( String compName )

inlinestaticprivate

When loading or adding a component this method loads any executables that are part of the

Parameters

compName The name of the component

Definition at line 868 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.LoadComponentsVisExes ( )

inlinestatic

Loads the VIs and executables associated to the component

Definition at line 802 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.loadComponentVIs ( String compName )

inlinestaticprivate

When adding a component to a configuration this method loads all (if any) LabVIEW VIs in the component.

Parameters

compName The name of the component

Definition at line 821 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.loadVIsAndInitialise ( SerialisableList< LabView.LabViewPanelInfo > panels )

inlinestaticprivate

Loads all (if any) LabVIEW VIs in the configuration when it is opened. Also loads any VIs in any components that are part of this configuration.

Parameters

panels The LabViewPanelInfo for the VIs to load

Definition at line 395 of file ConfigurationMgr.cs.

static Boolean Seci.Managers.ConfigurationMgr.OkayToSave ( Boolean manager )

inlinestatic

Checks that the current user has permission to overwrite the configuration. Uses DotNet XPath methods to find answer.

Parameters

manager Is the current user a manager?

Returns: Returns true if the user can overwrite the configuration

Definition at line 160 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.openConfig ( String fileName )

inlinestaticprivate

Open a configuration or component. Calls LoadConfig to open the configuration file and create a SeciConfiguration object from that file. The new configuration is copied on to the current configuration. Any VIs and executables in the configuration are then loaded.

Parameters

fileName The name of the configuration to open

Definition at line 214 of file ConfigurationMgr.cs.

References Seci.Managers.BlockMgr.Blocks, Seci.Definitions.Configuration.Blocks, Seci.Definitions.Configuration.Groups, Seci.Definitions.Configuration.LVPanels, Seci.Definitions.Configuration.OldSeciFirstTime, and Seci.Definitions.Configuration.TabOrder.

static Boolean Seci.Managers.ConfigurationMgr.OpenConfiguration ( String fileName )

inlinestatic

Opens a configuration or component from a xml file.

Parameters

fileName The filename of the configuration or component to open

Returns: Result

Definition at line 174 of file ConfigurationMgr.cs.

References Seci.Definitions.Status.UseDaeMonitorVI.

static void Seci.Managers.ConfigurationMgr.saveConfig	(	Boolean	manager,
		Boolean	isAutosave
	)

inlinestaticprivate

This method saves the configuration or component in a XML file.

Parameters

manager	Is the configuration being saved by the manager account?
isAutosave	Is the configuration being saved automatically?

Definition at line 63 of file ConfigurationMgr.cs.

static Boolean Seci.Managers.ConfigurationMgr.SaveConfiguration	(	Boolean	manager,
		Boolean	autoSave
	)

inlinestatic

Save the current configuration or component with the current user rights.

Parameters

manager	Is the current user a manager?
autoSave	Is this an autosave?

Returns: Result

Definition at line 49 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.SetConfigPanelPosition	(	String	filename,
		int	x,
		int	y
	)

inlinestatic

Definition at line 711 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.SetGraphDefinitions ( List< GraphDefinition > graphs )

inlinestatic

Method for adding graph definitions to the configuration for saving.

Parameters

graphs The list of graph definitions

Definition at line 586 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.SetTabOrder ( List< String > tabs )

inlinestatic

Method for setting the tab order in the configuration.

Parameters

tabs	The list of tab names in order.

Definition at line 511 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.SetTabs ( SerialisableList< Tab > tabs )

inlinestatic

Definition at line 534 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.SetTabVisibility	(	String	tabname,
		Boolean	visible
	)

inlinestatic

Definition at line 544 of file ConfigurationMgr.cs.

References Seci.Definitions.Tab.Name.

static void Seci.Managers.ConfigurationMgr.startVI ( Seci.LabView.LabViewPanelInfo Panel )

inlinestaticprivate

This method starts the VI and waits a specified number of seconds.

Parameters

Panel

Definition at line 451 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.StartVIs ( )

inlinestatic

Definition at line 195 of file ConfigurationMgr.cs.

static void Seci.Managers.ConfigurationMgr.SwapTabs	(	String	name1,
		String	name2
	)

inlinestatic

Definition at line 556 of file ConfigurationMgr.cs.

Property Documentation

ComponentList Seci.Managers.ConfigurationMgr.Components

staticgetset

Definition at line 25 of file ConfigurationMgr.cs.

String Seci.Managers.ConfigurationMgr.ConfigName

staticgetset

Definition at line 22 of file ConfigurationMgr.cs.

Event Documentation

RemotingEventHandler Seci.Managers.ConfigurationMgr.ConfigChangeRequested

static

This event signals that a different configuration has been requested.

Definition at line 30 of file ConfigurationMgr.cs.

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

/isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Seci/Managers/ConfigurationMgr.cs

Static Public Member Functions

Properties

Events

Static Private Member Functions

Detailed Description

Member Function Documentation

Property Documentation

Event Documentation