Class FilenameHelpers

A set of helper methods used to create/read consistently encoded filenames.

Inheritance
Object
FilenameHelpers
Inherited Members
Namespace: Acoustics.Shared
Assembly: Acoustics.Shared.dll
Syntax
public static class FilenameHelpers

Fields

| Improve this Doc View Source

AnalysisResultRegex

Declaration
public static readonly Regex AnalysisResultRegex
Field Value
Type Description
Regex
| Improve this Doc View Source

BasenameSeparator

Declaration
public const string BasenameSeparator = "__"
Field Value
Type Description
String
| Improve this Doc View Source

ExampleFilename

Declaration
public const string ExampleFilename = "orginalBasename__AnalysisType.SubType_someOtherValue.extension"
Field Value
Type Description
String
| Improve this Doc View Source

ExtensionSeparator

Declaration
public const string ExtensionSeparator = "."
Field Value
Type Description
String
| Improve this Doc View Source

SegmentSeparator

Declaration
public const string SegmentSeparator = "_"
Field Value
Type Description
String
| Improve this Doc View Source

StandardEventsSuffix

Declaration
public const string StandardEventsSuffix = "Events"
Field Value
Type Description
String
| Improve this Doc View Source

StandardIndicesSuffix

Declaration
public const string StandardIndicesSuffix = "Indices"
Field Value
Type Description
String

Methods

| Improve this Doc View Source

AnalysisResultName(String, String, String, String[])

Return a relative file name only (no directory) for a result file.

Declaration
public static string AnalysisResultName(string baseName, string analysisTag, string newExtension, params string[] otherSegments)
Parameters
Type Name Description
String baseName
String analysisTag
String newExtension
String[] otherSegments
Returns
Type Description
String
| Improve this Doc View Source

AnalysisResultPath(DirectoryInfo, FileInfo, String, String, String[])

Return an absolute path for a result file.

Declaration
public static string AnalysisResultPath(DirectoryInfo outputDirectory, FileInfo orignalFile, string analysisTag, string newExtension, params string[] otherSegments)
Parameters
Type Name Description
DirectoryInfo outputDirectory
FileInfo orignalFile
String analysisTag
String newExtension
String[] otherSegments
Returns
Type Description
String
| Improve this Doc View Source

AnalysisResultPath(DirectoryInfo, String, String, String, String[])

Return an absolute path for a result file.

Declaration
public static string AnalysisResultPath(DirectoryInfo outputDirectory, string baseName, string analysisTag, string newExtension, params string[] otherSegments)
Parameters
Type Name Description
DirectoryInfo outputDirectory
String baseName
String analysisTag
String newExtension
String[] otherSegments
Returns
Type Description
String
| Improve this Doc View Source

ParseAnalysisFileName(FileInfo, out String, out String, out String[])

Declaration
public static void ParseAnalysisFileName(FileInfo file, out string originalBaseName, out string analysisTag, out string[] otherSegments)
Parameters
Type Name Description
FileInfo file
String originalBaseName
String analysisTag
String[] otherSegments
| Improve this Doc View Source

ParseAnalysisFileName(String, out String, out String, out String[])

Declaration
public static void ParseAnalysisFileName(string fileName, out string originalBaseName, out string analysisTag, out string[] otherSegments)
Parameters
Type Name Description
String fileName
String originalBaseName
String analysisTag
String[] otherSegments
| Improve this Doc View Source

TryParseAnalysisFileName(String, out String, out String, out String[])

Declaration
public static bool TryParseAnalysisFileName(string filename, out string originalBasename, out string analysisTag, out string[] otherSegments)
Parameters
Type Name Description
String filename
String originalBasename
String analysisTag
String[] otherSegments
Returns
Type Description
Boolean
| Improve this Doc View Source

TryParseOldStyleCsvFileName(String, out String)

Matches a very specific format: e.g. "4c77b524-1857-4550-afaa-c0ebe5e3960a_20101013_003000+1000_Towsey.Acoustic.ACI.csv".

Declaration
public static bool TryParseOldStyleCsvFileName(string filename, out string analysisTag)
Parameters
Type Name Description
String filename
String analysisTag
Returns
Type Description
Boolean