o2::dcs::DataPointIdentifier Class Reference

#include <DataPointIdentifier.h>

Public Member Functions
	DataPointIdentifier () noexcept
	DataPointIdentifier (const std::string &alias, const DeliveryType type) noexcept
	DataPointIdentifier (const DataPointIdentifier &src) noexcept
DataPointIdentifier &	operator= (const DataPointIdentifier &src) noexcept
bool	operator== (const DataPointIdentifier &other) const
bool	operator!= (const DataPointIdentifier &other) const
const char *const	get_alias () const noexcept
DeliveryType	get_type () const noexcept
size_t	hash_code () const noexcept
	~DataPointIdentifier () noexcept=default
	ClassDefNV (DataPointIdentifier, 1)

Static Public Member Functions
static void	FILL (const DataPointIdentifier &dpid, const std::string &alias, const DeliveryType type) noexcept
static void	FILL (const DataPointIdentifier &dpid, const uint64_t *const data) noexcept

Friends
std::ostream &	operator<< (std::ostream &os, const DataPointIdentifier &dpid) noexcept

Detailed Description

DataPointIdentifier object is responsible for storing the alias and type information of a data point.

Definition at line 42 of file DataPointIdentifier.h.

Constructor & Destructor Documentation

DataPointIdentifier() [1/3]

o2::dcs::DataPointIdentifier::DataPointIdentifier ( )

inlinenoexcept

The default constructor for DataPointIdentifier. Creates a DPID that contains only zeroes. To fill it with alias and type, please use the factory procedure fill.

See also

ADAPRO::ADAPOS::DataPointIdentifier::fill

Definition at line 66 of file DataPointIdentifier.h.

DataPointIdentifier() [2/3]

o2::dcs::DataPointIdentifier::DataPointIdentifier ( const std::string &  alias, const DeliveryType  type  )

inlinenoexcept

A constructor for DataPointIdentifier. Copies the given arguments to the memory segment owned by the object under construction.

Parameters

alias	The alias of the DataPointIdentifier. Maximum length is 62 characaters.
type	Type of the payload value associated with the service identified by this DataPointIdentifier.

Definition at line 79 of file DataPointIdentifier.h.

DataPointIdentifier() [3/3]

o2::dcs::DataPointIdentifier::DataPointIdentifier ( const DataPointIdentifier &  src )

inlinenoexcept

A copy constructor for DataPointIdentifier.

Definition at line 88 of file DataPointIdentifier.h.

~DataPointIdentifier()

o2::dcs::DataPointIdentifier::~DataPointIdentifier ( )

defaultnoexcept

The destructor for DataPointIdentifier.

Member Function Documentation

ClassDefNV()

o2::dcs::DataPointIdentifier::ClassDefNV	(	DataPointIdentifier	,
		1
	)

FILL() [1/2]

static void o2::dcs::DataPointIdentifier::FILL ( const DataPointIdentifier &  dpid, const std::string &  alias, const DeliveryType  type  )

inlinestaticnoexcept

This stati procedure fills the given DataPointIdentifier object with the given parameters.

Parameters

dpid	The DataPointIdentifier to be filled (i.e. overwritten).
alias	Alias of the data point. This is used for identifying the DIM service that publishes updates to a data point.
type	Type of the data point payload value.

Definition at line 107 of file DataPointIdentifier.h.

FILL() [2/2]

static void o2::dcs::DataPointIdentifier::FILL ( const DataPointIdentifier &  dpid, const uint64_t *const  data  )

inlinestaticnoexcept

This static procedure copies the given 64-byte binary segment into the DataPointIdentifier object.

Parameters

dpid	The DataPointIdentifier to be filled (i.e. overwritten).
data	Beginning of the 64-byte binary segment.

Definition at line 123 of file DataPointIdentifier.h.

get_alias()

const char *const o2::dcs::DataPointIdentifier::get_alias ( ) const

inlinenoexcept

Returns the alias of the DPID object as a C-style string (i.e. null-terminated char array).

Returns

The alias.

Definition at line 173 of file DataPointIdentifier.h.

get_type()

DeliveryType o2::dcs::DataPointIdentifier::get_type ( ) const

inlinenoexcept

Getter for the payload type information.

Returns

a DeliveryType object.

Definition at line 183 of file DataPointIdentifier.h.

hash_code()

size_t o2::dcs::DataPointIdentifier::hash_code ( ) const

inlinenoexcept

Returns a hash code calculated from the alias. Note that the hash code is recalculated every time when this function is called.

Returns

An unsigned integer.

Definition at line 195 of file DataPointIdentifier.h.

operator!=()

bool o2::dcs::DataPointIdentifier::operator!= ( const DataPointIdentifier &  other ) const

inline

Negation of the equality comparison.

Parameters

other

The second operand.

Returns

true or false.

Definition at line 152 of file DataPointIdentifier.h.

operator=()

DataPointIdentifier & o2::dcs::DataPointIdentifier::operator= ( const DataPointIdentifier &  src )

inlinenoexcept

Definition at line 90 of file DataPointIdentifier.h.

operator==()

bool o2::dcs::DataPointIdentifier::operator== ( const DataPointIdentifier &  other ) const

inline

The equality comparison object of DPIDs.

Parameters

other

The other DPID object for comparison.

Returns

true if and only if the other DPID object has exactly (bit-by-bit) the same state.

Definition at line 138 of file DataPointIdentifier.h.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const DataPointIdentifier &  dpid  )

friend

Appends DataPointIdentifier object to the given stream using CSV format (i.e. <alias> ";" <type>).

Definition at line 161 of file DataPointIdentifier.h.

---

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

• /home/runner/work/AliceO2/AliceO2/Detectors/DCS/include/DetectorsDCS/DataPointIdentifier.h