Class ResultBase

This is the base type for every type of result we produce. This includes: events, summary indices, and spectral indices. These classes will hold much redundant information - the flat format is useful for CSV output.

Inheritance

Object

ResultBase

EventBase

SpectralIndexBase

SummaryIndexBase

Implements

IComparable<ResultBase>

IComparable

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: AnalysisBase.ResultBases

Assembly: AnalysisBase.dll

Syntax

public abstract class ResultBase : IComparable<ResultBase>, IComparable

Properties

FileName

Gets or sets the filename of the audio file this result produced.

Declaration

public string FileName { get; set; }

Property Value

Type	Description
String

ResultMinute

Gets the ResultMinute. This is the floored integer minute of ResultStartSeconds.

Declaration

public int ResultMinute { get; }

Property Value

Type	Description
Int32

ResultStartSeconds

Gets or sets the result start time in seconds. This is relative to the start of the recording. This basically allows every sort of result to be sorted/time indexed from the start of the file/recording.

Declaration

public virtual double ResultStartSeconds { get; set; }

Property Value

Type	Description
Double

Remarks

I.e. the time since the start of the original audio recording. E.g. Given segment 78 of a 120min audio file, with a segment size of 60 seconds, this property would hold 78 minutes. And again: StartOffset is the time offset between the start of the recording and the start of the current result.

SegmentDurationSeconds

Gets or sets the duration of audio segment that produced this result. This is tracked because there is typically some error in cutting out segments of an audio file and it is useful to know how much audio was actually used to generate the result.

Declaration

public double SegmentDurationSeconds { get; set; }

Property Value

Type	Description
Double

Methods

CompareTo(ResultBase)

Defines an innate order of Analysis results based on the SegmentStartOffset.

Declaration

public virtual int CompareTo(ResultBase other)

Parameters

Type	Name	Description
ResultBase	other	The other AnalysisResult to compare to.

Returns

Type	Description
Int32	A integer representing the relative order between the two instances.

CompareTo(Object)

Declaration

public virtual int CompareTo(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Int32

Implements

System.IComparable<T>

System.IComparable

Extension Methods

ObjectExtensions.NotNull(Object)

ObjectExtensions.AsArray<T>(T)

ObjectExtensions.AsList<T>(T)

ObjectExtensions.Wrap<T>(T)

SystemExtensions.BinarySerialize(Object)

ConfigFileExtensions.NotNull(Object, FileInfo, String, String)

ConfigFileExtensions.ValidateNotNull(Object, String, String)

ConfigFileExtensions.ValidateLessThan<T>(Object, Nullable<T>, String, Nullable<T>, String, String)

ExtensionsXml.SerializeObject<T>(T)