o2::utilities::DataSamplingPolicy Class Reference

#include <DataSamplingPolicy.h>

Public Member Functions
	DataSamplingPolicy (std::string name)
	Constructor.
	~DataSamplingPolicy ()=default
	Destructor.
	DataSamplingPolicy (DataSamplingPolicy &&)=default
	Move constructor.
DataSamplingPolicy &	operator= (DataSamplingPolicy &&)=default
	Move assignment.
void	registerPath (const framework::InputSpec &, const framework::OutputSpec &)
	Adds a new association between inputs and outputs.
void	registerCondition (std::unique_ptr< DataSamplingCondition > &&)
	Adds a new association between inputs and outputs.
void	setFairMQOutputChannel (std::string)
	Sets a raw fair::mq::Channel. Deprecated, do not use.
const framework::OutputSpec *	match (const framework::ConcreteDataMatcher &input) const
	Returns true if this policy requires data with given InputSpec.
bool	decide (const o2::framework::DataRef &)
	Returns true if user-defined conditions of sampling are fulfilled.
framework::Output	prepareOutput (const framework::ConcreteDataMatcher &input, framework::Lifetime lifetime=framework::Lifetime::Timeframe) const
	Returns Output for given InputSpec to pass data forward.
const std::string &	getName () const
const PathMap &	getPathMap () const
const std::string &	getFairMQOutputChannel () const
std::string	getFairMQOutputChannelName () const
uint32_t	getTotalAcceptedMessages () const
uint32_t	getTotalEvaluatedMessages () const
bool	isActive () const

Static Public Member Functions
static DataSamplingPolicy	fromConfiguration (const boost::property_tree::ptree &)
	Configures a policy using structured configuration entry.
static header::DataOrigin	createPolicyDataOrigin ()
static header::DataDescription	createPolicyDataDescription (std::string policyName, size_t id)

Detailed Description

A class representing certain policy of sampling data.

This class stores information about specified sampling policy - data headers and conditions of sampling. For given InputSpec, it can provide corresponding Output to pass data further.

Definition at line 36 of file DataSamplingPolicy.h.

Constructor & Destructor Documentation

DataSamplingPolicy() [1/2]

o2::utilities::DataSamplingPolicy::DataSamplingPolicy

(

std::string

name

)

Constructor.

Definition at line 33 of file DataSamplingPolicy.cxx.

~DataSamplingPolicy()

o2::utilities::DataSamplingPolicy::~DataSamplingPolicy ( )

default

Destructor.

DataSamplingPolicy() [2/2]

o2::utilities::DataSamplingPolicy::DataSamplingPolicy ( DataSamplingPolicy &&  )

default

Move constructor.

Member Function Documentation

createPolicyDataDescription()

header::DataDescription o2::utilities::DataSamplingPolicy::createPolicyDataDescription ( std::string  policyName, size_t  id  )

static

Definition at line 181 of file DataSamplingPolicy.cxx.

createPolicyDataOrigin()

header::DataOrigin o2::utilities::DataSamplingPolicy::createPolicyDataOrigin ( )

static

Definition at line 176 of file DataSamplingPolicy.cxx.

decide()

bool o2::utilities::DataSamplingPolicy::decide

(

const o2::framework::DataRef &

dataRef

)

Returns true if user-defined conditions of sampling are fulfilled.

Definition at line 115 of file DataSamplingPolicy.cxx.

fromConfiguration()

DataSamplingPolicy o2::utilities::DataSamplingPolicy::fromConfiguration ( const boost::property_tree::ptree &  )

static

Configures a policy using structured configuration entry.

Definition at line 52 of file DataSamplingPolicy.cxx.

getFairMQOutputChannel()

const std::string & o2::utilities::DataSamplingPolicy::getFairMQOutputChannel

(

)

const

Definition at line 149 of file DataSamplingPolicy.cxx.

getFairMQOutputChannelName()

std::string o2::utilities::DataSamplingPolicy::getFairMQOutputChannelName

(

)

const

Definition at line 154 of file DataSamplingPolicy.cxx.

getName()

const std::string & o2::utilities::DataSamplingPolicy::getName

(

)

const

Definition at line 139 of file DataSamplingPolicy.cxx.

getPathMap()

const DataSamplingPolicy::PathMap & o2::utilities::DataSamplingPolicy::getPathMap

(

)

const

Definition at line 144 of file DataSamplingPolicy.cxx.

getTotalAcceptedMessages()

uint32_t o2::utilities::DataSamplingPolicy::getTotalAcceptedMessages

(

)

const

Definition at line 162 of file DataSamplingPolicy.cxx.

getTotalEvaluatedMessages()

uint32_t o2::utilities::DataSamplingPolicy::getTotalEvaluatedMessages

(

)

const

Definition at line 166 of file DataSamplingPolicy.cxx.

isActive()

bool o2::utilities::DataSamplingPolicy::isActive

(

)

const

Definition at line 171 of file DataSamplingPolicy.cxx.

match()

const framework::OutputSpec * o2::utilities::DataSamplingPolicy::match

(

const framework::ConcreteDataMatcher &

input

)

const

Returns true if this policy requires data with given InputSpec.

Definition at line 109 of file DataSamplingPolicy.cxx.

operator=()

DataSamplingPolicy & o2::utilities::DataSamplingPolicy::operator= ( DataSamplingPolicy &&  )

default

Move assignment.

prepareOutput()

Output o2::utilities::DataSamplingPolicy::prepareOutput	(	const framework::ConcreteDataMatcher &	input,
		framework::Lifetime	lifetime = framework::Lifetime::Timeframe
	)		const

Returns Output for given InputSpec to pass data forward.

Definition at line 128 of file DataSamplingPolicy.cxx.

registerCondition()

void o2::utilities::DataSamplingPolicy::registerCondition

(

std::unique_ptr< DataSamplingCondition > &&

condition

)

Adds a new association between inputs and outputs.

Adds a new sampling condition.

Definition at line 42 of file DataSamplingPolicy.cxx.

registerPath()

void o2::utilities::DataSamplingPolicy::registerPath	(	const framework::InputSpec &	inputSpec,
		const framework::OutputSpec &	outputSpec
	)

Adds a new association between inputs and outputs.

Definition at line 37 of file DataSamplingPolicy.cxx.

setFairMQOutputChannel()

void o2::utilities::DataSamplingPolicy::setFairMQOutputChannel

(

std::string

channel

)

Sets a raw fair::mq::Channel. Deprecated, do not use.

Definition at line 47 of file DataSamplingPolicy.cxx.

---

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

• /home/runner/work/AliceO2/AliceO2/Utilities/DataSampling/include/DataSampling/DataSamplingPolicy.h
• /home/runner/work/AliceO2/AliceO2/Utilities/DataSampling/src/DataSamplingPolicy.cxx