Class RibbonPlot.Arguments

Inheritance
Object
SubCommandBase
RibbonPlot.Arguments
Inherited Members
Namespace: AnalysisPrograms.Draw.RibbonPlots
Assembly: AnalysisPrograms.dll
Syntax
[Command("DrawRibbonPlots", Description = "Combines ribbon plots together into a stacked chart", ExtendedHelpText = "This command treats all found ribbon plots as belonging to the same site. Thus files with duplicate dates are not permitted.")]
public class Arguments : SubCommandBase

Properties

| Improve this Doc View Source

InputDirectories

Declaration
[Argument(0, Description = "One or more directories where that contain ribbon FCS files (index results).")]
public DirectoryInfo[] InputDirectories { get; set; }
Property Value
Type Description
DirectoryInfo[]
| Improve this Doc View Source

Midnight

Declaration
[Option(CommandOptionType.SingleValue, Description = "Changes when `Midnight` occurs. Defaults to `00:00`. If you want ribbons that span across the night, then set `Midnight` to `12:00`")]
public TimeSpan? Midnight { get; set; }
Property Value
Type Description
Nullable<TimeSpan>
| Improve this Doc View Source

OutputDirectory

Declaration
[Option(CommandOptionType.SingleValue, Description = "Directory where the output ribbon plot is saved.")]
[DirectoryExistsOrCreate(true, true)]
[LegalFilePath]
public DirectoryInfo OutputDirectory { get; set; }
Property Value
Type Description
DirectoryInfo
| Improve this Doc View Source

TimeSpanOffsetHint

Declaration
[Option(CommandOptionType.SingleValue, Description = "TimeSpan offset hint required if file names do not contain time zone info. NO DEFAULT IS SET", ShortName = "z")]
public TimeSpan? TimeSpanOffsetHint { get; set; }
Property Value
Type Description
Nullable<TimeSpan>

Methods

| Improve this Doc View Source

Execute(CommandLineApplication)

Declaration
public override Task<int> Execute(CommandLineApplication app)
Parameters
Type Name Description
McMaster.Extensions.CommandLineUtils.CommandLineApplication app
Returns
Type Description
Task<Int32>
Overrides

Extension Methods