o2::dcs::DataPointCompositeObject Struct Reference

#include <DataPointCompositeObject.h>

Public Member Functions
	DataPointCompositeObject () noexcept
	DataPointCompositeObject (const DataPointIdentifier &id, const DataPointValue &data) noexcept
	DataPointCompositeObject (const DataPointCompositeObject &src) noexcept
DataPointCompositeObject &	operator= (const DataPointCompositeObject &src) noexcept
bool	operator== (const DataPointCompositeObject &other) const noexcept
bool	operator!= (const DataPointCompositeObject &other) const noexcept
void	set (const DataPointIdentifier &id, DataPointValue &data) noexcept
void	set (const uint64_t *const data) noexcept
void	update (const DataPointValue &dpval) noexcept
void *	dim_buffer () const
	~DataPointCompositeObject () noexcept=default
	ClassDefNV (DataPointCompositeObject, 1)

Public Attributes
const DataPointIdentifier	id
DataPointValue	data

Friends
std::ostream &	operator<< (std::ostream &os, const DataPointCompositeObject &dpcom) noexcept

Detailed Description

DataPointCompositeObject is a composition of a DataPointIdentifier and a DataPointValue. It is the unit of data points that ADAPOS provides.

See also

ADAPRO::ADAPOS::DataPointIdentifier

ADAPRO::ADAPOS::DataPointValue

Definition at line 42 of file DataPointCompositeObject.h.

Constructor & Destructor Documentation

DataPointCompositeObject() [1/3]

o2::dcs::DataPointCompositeObject::DataPointCompositeObject ( )

inlinenoexcept

The default constructor for DataPointCompositeObject. Uses the default constructors of its component, which means that their every field will be filled with zeroes.

See also

ADAPRO::ADAPOS::DataPointIdentifier

ADAPRO::ADAPOS::DataPointValue

Definition at line 70 of file DataPointCompositeObject.h.

DataPointCompositeObject() [2/3]

o2::dcs::DataPointCompositeObject::DataPointCompositeObject ( const DataPointIdentifier &  id, const DataPointValue &  data  )

inlinenoexcept

This constructor copies the given DataPointIdentifier and DataPointValue into the fields id and data.

Parameters

id	The DPID component.
data	The DPVAL component.

Definition at line 79 of file DataPointCompositeObject.h.

DataPointCompositeObject() [3/3]

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

inlinenoexcept

Copy constructor

Definition at line 86 of file DataPointCompositeObject.h.

~DataPointCompositeObject()

o2::dcs::DataPointCompositeObject::~DataPointCompositeObject ( )

defaultnoexcept

The destructor for DataPointCompositeObject so it is not deleted and thus DataPointCompositeObject is trivially copyable

Member Function Documentation

ClassDefNV()

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

dim_buffer()

void * o2::dcs::DataPointCompositeObject::dim_buffer ( ) const

inline

Returns a pointer to the beginning of the data part to be given to DIM, which depends on the DeliveryType of this DPCOM. This method is specific to ADAPOS Load Generator and ADAPOS Engine.

Returns

A (void*).

Exceptions

std::domain_error

If the DeliveryType of this DPCOM object was illegal (i.e. VOID or something else than the enumerators of DeliveryType).

See also

ADAPRO::ADAPOS::DeliveryType

Definition at line 179 of file DataPointCompositeObject.h.

operator!=()

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

inlinenoexcept

Negation of the == operator.

Parameters

other

The right-hand side operand.

Returns

true or false.

Definition at line 114 of file DataPointCompositeObject.h.

operator=()

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

inlinenoexcept

Definition at line 88 of file DataPointCompositeObject.h.

operator==()

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

inlinenoexcept

Bit-by bit equality comparison of DataPointCompositeObjects.

Parameters

other

The right-hand operand of equality comparison.

Returns

true or false.

Definition at line 102 of file DataPointCompositeObject.h.

set() [1/2]

void o2::dcs::DataPointCompositeObject::set ( const DataPointIdentifier &  id, DataPointValue &  data  )

inlinenoexcept

Overwrites a DataPointCompositeObject with the given id and data values.

Parameters

id	The id value.
data	The data value.

Definition at line 127 of file DataPointCompositeObject.h.

set() [2/2]

void o2::dcs::DataPointCompositeObject::set ( const uint64_t *const  data )

inlinenoexcept

Overwrites a DataPointCompositeObject as a copy of the given 128-byte segment (16 times sizeof(uint64_t)) of binary data.

Parameters

data	Beginning of the data segment used for reading. The length of the segment is assumed to be exactly 128 bytes and contain a valid binary representation of a DataPointCompositeObject.

Definition at line 141 of file DataPointCompositeObject.h.

update()

void o2::dcs::DataPointCompositeObject::update ( const DataPointValue &  dpval )

inlinenoexcept

Overwrites the state of the data field with the state of the given DPVAL object, except for the control flags, that will be cleared out.

Parameters

dpval

A DPVAL object representing an update event to the DPCOM in question.

See also

ADAPRO::ADAPOS::DataPointValue

ADAPRO::ADAPOS::DataPointValue::CONTROL_MASK

Definition at line 158 of file DataPointCompositeObject.h.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const DataPointCompositeObject &  dpcom  )

friend

Prints a CSV-representation of the DataPointCompositeObject into the ostream. The format of the payload data depends on its type and is handled automatically.

Parameters

os	The output stream.
dpcom	The DataPointCompositeObject.

Returns

Reference to the stream after the printing operation.

Definition at line 217 of file DataPointCompositeObject.h.

Member Data Documentation

data

DataPointValue o2::dcs::DataPointCompositeObject::data

The DataPointValue object, which occupies the last 64 bytes of the DataPointCompositeObject. This object contains the mutable parts of DataPointCompositeObject. These parts are the ADAPOS flags, timestamp, and the payload data.

See also

ADAPRO::ADAPOS::DataPointValue

Definition at line 60 of file DataPointCompositeObject.h.

id

const DataPointIdentifier o2::dcs::DataPointCompositeObject::id

The DataPointIdentifier object, which occupies the first 64 bytes of the DataPointCompositeObject. This object contains the immutable alias and type information.

See also

ADAPRO::ADAPOS::DataPointIdentifier

Definition at line 50 of file DataPointCompositeObject.h.

---

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

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