OutputParameter

Members

Mixins

__anonymous
mixin genCtor
Undocumented in source.
__anonymous
mixin genIdentifier
Undocumented in source.
__anonymous
mixin genDumper
Undocumented in source.

Variables

doc_
Either!(None, string, string[]) doc_;

A documentation string for this type, or an array of strings which should be concatenated.

format_
Either!(None, string, Expression) format_;

Only valid when type: File or is an array of items: File. This is the file format that will be assigned to the output parameter.

id_
string id_;

The unique identifier for this parameter object.

label_
Either!(None, string) label_;

A short, human-readable label of this object.

outputBinding_
Either!(None, CommandOutputBinding) outputBinding_;

Describes how to handle the outputs of a process.

secondaryFiles_
Either!(None, string, Expression, Either!(string, Expression)[]) secondaryFiles_;

Only valid when type: File or is an array of items: File. Provides a pattern or expression specifying files or directories that must be included alongside the primary file. All listed secondary files must be present. An implementation may fail workflow execution if an expected secondary file does not exist. If the value is an expression, the value of self in the expression must be the primary input or output File object to which this binding applies. The basename, nameroot and nameext fields must be present in self. For CommandLineTool outputs the path field must also be present. The expression must return a filename string relative to the path to the primary File, a File or Directory object with either path or location and basename fields set, or an array consisting of strings or File or Directory objects. It is legal to reference an unchanged File or Directory object taken from input as a secondaryFile. To work on non-filename-preserving storage systems, portable tool descriptions should avoid constructing new values from location, but should construct relative references using basename or nameroot instead. If a value in secondaryFiles is a string that is not an expression, it specifies that the following pattern should be applied to the path of the primary file to yield a filename relative to the primary File: 1. If string begins with one or more caret ^ characters, for each caret, remove the last file extension from the path (the last period . and all following characters). If there are no file extensions, the path is unchanged. 2. Append the remainder of the string to the end of the file path.

streamable_
Either!(None, bool) streamable_;

Only valid when type: File or is an array of items: File. A value of true indicates that the file is read or written sequentially without seeking. An implementation may use this flag to indicate whether it is valid to stream file contents using a named pipe. Default: false.

Meta