Skip to content

DPL: add documentation to o2::framework::workflow::combine #8630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ktf merged 1 commit into from
Apr 21, 2022
Merged

DPL: add documentation to o2::framework::workflow::combine #8630

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Framework/Core/include/Framework/WorkflowSpec.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,17 @@ std::vector<InputSpec> select(char const* matcher = "");

namespace workflow
{

/// This allows to optionally merge @a specs into a single DataProcessorSpec named @a name
/// if the @a doIt variable is true. If @a doIt is false, the function will simply return
/// the original @a specs.
///
/// This implements at a different level the functionality proposed by Sandro in
/// https://github.com/AliceO2Group/AliceO2/pull/8529 which was working at the reconstruction task level.
/// This is a bit more general and can be used for analysis tasks as well (T).
/// In the long term it might make sense to automatically apply this after the topological sort
/// and to automatically merge the parallel paths of the workflow. Merging serial steps is more
/// complicated because it would require to abstract out the FairMQ channel model.
WorkflowSpec combine(const char* name, std::vector<DataProcessorSpec> const& specs, bool doIt);

template <typename T, typename... ARGS>
Expand Down