HLT::HLTExtraData Class Reference

Class representing the HLT extra payload stored in HLT::HLTResult::getExtras() More...

#include <HLTExtraData.h>

Collaboration diagram for HLT::HLTExtraData:

Public Member Functions
	HLTExtraData ()
	Construct empty object.
	HLTExtraData (const std::vector< uint32_t > &storage)
	Construct from storage and fill members.
	HLTExtraData (const HLTExtraData &)
	copy ctor
	HLTExtraData (HLTExtraData &&)
	move ctor
HLTExtraData &	operator= (HLTExtraData)
	unified assignement op
void	serialize (std::vector< uint32_t > &storage)
	Serialize the data and append it to the vector.
void	deserialize (const std::vector< uint32_t > &storage)
	Deserialize storage into members.

Public Attributes
std::string	appName
	application name
uint32_t	statusCode
	various status codes (for prescale/COOL updates)
std::vector< uint32_t >	anonymous
	For future use-cases (only use as last resort)

Private Member Functions
bool	empty ()
	Return true if all members have default values (no serialization needed)

Private Attributes
TrigSteeringEvent::StringSerializer	m_stringSerializer

Friends
void	swap (HLTExtraData &, HLTExtraData &)

Detailed Description

Class representing the HLT extra payload stored in HLT::HLTResult::getExtras()

The members storing the data are public. New members should be added whenever additional storage is needed. The reserved anonymous member should only be used as a last resort.

If all members of this class are set to their default values (see empty()) a call to serialize() will do nothing. A deserialization from empty storage will result in a default constructed object.

Whenever you modify this class run 'make check'.

Definition at line 35 of file HLTExtraData.h.

Constructor & Destructor Documentation

HLTExtraData() [1/4]

HLTExtraData::HLTExtraData

(

)

Construct empty object.

Definition at line 17 of file HLTExtraData.cxx.

                           :
  statusCode(0)
{
}

HLTExtraData() [2/4]

HLTExtraData::HLTExtraData

(

const std::vector< uint32_t > &

storage

)

Construct from storage and fill members.

Definition at line 22 of file HLTExtraData.cxx.

                                                             :
  statusCode(0)
{
  deserialize(storage);
}

HLTExtraData() [3/4]

HLTExtraData::HLTExtraData

(

const HLTExtraData &

rhs

)

copy ctor

Definition at line 28 of file HLTExtraData.cxx.

  : appName{rhs.appName}
  , statusCode{rhs.statusCode}
  , anonymous{rhs.anonymous}
  , m_stringSerializer{} // not copied (default always good)
{}

HLTExtraData() [4/4]

HLTExtraData::HLTExtraData

(

HLTExtraData &&

rhs

)

move ctor

Definition at line 35 of file HLTExtraData.cxx.

  : HLTExtraData{}
{
  swap(*this, rhs);
}

Member Function Documentation

deserialize()

void HLTExtraData::deserialize

(

const std::vector< uint32_t > &

storage

)

Deserialize storage into members.

Definition at line 63 of file HLTExtraData.cxx.

{
  if (storage.empty()) return;
  
  // StringSerializer knows how long the string is
  std::size_t offset = m_stringSerializer.deserialize(storage, appName);
  
  if (offset < storage.size()) {
    statusCode = storage[offset++];
    anonymous.clear();
    anonymous.insert(anonymous.begin(), storage.begin()+offset, storage.end());
  }
}

empty()

bool HLT::HLTExtraData::empty ( )

inlineprivate

Return true if all members have default values (no serialization needed)

Definition at line 70 of file HLTExtraData.h.

                        {
      return (appName.empty() && statusCode==0 && anonymous.empty());
    }

operator=()

HLTExtraData & HLTExtraData::operator=

(

HLTExtraData

rhs

)

unified assignement op

Definition at line 42 of file HLTExtraData.cxx.

{
  swap(*this, rhs);
  return *this;
}

serialize()

void HLTExtraData::serialize

(

std::vector< uint32_t > &

storage

)

Serialize the data and append it to the vector.

Definition at line 48 of file HLTExtraData.cxx.

{
  if (empty()) return;
  
  // add the application name and the host name
  m_stringSerializer.serialize( appName, storage );
  
  // one word for update status
  storage.push_back( statusCode );
 
  // Anonymous words
  storage.insert(storage.end(), anonymous.begin(), anonymous.end());
}

Friends And Related Symbol Documentation

swap

void swap ( HLTExtraData & , HLTExtraData &  )

friend

Member Data Documentation

anonymous

std::vector<uint32_t> HLT::HLTExtraData::anonymous

For future use-cases (only use as last resort)

Definition at line 65 of file HLTExtraData.h.

appName

std::string HLT::HLTExtraData::appName

application name

Definition at line 63 of file HLTExtraData.h.

m_stringSerializer

TrigSteeringEvent::StringSerializer HLT::HLTExtraData::m_stringSerializer

private

Definition at line 74 of file HLTExtraData.h.

statusCode

uint32_t HLT::HLTExtraData::statusCode

various status codes (for prescale/COOL updates)

Definition at line 64 of file HLTExtraData.h.

---

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

• HLTExtraData.h
• HLTExtraData.cxx