Seci.Managers.AssocFileMgr Class Reference

The manager class for associated files. More...

Collaboration diagram for Seci.Managers.AssocFileMgr:

Static Public Member Functions
static void	AddFile (String fileName)
	Add an associated file to the collection(i.e. ini files). The file is read and saved as bytes inside the configuration. More...
static Boolean	AnyModifications ()
	Indicates whether any of the associated files has been modified. More...
static Boolean	AnyModificationsToParFiles ()
	Indicates whether any of the tpar or mpar files have been modified More...
static List< String >	GetListOfAsscFiles (Boolean includeComps)
	Gets a list of all the associated files in a configuration. Including any associated files in the components is optional. More...
static List< String >	GetListOfComponentAsscFiles ()
	Gets a list of the associated files in components. More...
static Boolean	IsDuplicate (String fileName)
	Checks that the file is not already saved in the configuration. More...
static Boolean	RemoveFile (String fileName)
	Remove a specfied associated file from the collection. More...
static void	RestoreFile (String fileName)
	Restores the file to the original version that came from the configuration. More...

Static Private Attributes
static SerialisableList < AssociatedFile >	_associatedFiles = new SerialisableList<AssociatedFile>()
	Container for associated file information. More...

Detailed Description

The manager class for associated files.

Definition at line 11 of file AssocFileMgr.cs.

Member Function Documentation

static void Seci.Managers.AssocFileMgr.AddFile ( String  fileName )

inlinestatic

Add an associated file to the collection(i.e. ini files). The file is read and saved as bytes inside the configuration.

Parameters

fileName

The full filepath of the file

Definition at line 40 of file AssocFileMgr.cs.

static Boolean Seci.Managers.AssocFileMgr.AnyModifications ( )

inlinestatic

Indicates whether any of the associated files has been modified.

Returns

True if modified

Definition at line 117 of file AssocFileMgr.cs.

static Boolean Seci.Managers.AssocFileMgr.AnyModificationsToParFiles ( )

inlinestatic

Indicates whether any of the tpar or mpar files have been modified

Returns

True if modified

Definition at line 140 of file AssocFileMgr.cs.

static List<String> Seci.Managers.AssocFileMgr.GetListOfAsscFiles ( Boolean  includeComps )

inlinestatic

Gets a list of all the associated files in a configuration. Including any associated files in the components is optional.

Parameters

includeComps

Whether to include any component associated files

Returns

List of Strings containing the full filepaths

Definition at line 163 of file AssocFileMgr.cs.

static List<String> Seci.Managers.AssocFileMgr.GetListOfComponentAsscFiles ( )

inlinestatic

Gets a list of the associated files in components.

Returns

List of Strings containing the full filepaths

Definition at line 184 of file AssocFileMgr.cs.

static Boolean Seci.Managers.AssocFileMgr.IsDuplicate ( String  fileName )

inlinestatic

Checks that the file is not already saved in the configuration.

Parameters

fileName

The full filepath of the file

Returns

Result

Definition at line 79 of file AssocFileMgr.cs.

static Boolean Seci.Managers.AssocFileMgr.RemoveFile ( String  fileName )

inlinestatic

Remove a specfied associated file from the collection.

Parameters

fileName

The full filepath of the file

Returns

Result

Definition at line 99 of file AssocFileMgr.cs.

static void Seci.Managers.AssocFileMgr.RestoreFile ( String  fileName )

inlinestatic

Restores the file to the original version that came from the configuration.

Parameters

fileName

The filepath of the associated file

Definition at line 63 of file AssocFileMgr.cs.

References Seci.Definitions.AssociatedFile.FileLocation.

Member Data Documentation

SerialisableList<AssociatedFile> Seci.Managers.AssocFileMgr._associatedFiles = new SerialisableList<AssociatedFile>()

staticprivate

Container for associated file information.

Definition at line 16 of file AssocFileMgr.cs.

---

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

• /isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Seci/Managers/AssocFileMgr.cs