OERefInputAppOptions

class OERefInputAppOptions : public OESystem::OEOptions

The OERefInputAppOptions represents an options class, representing an applications interface that requires an additional reference or target input, along with an input reader and an output writer file.

Constructors

OERefInputAppOptions(opts: OEOptions, name: str, inFileType: int,
                     outFileType: int, refFileType: int,
                     refCmdName: str) -> OERefInputAppOptions
OERefInputAppOptions(opts: OEOptions, name: str, inFileType: int,
                     outFileType: int, refFileExt: str,
                     refCmdName: str) -> OERefInputAppOptions
OERefInputAppOptions(opts: OEOptions, name: str, inFileType: int,
                     refFileType: int, refCmdName: str) -> OERefInputAppOptions
OERefInputAppOptions(opts: OEOptions, name: str, inFileType: int,
                     refFileExt: str, refCmdName: str) -> OERefInputAppOptions
OERefInputAppOptions(arg2: OERefInputAppOptions) -> OERefInputAppOptions

Default and copy constructors.

The opts represents the sub-options that should be wrapped to extend this options to generate the API for the intended application, the name represents the name of the application, and the refCmdName represents the command line flag for reference input. The inFileType, outFileType, and refFileType refers to if the input, output and the reference input file types as defined in the OEFileStringType namespace. The second overload accepts the reference input file type as a string. Variation of constructors that does not require an output file can be used when an output is not desired in an application.

GetInFile

GetInFile() -> str

See SetInFile method.

GetOutFile

GetOutFile() -> str

See SetOutFile method.

GetRefFile

GetRefFile() -> str

See SetRefFile method.

SetInFile

SetInFile(value: str) -> bool

Sets name of the input file for the application. Default: None

SetOutFile

SetOutFile(value: str) -> bool

Sets name of the output file for the application. Default: None

SetRefFile

SetRefFile(value: str) -> bool

Sets name of the reference/target input file for the application. Default: None