ARC SDK
Data Fields

Executable. More...

#include <arc/compute/JobDescription.h>

Data Fields

std::string Path
 Path to executable. More...
 
std::list< std::string > Argument
 List of arguments to executable. More...
 
std::pair< bool, int > SuccessExitCode
 Exit code at successful execution. More...
 

Detailed Description

Executable.

The ExecutableType class is used to specify path to an executable, arguments to pass to it when invoked and the exit code for successful execution.

Note
The Name string member has been renamed to Path.

Field Documentation

◆ Argument

std::list<std::string> Arc::ExecutableType::Argument

List of arguments to executable.

The Argument list is used to specify arguments which should be passed to the executable upon invocation.

Attribute mapping specific to this field/value.

◆ Path

std::string Arc::ExecutableType::Path

Path to executable.

The Path string should specify the path to an executable. Note that some implementations might only accept a relative path, while others might also accept a absolute one.

Attribute mapping specific to this field/value.

◆ SuccessExitCode

std::pair<bool, int> Arc::ExecutableType::SuccessExitCode

Exit code at successful execution.

The SuccessExitCode pair is used to specify the exit code returned by the executable in case of successful execution. For some scenarios the exit code returned by the executable should be ignored, which is specified by setting the first member of this object to false. If the exit code should be used for validation at the execution service, the first member of pair must be set to true, while the second member should be the exit code returned at successful execution.

Attribute mapping specific to this field/value.


The documentation for this class was generated from the following file: