• Introduction
  • Theory
  • Guides
  • Tutorials
  • FAQ
  • Articles
  • Documentation
  • PDF
Search Results for

    Show / Hide Table of Contents
    • Changelog
    • Contributing
    • Code paths
    • Debugging
    • Code of conduct
    • Commands
      • Help
      • Analyze Long Recording
      • False Colour Spectrograms
      • Concatenate Index Files
    • Config files
      • GenericRecognizerConfig
      • CommonParameters
      • OscillationParameters
      • HarmonicParameters
      • PostProcessingConfig
      • AnalyzerConfig
    • API
      • Acoustics.Shared
        • AnalysisIo
        • AnalysisIoInputDirectory
        • AppConfigHelper
        • Base58
        • Binary
        • ByteCountFormatter
        • DateTimeFormatter
        • FileDateHelpers
        • FilenameHelpers
        • ImageChrome
        • Interval<T>
        • IntervalExtensions
        • InvalidDataSetException
        • InvalidFileDateException
        • IOrderer<TOrder>
        • Json
        • Json.IntervalConverter
        • Json.LegacyTimeSpanDataConverter
        • MediaTypeExtGroup
        • MediaTypeGroup
        • MediaTypes
        • Meta
        • MultiException
        • NonClosingStreamWrapper
        • OrderCoordinator<T>
        • Orderer<TOrder, TOrderProperty>
        • PathDiagnostics
        • PathDiagnostics.PathDiffReport
        • PathUtils
        • Plugins
        • ProcessRunner
        • ProcessRunner.ProcessMaximumRetriesException
        • SortDirection
        • SpectrogramType
        • SunTimes
        • SunTimes.Coords
        • SunTimes.LatitudeCoords
        • SunTimes.LatitudeCoords.Direction
        • SunTimes.LongitudeCoords
        • SunTimes.LongitudeCoords.Direction
        • TempFileHelper
        • TimeSpanFormatter
        • Topology
        • TwoDimensionalArray
        • Validation
        • ValidationExtensions
        • Yaml
        • YamlTypeTagAttribute
      • Acoustics.Shared.ColorScales
        • ColorBrewer
        • ColorBrewer.DivergingPalettes
        • ColorBrewer.QualitativePalettes
        • ColorBrewer.SequentialMultipleHuesPalettes
        • ColorBrewer.SequentialSingleHuePalettes
        • Palette
        • Type
      • Acoustics.Shared.ConfigFile
        • Config
        • ConfigFile
        • ConfigFileException
        • ConfigFileExtensions
        • ConfigSerializeContractResolver
        • IConfig
        • INamedProfiles<T>
        • IProfiles<T>
      • Acoustics.Shared.Contracts
        • Contract
      • Acoustics.Shared.Csv
        • Csv
        • CsvIntervalConverter
        • CsvSetPointConverter
        • TopologyEnumConverter
      • Acoustics.Shared.Extensions
        • CartesianExtension
        • RandomExtensions
      • Acoustics.Shared.ImageSharp
        • DeltaImageProcessor<TPixelBg, TPixelFg>
        • DeltaImageProcessor<TPixelFg>
        • DeltaPixelBlender<TPixel>
        • Drawing
        • Drawing.NoAA
        • IInterval2<TX, TY>
        • RotateFlipType
      • Acoustics.Shared.Logging
        • Log4NetTextWriter
        • Log4NetTextWriter.Mode
        • Logging
      • Acoustics.Tools
        • AudioFilePreparer
        • AudioReadingRequest
        • AudioUtilityInfo
        • AudioUtilityModifiedInfo
        • AudioUtilityRequest
        • BandPassType
        • SpectrogramRequest
      • Acoustics.Tools.Audio
        • AbstractAudioUtility
        • AbstractSpectrogramUtility
        • AbstractUtility
        • AudioFormatNotSupportedException
        • AudioUtilityException
        • BitDepthOperationNotImplemented
        • ChannelNotAvailableException
        • ChannelSelectionOperationNotImplemented
        • CustomSpectrogramUtility
        • FfmpegAudioUtility
        • FfmpegRawPcmAudioUtility
        • IAudioUtility
        • ISpectrogramUtility
        • MasterAudioUtility
        • Mp3SpltAudioUtility
        • Mp3SpltAudioUtility.SplitFileInfo
        • ShntoolAudioUtility
        • SoxAudioUtility
        • SoxAudioUtility.SoxResampleQuality
        • SoxSpectrogramUtility
        • WavPackAudioUtility
      • Acoustics.Tools.Wav
        • IWavReader
        • WavAudioInfo
        • WavChunk
        • WavReader
        • WavReader.WaveFormat
        • WavStreamReader
        • WavUtils
      • AcousticWorkbench
        • AcousticEventService
        • AcousticWorkbenchResponse<T>
        • Api
        • AudioRecordingService
        • AuthenticatedApi
        • AuthenticationService
        • AuthenticationService.EmailLoginRequest
        • AuthenticationService.LoginRequest
        • AuthenticationService.LoginResponse
        • Error
        • IApi
        • IAuthenticatedApi
        • MediaService
        • Meta
        • Service
        • Service.HttpResponseException
        • UrlGenerator
      • AcousticWorkbench.Models
        • AudioEvent
        • AudioRecording
        • Available
        • CommonParameters
        • FormatInfo
        • ImageFormatInfo
        • Media
        • Recording
        • Tagging
      • AForge.Imaging.Filters
        • BaseUsingCopyPartialFilter
        • CannyEdgeDetector
      • AnalysisBase
        • AbstractStrongAnalyser
        • AnalysisCoordinator
        • AnalysisResult
        • AnalysisResult2
        • AnalysisSettings
        • AnalyzerConfig
        • AudioRecordingTooShortException
        • Author
        • Bibliography
        • Citation
        • FileSegment
        • FileSegment.FileDateBehavior
        • IAnalyser2
        • ICiteable
        • IHasStatus
        • ISourcePreparer
        • SaveBehavior
        • SaveBehaviorExtensions
        • SegmentSettings<TSegment>
        • SegmentSettingsBase
        • SegmentSplitException
        • Status
        • TimeAlignment
      • AnalysisBase.Extensions
        • ModifiedInfoExtensions
      • AnalysisBase.ResultBases
        • EventBase
        • EventIndex
        • ITemporalEvent
        • ResultBase
        • SpectralIndexBase
        • SummaryIndexBase
      • AnalysisBase.Segment
        • InvalidSegmentException
        • ISegment<TSource>
        • SourceMetadata
      • AnalysisPrograms
        • AcousticIndices
        • AcousticIndices.AcousticIndicesConfig
        • Aed
        • Aed.AedConfiguration
        • Aed.Arguments
        • AnalysesAvailable
        • Audio2InputForConvCnn
        • Audio2InputForConvCnn.Arguments
        • Audio2InputForConvCnn.AudioToSonogramResult
        • Audio2InputForConvCnn.CsvDataRecord
        • Audio2InputForConvCnn.SpeciesCounts
        • AudioCutter
        • AudioCutter.Arguments
        • AudioFileCheck
        • AudioFileCheck.Arguments
        • BuildMetadata
        • ChannelIntegrityAnalyzer
        • CheckEnvironment
        • CheckEnvironment.Arguments
        • ConcatenateIndexFiles
        • ConcatenateIndexFiles.Arguments
        • Create4Sonograms
        • Create4Sonograms.Arguments
        • Crow
        • DifferenceSpectrogram
        • DifferenceSpectrogram.Arguments
        • DrawEasyImage
        • DrawEasyImage.Arguments
        • DrawLongDurationSpectrograms
        • DrawLongDurationSpectrograms.Arguments
        • DrawSummaryIndexTracks
        • DrawSummaryIndexTracks.Arguments
        • DummyAnalysis
        • DummyAnalysis.Arguments
        • EPR
        • EPR.Arguments
        • FileRenamer
        • FileRenamer.Arguments
        • GroundParrotRecogniser
        • GroundParrotRecogniser.Arguments
        • Human1
        • KoalaMale
        • KoalaMale.KoalaMaleResults
        • LSKiwi3
        • LSKiwi3.Arguments
        • LSKiwiHelper
        • LSKiwiROC
        • LSKiwiROC.Arguments
        • MahnooshSandpit
        • MahnooshSandpit.Arguments
        • MainEntry
        • OscillationRecogniser
        • OscillationRecogniser.Arguments
        • OscillationsGeneric
        • OscillationsGeneric.Arguments
        • PlanesTrainsAndAutomobiles
        • PreprocessorForConvDnn
        • PreprocessorForSurfAnalysis
        • RheobatrachusSilus
        • Sandpit
        • Sandpit.Arguments
        • Segment
        • Segment.Arguments
        • SnrAnalysis
        • SnrAnalysis.Arguments
        • SpeciesAccumulationCurve
        • SpeciesAccumulationCurve.Arguments
        • SpeciesAccumulationStats
        • SPT
        • SPT.Arguments
        • SurfAnalysis
        • SurfAnalysis.Arguments
        • SurfAnalysis.AudioToSonogramResult
        • SurfAnalysis.CsvDataRecord
        • SurfAnalysis.SpeciesCounts
      • AnalysisPrograms.AcousticWorkbench.Orchestration
        • EventMetadataResolver
        • RemoteSegment
        • RemoteSegmentWithData
      • AnalysisPrograms.AnalyseLongRecordings
        • AnalyseLongRecording
        • AnalyseLongRecording.Arguments
      • AnalysisPrograms.ContentDescription
        • BuildModel
        • BuildModel.Arguments
        • UseModel
        • UseModel.CdConfig
      • AnalysisPrograms.Draw.RibbonPlots
        • RibbonPlot
        • RibbonPlot.Arguments
      • AnalysisPrograms.Draw.Zooming
        • DrawZoomingSpectrograms
        • DrawZoomingSpectrograms.Arguments
        • DrawZoomingSpectrograms.Arguments.ZoomActionType
      • AnalysisPrograms.EventStatistics
        • EventStatisticsAnalysis
        • EventStatisticsEntry
        • EventStatisticsEntry.Arguments
        • ImportedEvent
        • ImportedEvent.ImportedEventNameClassMap
      • AnalysisPrograms.Production
        • AnalysisOptionDevilException
        • CommandLineApplicationExtensions
        • CommandLineArgumentException
        • CustomHelpTextGenerator
        • ExceptionLookup
        • ExceptionLookup.ExceptionStyle
        • FileSystemProvider
        • FileSystemProvider.Options
        • InvalidAudioChannelException
        • InvalidDurationException
        • InvalidStartOrEndException
        • MissingDataException
        • NoDeveloperMethodException
        • PhysicalConsoleLogger
      • AnalysisPrograms.Production.Arguments
        • AnalyserArguments
        • DebugOptions
        • HelpArgs
        • ListArgs
        • LogVerbosity
        • MainArgs
        • SourceAndConfigArguments
        • SourceArguments
        • SourceConfigOutputDirArguments
        • SubCommandBase
      • AnalysisPrograms.Production.Parsers
        • DateTimeOffsetParser
        • DirectoryInfoParser
        • FileInfoParser
        • TimeSpanParser
      • AnalysisPrograms.Production.Validation
        • DirectoryExistsOrCreateAttribute
        • ExistingFileAttribute
        • InRangeAttribute
        • NotExistingFileAttribute
        • OneOfThese
      • AnalysisPrograms.Recognizers
        • GenericRecognizer
        • GenericRecognizer.GenericRecognizerConfig
        • NinoxStrenua
        • NinoxStrenua.NinoxStrenuaConfig
        • PetaurusAustralis
        • PetaurusAustralis.PetaurusAustralisConfig
        • PetaurusBreviceps
        • PetaurusBreviceps.PetaurusBrevicepsConfig
        • PetaurusNorfolcensis
        • PetaurusNorfolcensis.PetaurusNorfolcensisConfig
      • AnalysisPrograms.Recognizers.Base
        • BlobParameters
        • CommonParameters
        • DctParameters
        • ForwardTrackParameters
        • HarmonicParameters
        • IEventRecognizer
        • MinAndMaxBandwidthParameters
        • MultiRecognizer
        • MultiRecognizer.MultiRecognizerConfig
        • OnebinTrackParameters
        • OneframeTrackParameters
        • OscillationParameters
        • RecognizerBase
        • RecognizerBase.RecognizerConfig
        • RecognizerEntry
        • RecognizerEntry.Arguments
        • RecognizerResults
        • UpwardTrackParameters
      • AnalysisPrograms.Recognizers.Birds
        • ArdeaInsignis
        • AtrichornisRufescens
        • AtrichornisRufescens.AtrichornisRufescensConfig
        • CalyptorhynchusLathami
        • CalyptorhynchusLathami.CalyptorhynchusLathamiConfig
        • ClimacterisPicumnus
        • ClimacterisPicumnus.ClimacterisPicumnusConfig
        • LewiniaPectoralis
        • LewinsRailConfig
        • ManorinaMelanophrys
        • ManorinaMelanophrys.ManorinaMelanophrysConfig
        • NinoxConnivens
        • NinoxConnivens.NinoxConnivensConfig
        • TytoNovaehollandiae
        • TytoNovaehollandiae.TytoNovaehollandiaeConfig
        • TytoTenebricosa
        • TytoTenebricosa.TytoTenebricosaConfig
      • AnalysisPrograms.Recognizers.Frogs
        • LitoriaBicolor
        • LitoriaBicolorConfig
        • LitoriaCaerulea
        • LitoriaRothii
        • LitoriaRubella
      • AnalysisPrograms.SourcePreparers
        • LocalSourcePreparer
        • RemoteSourcePreparer
        • RemoteSourcePreparerException
      • AnalysisPrograms.SpectralPeakTracking
        • SpectralPeakTrackingConfig
        • SpectralPeakTrackingEntry
        • SpectralPeakTrackingEntry.Arguments
      • AnalysisPrograms.SpectrogramGenerator
        • Audio2Sonogram
        • Audio2Sonogram.Arguments
        • AudioToSonogramResult
        • SpectrogramGenerator
        • SpectrogramGeneratorConfig
        • SpectrogramImageType
      • AnalysisPrograms.StandardizedFeatures
        • StandardizedFeatureExtraction
        • StandardizedFeatureExtractionConfig
        • StandardizedFeatureExtractionConfig.BandsProperties
        • StandardizedFeatureExtractionConfig.Bandwidth
      • AudioAnalysisTools
        • AcousticComplexityIndex
        • AcousticEntropy
        • AcousticEvent
        • AcousticEvent.AcousticEventClassMap
        • ActivityAndCover
        • AnalysisKeys
        • BirdClefExperiment1
        • BirdClefExperiment1.Arguments
        • BirdClefExperiment1.Output
        • BlobEvent
        • ChannelIntegrity
        • ChannelIntegrity.Arguments
        • ChannelIntegrityIndices
        • ChirpEvent
        • ClickEvent
        • ClusterInfo
        • ConfigKeys
        • ConfigKeys.EndpointDetection
        • ConfigKeys.ImageSave
        • ConfigKeys.Mfcc
        • ConfigKeys.Recording
        • ConfigKeys.Sonogram
        • ConfigKeys.SonogramTypes
        • ConfigKeys.Windowing
        • CrossCorrelation
        • EndpointDetectionConfiguration
        • FindMatchingEvents
        • FrommoltProject
        • HarmonicAnalysis
        • HarmonicEvent
        • IPointData
        • ISignalToImage
        • ISpectralPoint
        • ITracks<T>
        • MfccConfiguration
        • OscillationEvent
        • Oscillations2010
        • Oscillations2012
        • Oscillations2014
        • Oscillations2014.FreqVsOscillationsResult
        • Oscillations2019
        • PointOfInterest
        • ResultsTools
        • RidgeDetection
        • RidgeDetection.RidgeDetectionConfiguration
        • SiteDescription
        • SpectralActivity
        • SpectralCentroid
        • SpectralClustering
        • SpectralClustering.ClusteringParameters
        • SpectralClustering.TrainingDataInfo
        • SpectralPeakTracking2018
        • SpectralPeakTracking2018.Output
        • SpectralPeakTrackingSettings
        • SpectralPeakTracks
        • SprTools
        • SummaryActivity
        • SunAndMoon
        • SunAndMoon.SunMoonTides
        • SURFFeatures
        • TemporalEvent
        • TowseySignalToImage
        • UnitConverters
        • WebSignalToImage
        • WhipEvent
        • WhistleEvent
      • AudioAnalysisTools.ContentDescriptionTools
        • ContentAlgorithms
        • ContentSignatures
        • ContentVisualization
        • DataProcessing
        • DescriptionResult
        • EditStatus
        • FunctionalTemplate
        • SourceAudioProvenance
        • TemplateCollection
        • TemplateManifest
      • AudioAnalysisTools.DSP
        • Clipping
        • DSP_Frames
        • DSP_Frames.EnvelopeAndFft
        • DSP_IIRFilter
        • DspFilters
        • FeatureExtraction
        • FeatureLearning
        • FeatureLearningSettings
        • FFT2D
        • FreqScaleType
        • FrequencyScale
        • KmeansClustering
        • KmeansClustering.Output
        • LocalContrastNormalisation
        • MFCCStuff
        • NoiseProfile
        • NoiseReductionType
        • NoiseRemoval_Briggs
        • NoiseRemovalModal
        • OctaveFreqScale
        • PatchSampling
        • PatchSampling.SamplingMethod
        • PcaWhitening
        • PcaWhitening.Output
        • PowerSpectralDensity
        • SNR
        • SNR.BackgroundNoise
        • SNR.SnrStatistics
        • WaveType
        • WavInfo
        • WavWriter
      • AudioAnalysisTools.Events
        • EventCommon
        • EventExtentions
        • EventFilters
        • InstantEvent
        • SpectralEvent
        • SpectralPoint
      • AudioAnalysisTools.Events.Drawing
        • EventDrawer
        • EventRenderingOptions
        • IDrawableEvent
      • AudioAnalysisTools.Events.Interfaces
        • IInstantEvent
        • ISpectralBand
        • ISpectralEvent
        • ITrack
      • AudioAnalysisTools.Events.Tracks
        • Track
        • TrackType
      • AudioAnalysisTools.Events.Types
        • ChatterEvent
        • CompositeEvent
        • EventConverters
        • EventPostProcessing
        • EventPostProcessing.BandwidthConfig
        • EventPostProcessing.DurationConfig
        • EventPostProcessing.PostProcessingConfig
        • EventPostProcessing.SidebandConfig
        • EventPostProcessing.SyllableSequenceConfig
        • EventPostProcessing.SyllableStackConfig
      • AudioAnalysisTools.EventStatistics
        • EventStatistics
        • EventStatistics.EventStatisticsClassMap
        • EventStatisticsCalculate
        • EventStatisticsConfiguration
      • AudioAnalysisTools.Indices
        • AnalyzerConfigIndexProperties
        • ConcatMode
        • GapsAndJoins
        • IIndexPropertyReferenceConfiguration
        • IndexCalculate
        • IndexCalculateConfig
        • IndexCalculateResult
        • IndexCalculateSixOnly
        • IndexDisplay
        • IndexDistributions
        • IndexDistributions.SpectralStats
        • IndexGenerationData
        • IndexMatrices
        • IndexProperties
        • IndexPropertiesCollection
        • InitialiseIndexProperties
        • RainIndices
        • RainIndices.RainStruct
        • SpectralIndexValues
        • SpectralIndexValuesForContentDescription
        • SpectralIndicesToAndFromTable
        • SpectralIndicesToAndFromTable.Arguments
        • SummaryIndexValues
      • AudioAnalysisTools.LongDurationSpectrograms
        • LdSpectrogram3D
        • LdSpectrogram3D.Arguments
        • LDSpectrogramClusters
        • LdSpectrogramConfig
        • LdSpectrogramDifference
        • LDSpectrogramDiscreteColour
        • LDSpectrogramDistance
        • LDSpectrogramRGB
        • LdSpectrogramRibbons
        • LdSpectrogramStitching
        • LdSpectrogramTStatistic
        • SpectrogramConstants
        • SpectrogramType
        • TimeOffsetSingleLayerSuperTile
        • ZoomFocusedSpectrograms
      • AudioAnalysisTools.LongDurationSpectrograms.Zooming
        • InvalidScaleException
        • SpectrogramZoomingConfig
        • ZoomCommon
        • ZoomParameters
        • ZoomTiledSpectrograms
      • AudioAnalysisTools.Scales
        • LinearScale
      • AudioAnalysisTools.StandardSpectrograms
        • AmplitudeSonogram
        • AmplitudeSpectrogram
        • BaseSonogram
        • DecibelSpectrogram
        • EnergySpectrogram
        • Image_MultiTrack
        • ImageTrack
        • SonogramConfig
        • SpectrogramAttributes
        • SpectrogramCepstral
        • SpectrogramMelScale
        • SpectrogramOctaveScale
        • SpectrogramSettings
        • SpectrogramSobelEdge
        • SpectrogramStandard
        • SpectrogramTools
        • TrackType
      • AudioAnalysisTools.TileImage
        • AbsoluteDateTilingProfile
        • DefaultSuperTile
        • DuplicateTileException
        • ImageComponent
        • ISuperTile
        • Layer
        • PanoJsTilingProfile
        • TileBias
        • Tiler
        • TilingProfile
      • AudioAnalysisTools.Tracks
        • ForwardTrackAlgorithm
        • OnebinTrackAlgorithm
        • OneframeTrackAlgorithm
        • UpwardTrackAlgorithm
      • AudioAnalysisTools.WavTools
        • AudioRecording
        • RecordingFetcher
        • TowseyWavReader
        • WavChooser
      • Be.Timvw.Framework.Collections.Generic
        • PropertyComparer<T>
      • BTR.Core.Linq
        • ExpressionExtensions
        • ExpressionVisitor
        • ExpressionVisitor<T>
      • log4net
        • LogExtensions
      • NeuralNets
        • ART
        • ART_2A
        • BinaryCluster
        • Cluster
        • FuzzyART
        • VQ
      • QutSensors.Shared
        • StatDescriptive
        • StatDescriptiveResult
      • SixLabors.ImageSharp
        • ImageSharpExtensions
      • System
        • ArrayExtensions
        • DateTimeAndTimeSpanExtensions
        • DateTimeAndTimeSpanExtensions.RoundingDirection
        • DoubleExtensions
        • DoubleSquareArrayExtensions
        • DoubleSquareArrayExtensions.MergingDirection
        • EnumerableExtensions
        • EnumExtensions
        • ExceptionsExtensions
        • ExtensionsString
        • FileInfoExtensions
        • FileInfoNameComparer
        • LoggedConsole
        • MathExtensions
        • NoConsole
        • ObjectExtensions
        • ProcessExtensions
        • ProcessExtensions.ParentProcessUtilities
        • ReflectionExtensions
        • SystemExtensions
        • TupleExtensions
      • System.Collections.Generic
        • DictionaryExtensions
      • System.Drawing
        • RectangleExtensions
      • System.IO
        • ExtensionsIO
      • System.Threading.Tasks
        • TaskExtensions
      • System.Xml.Linq
        • ExtensionsXml
      • TowseyLibrary
        • AutoAndCrossCorrelation
        • ColorCubeHelix
        • ColorCubeHelix.HslColor
        • ConfigDict
        • ConfigDictionary
        • ConfigurationExtensions
        • CsvTools
        • CubeHelix
        • DataTableTools
        • DataTools
        • DictionaryTools
        • Distribution
        • FFT
        • FFT.WindowFunc
        • FileTools
        • FunctionalTests
        • GaussianTools
        • GraphsAndCharts
        • Gratings
        • Histogram
        • ImageTools
        • Kernal
        • LLR
        • Log
        • Matrix3D
        • MatrixTools
        • NormalDist
        • Oblong
        • Oblong.OblongClassMap
        • OtsuThresholder
        • OtsuThresholder.Arguments
        • Plot
        • PolarCoordinates
        • PulseTrain
        • RandomNumber
        • RandomVariable
        • Spectrum
        • Statistics
        • StructureTensor
        • StructureTensor.RidgeTensorResult
        • StructureTensor.StructureTensorResult
        • SvdAndPca
        • TemporalMatrix
        • TernaryPlots
        • TestTools
        • TextUtilities
        • WaveletPacketDecomposition
        • WaveletPacketDecomposition.BinVector
        • WaveletTransformContinuous
        • WindowFunctions

    Class Config

    Inheritance
    Object
    Config
    AnalyzerConfig
    Aed.AedConfiguration
    SpectralPeakTrackingConfig
    FeatureLearningSettings
    LdSpectrogramConfig
    SpectrogramZoomingConfig
    Implements
    IConfig
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Acoustics.Shared.ConfigFile
    Assembly: Acoustics.Shared.dll
    Syntax
    public class Config : IConfig

    Constructors

    | Improve this Doc View Source

    Config()

    Declaration
    protected Config()

    Properties

    | Improve this Doc View Source

    ConfigDirectory

    Declaration
    public string ConfigDirectory { get; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    ConfigPath

    Declaration
    public string ConfigPath { get; set; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    GenericConfig

    Gets or sets the generic object graph that mirrors the configuration. This object is ignored for JSON serialization in log dumping if the current Type is exactly this type (not an inherited child).

    Declaration
    public object GenericConfig { get; set; }
    Property Value
    Type Description
    Object
    | Improve this Doc View Source

    Item[String]

    Declaration
    public string this[string key] { get; }
    Parameters
    Type Name Description
    String key
    Property Value
    Type Description
    String

    Methods

    | Improve this Doc View Source

    GetBool(String)

    Declaration
    public bool GetBool(string path)
    Parameters
    Type Name Description
    String path
    Returns
    Type Description
    Boolean
    | Improve this Doc View Source

    GetBoolOrNull(String)

    Declaration
    public bool? GetBoolOrNull(string path)
    Parameters
    Type Name Description
    String path
    Returns
    Type Description
    Nullable<Boolean>
    | Improve this Doc View Source

    GetDouble(String)

    Declaration
    public double GetDouble(string path)
    Parameters
    Type Name Description
    String path
    Returns
    Type Description
    Double
    | Improve this Doc View Source

    GetDoubleOrNull(String)

    Declaration
    public double? GetDoubleOrNull(string path)
    Parameters
    Type Name Description
    String path
    Returns
    Type Description
    Nullable<Double>
    | Improve this Doc View Source

    GetInt(String)

    Declaration
    public int GetInt(string path)
    Parameters
    Type Name Description
    String path
    Returns
    Type Description
    Int32
    | Improve this Doc View Source

    GetIntOrNull(String)

    Declaration
    public int? GetIntOrNull(string path)
    Parameters
    Type Name Description
    String path
    Returns
    Type Description
    Nullable<Int32>
    | Improve this Doc View Source

    GetString(String)

    Declaration
    public string GetString(string path)
    Parameters
    Type Name Description
    String path
    Returns
    Type Description
    String
    | Improve this Doc View Source

    GetStringOrNull(String)

    Declaration
    public string GetStringOrNull(string path)
    Parameters
    Type Name Description
    String path
    Returns
    Type Description
    String
    | Improve this Doc View Source

    GetTimeSpan(String)

    Declaration
    public TimeSpan GetTimeSpan(string path)
    Parameters
    Type Name Description
    String path
    Returns
    Type Description
    TimeSpan
    | Improve this Doc View Source

    GetTimeSpanOrNull(String)

    Declaration
    public TimeSpan? GetTimeSpanOrNull(string path)
    Parameters
    Type Name Description
    String path
    Returns
    Type Description
    Nullable<TimeSpan>
    | Improve this Doc View Source

    ToDictionary()

    Declaration
    [Obsolete("Any code that depends on this is way out of date!")]
    public Dictionary<string, string> ToDictionary()
    Returns
    Type Description
    Dictionary<String, String>
    | Improve this Doc View Source

    TryGetBool(String, out Boolean)

    Declaration
    public bool TryGetBool(string path, out bool value)
    Parameters
    Type Name Description
    String path
    Boolean value
    Returns
    Type Description
    Boolean
    | Improve this Doc View Source

    TryGetDouble(String, out Double)

    Declaration
    public bool TryGetDouble(string path, out double value)
    Parameters
    Type Name Description
    String path
    Double value
    Returns
    Type Description
    Boolean
    | Improve this Doc View Source

    TryGetEnum<T>(String, out T)

    Declaration
    public bool TryGetEnum<T>(string path, out T value)
        where T : struct
    Parameters
    Type Name Description
    String path
    T value
    Returns
    Type Description
    Boolean
    Type Parameters
    Name Description
    T
    | Improve this Doc View Source

    TryGetInt(String, out Int32)

    Declaration
    public bool TryGetInt(string path, out int value)
    Parameters
    Type Name Description
    String path
    Int32 value
    Returns
    Type Description
    Boolean
    | Improve this Doc View Source

    TryGetString(String, out String)

    Declaration
    public bool TryGetString(string path, out string value)
    Parameters
    Type Name Description
    String path
    String value
    Returns
    Type Description
    Boolean
    | Improve this Doc View Source

    TryGetTimeSpan(String, out TimeSpan)

    Declaration
    public bool TryGetTimeSpan(string path, out TimeSpan value)
    Parameters
    Type Name Description
    String path
    TimeSpan value
    Returns
    Type Description
    Boolean

    Events

    | Improve this Doc View Source

    Loaded

    Declaration
    public event Action<IConfig> Loaded
    Event Type
    Type Description
    Action<IConfig>

    Explicit Interface Implementations

    | Improve this Doc View Source

    IConfig.InvokeLoaded()

    Declaration
    void IConfig.InvokeLoaded()

    Implements

    IConfig

    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)
    • Improve this Doc
    • View Source
    In This Article
    • Constructors
      • Config()
    • Properties
      • ConfigDirectory
      • ConfigPath
      • GenericConfig
      • Item[String]
    • Methods
      • GetBool(String)
      • GetBoolOrNull(String)
      • GetDouble(String)
      • GetDoubleOrNull(String)
      • GetInt(String)
      • GetIntOrNull(String)
      • GetString(String)
      • GetStringOrNull(String)
      • GetTimeSpan(String)
      • GetTimeSpanOrNull(String)
      • ToDictionary()
      • TryGetBool(String, out Boolean)
      • TryGetDouble(String, out Double)
      • TryGetEnum<T>(String, out T)
      • TryGetInt(String, out Int32)
      • TryGetString(String, out String)
      • TryGetTimeSpan(String, out TimeSpan)
    • Events
      • Loaded
    • Explicit Interface Implementations
      • IConfig.InvokeLoaded()
    • Implements
    • Extension Methods
    Generated by DocFX AP docs version: 21.7.0.4-master-e26127a50d7bd7472d47288f10e61014fb981f7f-DIRTY-CI:144 Back to top