#include <InputSpec.h>

Public Member Functions
	InputSpec (std::string binding_, header::DataOrigin origin_, header::DataDescription description_, header::DataHeader::SubSpecificationType subSpec_, enum Lifetime lifetime_=Lifetime::Timeframe, std::vector< ConfigParamSpec > const &metadata_={})
	Create a fully qualified InputSpec.

	InputSpec (std::string binding_, ConcreteDataMatcher const &dataType, enum Lifetime lifetime_=Lifetime::Timeframe, std::vector< ConfigParamSpec > const &metadata_={})
	Create a fully qualified InputSpec (alternative syntax)

	InputSpec (std::string binding_, header::DataOrigin origin_, header::DataDescription description_, enum Lifetime lifetime_=Lifetime::Timeframe, std::vector< ConfigParamSpec > const &metadata_={})
	Create a fully qualified InputSpec where the subSpec is 0.

	InputSpec (std::string binding_, ConcreteDataTypeMatcher const &dataType, enum Lifetime lifetime_=Lifetime::Timeframe, std::vector< ConfigParamSpec > const &metadata_={})
	Create an InputSpec which does not check for the subSpec.

	InputSpec (std::string binding_, header::DataOrigin const &dataType, enum Lifetime lifetime_=Lifetime::Timeframe, std::vector< ConfigParamSpec > const &metadata_={})
	Create an InputSpec which does not check for the description and the subSpec.

	InputSpec (std::string binding, data_matcher::DataDescriptorMatcher &&matcher, enum Lifetime lifetime_=Lifetime::Timeframe, std::vector< ConfigParamSpec > const &metadata_={})

bool	operator== (InputSpec const &that) const

Public Attributes
std::string	binding
	A mnemonic name for the input spec.

std::variant< ConcreteDataMatcher, data_matcher::DataDescriptorMatcher >	matcher
	The actual matcher for the input spec.

enum Lifetime	lifetime

std::vector< ConfigParamSpec >	metadata
	A set of configurables which can be used to customise the InputSpec.

Friends
std::ostream &	operator<< (std::ostream &stream, InputSpec const &arg)

Detailed Description

A selector for some kind of data being processed, either in input or in output. This can be used, for example to match specific payloads in a timeframe.

Definition at line 31 of file InputSpec.h.

Constructor & Destructor Documentation

◆ InputSpec() [1/6]

o2::framework::InputSpec::InputSpec	(	std::string	binding_,
		header::DataOrigin	origin_,
		header::DataDescription	description_,
		header::DataHeader::SubSpecificationType	subSpec_,
		enum Lifetime	lifetime_ = `Lifetime::Timeframe`,
		std::vector< ConfigParamSpec > const &	metadata_ = `{}`
	)

Create a fully qualified InputSpec.

Definition at line 34 of file InputSpec.cxx.

◆ InputSpec() [2/6]

o2::framework::InputSpec::InputSpec	(	std::string	binding_,
		ConcreteDataMatcher const &	dataType,
		enum Lifetime	lifetime_ = `Lifetime::Timeframe`,
		std::vector< ConfigParamSpec > const &	metadata_ = `{}`
	)

Create a fully qualified InputSpec (alternative syntax)

Definition at line 23 of file InputSpec.cxx.

◆ InputSpec() [3/6]

o2::framework::InputSpec::InputSpec	(	std::string	binding_,
		header::DataOrigin	origin_,
		header::DataDescription	description_,
		enum Lifetime	lifetime_ = `Lifetime::Timeframe`,
		std::vector< ConfigParamSpec > const &	metadata_ = `{}`
	)

Create a fully qualified InputSpec where the subSpec is 0.

Definition at line 47 of file InputSpec.cxx.

◆ InputSpec() [4/6]

o2::framework::InputSpec::InputSpec	(	std::string	binding_,
		ConcreteDataTypeMatcher const &	dataType,
		enum Lifetime	lifetime_ = `Lifetime::Timeframe`,
		std::vector< ConfigParamSpec > const &	metadata_ = `{}`
	)

Create an InputSpec which does not check for the subSpec.

Definition at line 70 of file InputSpec.cxx.

◆ InputSpec() [5/6]

o2::framework::InputSpec::InputSpec	(	std::string	binding_,
		header::DataOrigin const &	dataType,
		enum Lifetime	lifetime_ = `Lifetime::Timeframe`,
		std::vector< ConfigParamSpec > const &	metadata_ = `{}`
	)

Create an InputSpec which does not check for the description and the subSpec.

Definition at line 59 of file InputSpec.cxx.

◆ InputSpec() [6/6]

o2::framework::InputSpec::InputSpec	(	std::string	binding,
		data_matcher::DataDescriptorMatcher &&	matcher,
		enum Lifetime	lifetime_ = `Lifetime::Timeframe`,
		std::vector< ConfigParamSpec > const &	metadata_ = `{}`
	)

Definition at line 81 of file InputSpec.cxx.

Member Function Documentation

◆ operator==()

bool o2::framework::InputSpec::operator== ( InputSpec const & that ) const

Definition at line 92 of file InputSpec.cxx.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	stream,
		InputSpec const &	arg
	)

friend

Definition at line 24 of file StreamOperators.cxx.

Member Data Documentation

◆ binding

std::string o2::framework::InputSpec::binding

A mnemonic name for the input spec.

Definition at line 66 of file InputSpec.h.

◆ lifetime

enum Lifetime o2::framework::InputSpec::lifetime

Definition at line 73 of file InputSpec.h.

◆ matcher

std::variant<ConcreteDataMatcher, data_matcher::DataDescriptorMatcher> o2::framework::InputSpec::matcher

The actual matcher for the input spec.

Definition at line 70 of file InputSpec.h.

◆ metadata

std::vector<ConfigParamSpec> o2::framework::InputSpec::metadata

A set of configurables which can be used to customise the InputSpec.

Definition at line 76 of file InputSpec.h.

The documentation for this struct was generated from the following files:

/home/runner/work/AliceO2/AliceO2/Framework/Core/include/Framework/InputSpec.h
/home/runner/work/AliceO2/AliceO2/Framework/Core/src/InputSpec.cxx

Public Member Functions

Public Attributes

Friends