Search Results for

    Show / Hide Table of Contents

    Class SubCommandBase

    Inheritance
    Object
    SubCommandBase
    AnalysesAvailable
    AudioCutter.Arguments
    AudioFileCheck.Arguments
    CheckEnvironment.Arguments
    ConcatenateIndexFiles.Arguments
    BuildModel.Arguments
    DifferenceSpectrogram.Arguments
    RibbonPlot.Arguments
    DrawZoomingSpectrograms.Arguments
    DrawEasyImage.Arguments
    DrawLongDurationSpectrograms.Arguments
    DrawSummaryIndexTracks.Arguments
    DummyAnalysis.Arguments
    EventStatisticsEntry.Arguments
    FileRenamer.Arguments
    LSKiwiROC.Arguments
    MahnooshSandpit.Arguments
    HelpArgs
    ListArgs
    SourceArguments
    Sandpit.Arguments
    SpeciesAccumulationCurve.Arguments
    SPT.Arguments
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: AnalysisPrograms.Production.Arguments
    Assembly: AnalysisPrograms.dll
    Syntax
    public abstract class SubCommandBase

    Properties

    | Improve this Doc View Source

    Parent

    Gets or sets the Parent command. This is set by CommandLineUtils automatically.

    Declaration
    public MainArgs Parent { get; set; }
    Property Value
    Type Description
    MainArgs

    Methods

    | Improve this Doc View Source

    Execute(CommandLineApplication)

    Declaration
    public abstract Task<int> Execute(CommandLineApplication app)
    Parameters
    Type Name Description
    McMaster.Extensions.CommandLineUtils.CommandLineApplication app
    Returns
    Type Description
    Task<Int32>
    | Improve this Doc View Source

    Ok()

    Declaration
    protected Task<int> Ok()
    Returns
    Type Description
    Task<Int32>
    | Improve this Doc View Source

    OnExecuteAsync(CommandLineApplication)

    This method is called when we run the command. This method is automatically invoked by CommandLineUtils through reflection.

    Declaration
    public Task<int> OnExecuteAsync(CommandLineApplication app)
    Parameters
    Type Name Description
    McMaster.Extensions.CommandLineUtils.CommandLineApplication app
    Returns
    Type Description
    Task<Int32>
    | Improve this Doc View Source

    OnValidate(ValidationContext, CommandLineContext)

    This method is invoked when the Model is validated as a whole. It allows for complex validation scenarios. This method is automatically invoked by CommandLineUtils through reflection.

    Declaration
    protected virtual ValidationResult OnValidate(ValidationContext context, CommandLineContext appContext)
    Parameters
    Type Name Description
    ValidationContext context

    The current validation context.

    McMaster.Extensions.CommandLineUtils.Abstractions.CommandLineContext appContext

    The current command line application.

    Returns
    Type Description
    ValidationResult

    A validation result.

    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
    Generated by DocFX AP docs version: 21.7.0.4-master-e26127a50d7bd7472d47288f10e61014fb981f7f-DIRTY-CI:144 Back to top