PFSFile Class |
Inheritance HierarchyNamespace: DHI.PFS
Assembly: DHI.PFS (in DHI.PFS.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe PFSFile type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFSFile(String) |
Load the PFS file given by the filePath.
|
| PFSFile(String, Boolean) |
Load an existing PFSFile given by the filePath.
|
Properties| Name | Description | |
|---|---|---|
 | Count |
Return the number of targets present in a parameter file.
|
| CustomResultFolder |
Custom result folder.
Overrides the ProjectResultFolder, if the UseCustomResultFolder flag is true. Managed by MzShell, when the PFS file is used as part of an open MzShell project |
| ItemInt32 |
Return a reference to the n'th target of a parameter file.
Short version of GetTarget(Int32) with GetTarget(targetIndex+1) |
| ItemString |
Return a reference to the first instance of a specific target name of a parameter file.
Short version of GetTarget(String, Int32) with GetTarget(targetName,1) |
| ItemString, Int32 |
Return a reference to the n'th instance of a specific target name of a parameter file.
Short version of GetTarget(String, Int32) with GetTarget(targetName, targetIndex+1) |
| ProjectResultFolder |
Project result folder. A global result folder defined for the entire
MzShell project.
Managed by MzShell, when the PFS file is used as part of an open MzShell project |
| UseCustomResultFolder |
Use custom result folder.
Overrides the ProjectResultFolder with the CustomResultFolder, if the flag is true. Managed by MzShell, when the PFS file is used as part of an open MzShell project |
Methods| Name | Description | |
|---|---|---|
| Close |
Terminate the access to a parameter file data structure and free the associated internal storage.
|
| DeleteTarget(Int32) |
Delete a target section from this pfs file, by section number
|
| DeleteTarget(String, Int32) |
Delete a target section from this pfs file, by section name and named number
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetResultFolder |
Evaluatet the actual result folder, based on default result folder,
ProjectResultFolder,
UseCustomResultFolder and
CustomResultFolder.
The default result folder is the path of the pfs file, followed by "\PfsFileName.pfs - Result Files\" When a project result folder is defined, the result folder is the project result folder, followed by "\PfsFileName.pfs - Result Files\" When a custom result folder is defined, that is the location of the result folder. |
| GetSectionFromHandle |
Try to find the given section based on the sectionPath.
|
| GetTarget(Int32) |
Return a reference to the n'th target of a parameter file.
|
| GetTarget(Int32, Boolean) |
Return a reference to the n'th target of a parameter file, null if not existing.
|
| GetTarget(String, Int32) |
Return a reference to the n'th instance of a specific target name of a parameter file.
|
| GetTarget(String, Int32, Boolean) |
Return a reference to the n'th instance of a specific target name of a parameter file, null if not existing
|
| GetTargetsCount |
Return the number of targets present in a parameter file.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InsertNewTarget |
Insert a new target section with specified name into this pfs file at the specified position
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Write |
Write the contents of a PFS object to file
|
Extension Methods| Name | Description | |
|---|---|---|
 | FindSection |
Look in all targets of the pfs file and try find a section
with the provided section name. It will not recurse into sub-sections,
but only "level-2" sections are looked for.
(Defined by PFSExtensions.) |
Examples// Load/Read file PFSFile pfsFile = new PFSFile(filePath, false); // Outmost section PFSSection target = pfsFile.GetTarget("Run11", 1); // Sub-sections PFSSection section1 = target.GetSection("Results", 1); PFSSection section2 = section1.GetSection("Result", 1); // Keywords and paramters string id = section2.GetKeyword("outid", 1).GetParameter(1).ToString();
See Also