This class provides the layout for summary information stored for data written to POOL. More...

#include <DataHeader.h>

Inheritance diagram for DataHeader:

Collaboration diagram for DataHeader:

Public Types
enum	statusFlag { Output, Input, Other }

Public Member Functions
	DataHeader ()
	Default Constructor. More...

	DataHeader (const DataHeader &rhs)
	Copy Constructor. More...

virtual	~DataHeader ()
	Destructor. More...

DataHeader &	operator= (const DataHeader &rhs)
	Assignment Operator. More...

void	setStatus (statusFlag status)
	Set StatusFlag enum for DataHeader. More...

bool	isInput () const
	Check whether StatusFlag is "Input". More...

void	setProcessTag (const std::string &processTag)
	Set ProcessTag for DataHeader. More...

const std::string &	getProcessTag () const

int	size () const

std::vector< DataHeaderElement >::const_iterator	begin () const

std::vector< DataHeaderElement >::const_iterator	end () const

const std::vector< DataHeaderElement > &	elements () const

void	insert (const SG::TransientAddress sgAddress, IOpaqueAddress tokAddress=0, const std::string &pTag="")
	Insert a new element into the "DataObject" vector. More...

void	insert (const SG::DataProxy proxy, IOpaqueAddress tokAddress=0, const std::string &pTag="")
	Insert a new element into the "DataObject" vector. More...

void	insert (const DataHeaderElement &dhe)
	Insert a new element into the "DataObject" vector. More...

int	sizeProvenance () const

std::vector< DataHeaderElement >::const_iterator	beginProvenance () const

std::vector< DataHeaderElement >::const_iterator	endProvenance () const

void	insertProvenance (const DataHeaderElement &dhe)
	Insert a new element into the "Provenance" vector. More...

void	addHash (IStringPool *pool)
	Add new entry to hash map. More...

const std::string &	dhFormToken () const
	Form token, to be able to tell when the form changes. More...

void	setDhFormToken (const std::string &formToken)

void	setAttributeList (const coral::AttributeList *attrList)

const coral::AttributeList *	getAttributeList ()

void	setEvtRefTokenStr (const std::string &tokenStr)

const std::string &	getEvtRefTokenStr ()

void	dump (std::ostream &ostr) const

Protected Member Functions
virtual void	recycle ()
	Called before this object is recycled. More...

Private Attributes
std::vector< DataHeaderElement >	m_dataHeader
	vector with DataHeaderElement to "DataObject". More...

std::vector< DataHeaderElement >	m_inputDataHeader
	vector with DataHeaderElement to upstream DataHeader ("Provenance"). More...

statusFlag	m_status
	StatusFlag (i.e.: Output, Primary, Input, Manual, Other). More...

std::string	m_processTag
	ProcessTag (e.g.: "StreamESD", "StreamAOD" ...). More...

const coral::AttributeList *	m_attrList
	Optional pointer to AttributeList to enable writing of TAG Attributes to Payload files. More...

std::string	m_evtRefTokenStr
	Optional Token String for Event Reference to enable writing of TAG to Payload files. More...

std::string	m_dhFormToken
	Token to the DH format object. More...

Friends
class	DataHeaderCnv_p3

class	DataHeaderCnv_p4

class	DataHeaderCnv_p5

class	DataHeaderCnv_p6

class	DataHeaderCnv

Detailed Description

This class provides the layout for summary information stored for data written to POOL.

Definition at line 124 of file DataHeader.h.

Member Enumeration Documentation

◆ statusFlag

enum DataHeader::statusFlag

Enumerator
Output
Input
Other

Definition at line 128 of file DataHeader.h.

128 { Output, Input, Other };

Constructor & Destructor Documentation

◆ DataHeader() [1/2]

DataHeader::DataHeader ( )

Default Constructor.

Definition at line 185 of file DataHeader.cxx.

                        : m_dataHeader(),
     m_inputDataHeader(),
     m_status(statusFlag(Other)),
     m_processTag(),
     m_attrList(0),
     m_evtRefTokenStr() {
 }

◆ DataHeader() [2/2]

DataHeader::DataHeader ( const DataHeader & rhs )

Copy Constructor.

Definition at line 193 of file DataHeader.cxx.

                                             :
         DataObject (rhs),
         m_dataHeader(rhs.m_dataHeader),
     m_inputDataHeader(rhs.m_inputDataHeader),
     m_status(rhs.m_status),
     m_processTag(rhs.m_processTag),
     m_attrList(rhs.m_attrList),
     m_evtRefTokenStr() {
 }

◆ ~DataHeader()

DataHeader::~DataHeader ( )

virtual

Destructor.

Definition at line 203 of file DataHeader.cxx.

203 {

204 }

Member Function Documentation

◆ addHash()

void DataHeader::addHash ( IStringPool * pool )

Add new entry to hash map.

Definition at line 279 of file DataHeader.cxx.

                                           {
    for (std::vector<DataHeaderElement>::iterator iter = m_dataHeader.begin(),
            last = m_dataHeader.end(); iter != last; ++iter) {
       iter->addHash(pool);
    }
    for (std::vector<DataHeaderElement>::iterator iter = m_inputDataHeader.begin(),
            last = m_inputDataHeader.end(); iter != last; ++iter) {
       iter->addHash(pool);
    }
 }

◆ begin()

std::vector< DataHeaderElement >::const_iterator DataHeader::begin ( ) const

Returns: a const_iterator at the begin() of the "DataObject" vector.

Definition at line 237 of file DataHeader.cxx.

                                                                    {
    return(m_dataHeader.begin());
 }

◆ beginProvenance()

std::vector< DataHeaderElement >::const_iterator DataHeader::beginProvenance ( ) const

Returns: a const_iterator at the begin() of the "Provenance" vector.

Definition at line 267 of file DataHeader.cxx.

                                                                              {
    return(m_inputDataHeader.begin());
 }

◆ dhFormToken()

const std::string & DataHeader::dhFormToken ( ) const

Form token, to be able to tell when the form changes.

Definition at line 290 of file DataHeader.cxx.

 {
   return m_dhFormToken;
 }

◆ dump()

void DataHeader::dump ( std::ostream & ostr ) const

Definition at line 319 of file DataHeader.cxx.

 {
    using namespace std;
    ostr << "--- DataHeader Dump ---" << endl;
    for( auto& el : m_dataHeader ) {
       el.dump(ostr);
    }
    for( auto& el : m_inputDataHeader ) {
       el.dump(ostr);
    }
    ostr << "Status: " << m_status << endl;
    ostr << "Proc tag: " << m_processTag << endl;
    ostr << "evtRef: " << m_evtRefTokenStr << endl;
    ostr << "attrListPtr: " << m_attrList << endl;
    if( m_attrList ) ostr << "attrListSize: " << m_attrList->size() << endl;
    ostr << "--- DataHeader End ---" << endl;   
 }

◆ elements()

const std::vector< DataHeaderElement > & DataHeader::elements ( ) const

Returns: the "DataObject" vector.

Definition at line 245 of file DataHeader.cxx.

                                                                {
    return m_dataHeader;
 }

◆ end()

std::vector< DataHeaderElement >::const_iterator DataHeader::end ( ) const

Returns: a const_iterator at the end() of the "DataObject" vector.

Definition at line 241 of file DataHeader.cxx.

                                                                  {
    return(m_dataHeader.end());
 }

◆ endProvenance()

std::vector< DataHeaderElement >::const_iterator DataHeader::endProvenance ( ) const

Returns: a const_iterator at the end() of the "Provenance" vector.

Definition at line 271 of file DataHeader.cxx.

                                                                            {
    return(m_inputDataHeader.end());
 }

◆ getAttributeList()

const coral::AttributeList * DataHeader::getAttributeList ( )

Definition at line 304 of file DataHeader.cxx.

                                                        {
    return(m_attrList);
 }

◆ getEvtRefTokenStr()

const std::string & DataHeader::getEvtRefTokenStr ( )

Definition at line 312 of file DataHeader.cxx.

                                                {
    return(m_evtRefTokenStr);
 }

◆ getProcessTag()

const std::string & DataHeader::getProcessTag ( ) const

Returns: the string containing ProcessTag for the DataHeader.

Definition at line 229 of file DataHeader.cxx.

                                                  {
    return(m_processTag);
 }

◆ insert() [1/3]

void DataHeader::insert ( const DataHeaderElement & dhe )

Insert a new element into the "DataObject" vector.

Parameters

dhe	[IN] reference to the DataHeaderElement to be inserted.

Definition at line 259 of file DataHeader.cxx.

                                                     {
    m_dataHeader.push_back(dhe);
 }

◆ insert() [2/3]

void DataHeader::insert	(	const SG::DataProxy *	proxy,
		IOpaqueAddress *	tokAddress = `0`,
		const std::string &	pTag = `""`
	)

Insert a new element into the "DataObject" vector.

Parameters

proxy	[IN] pointer to the DataProxy for the DataObject.
pTag	[IN] string to overwrite key member of the DataHeaderElement

Definition at line 255 of file DataHeader.cxx.

                                                                                                    {
    m_dataHeader.emplace_back(proxy, tokAddress, pTag);
 }

◆ insert() [3/3]

void DataHeader::insert	(	const SG::TransientAddress *	sgAddress,
		IOpaqueAddress *	tokAddress = `0`,
		const std::string &	pTag = `""`
	)

Insert a new element into the "DataObject" vector.

Parameters

sgAddress	[IN] pointer to the TransientAddress of the DataObject.
pTag	[IN] string to overwrite key member of the DataHeaderElement

Definition at line 249 of file DataHeader.cxx.

                                                                                                               {
    if (sgAddress != 0) {
       m_dataHeader.emplace_back(sgAddress, tokAddress, pTag);
    }
 }

◆ insertProvenance()

void DataHeader::insertProvenance ( const DataHeaderElement & dhe )

Insert a new element into the "Provenance" vector.

Parameters

dhe	[IN] reference to the DataHeaderElement to be inserted.

Definition at line 275 of file DataHeader.cxx.

                                                               {
    m_inputDataHeader.push_back(dhe);
 }

◆ isInput()

bool DataHeader::isInput ( ) const

Check whether StatusFlag is "Input".

Definition at line 221 of file DataHeader.cxx.

                                {
    return(m_status == statusFlag(Input));
 }

◆ operator=()

DataHeader & DataHeader::operator= ( const DataHeader & rhs )

Assignment Operator.

Definition at line 206 of file DataHeader.cxx.

                                                        {
    if (this != &rhs) {
       m_dataHeader = rhs.m_dataHeader;
       m_inputDataHeader = rhs.m_inputDataHeader;
       m_status = rhs.m_status;
       m_processTag = rhs.m_processTag;
       m_attrList = rhs.m_attrList;
    }
    return(*this);
 }

◆ recycle()

void DataHeader::recycle ( )

protectedvirtual

Called before this object is recycled.

Definition at line 337 of file DataHeader.cxx.

338 {

339 }

◆ setAttributeList()

void DataHeader::setAttributeList ( const coral::AttributeList * attrList )

Definition at line 300 of file DataHeader.cxx.

                                                                     {
    m_attrList = attrList;
 }

◆ setDhFormToken()

void DataHeader::setDhFormToken ( const std::string & formToken )

Definition at line 295 of file DataHeader.cxx.

 {
   m_dhFormToken = formToken;
 }

◆ setEvtRefTokenStr()

void DataHeader::setEvtRefTokenStr ( const std::string & tokenStr )

Definition at line 308 of file DataHeader.cxx.

                                                             {
    m_evtRefTokenStr = tokenStr;
 }

◆ setProcessTag()

void DataHeader::setProcessTag ( const std::string & processTag )

Set ProcessTag for DataHeader.

Parameters

processTag [IN] string containing ProcessTag.

Definition at line 225 of file DataHeader.cxx.

                                                           {
    m_processTag = processTag;
 }

◆ setStatus()

void DataHeader::setStatus ( statusFlag status )

Set StatusFlag enum for DataHeader.

Definition at line 217 of file DataHeader.cxx.

                                             {
    m_status = status;
 }

◆ size()

int DataHeader::size ( ) const

Returns: the number of elements in the "DataObject" vector.

Definition at line 233 of file DataHeader.cxx.

                            {
    return(m_dataHeader.size());
 }

◆ sizeProvenance()

int DataHeader::sizeProvenance ( ) const

Returns: the number of elements in the "Provenance" vector.

Definition at line 263 of file DataHeader.cxx.

                                      {
    return(m_inputDataHeader.size());
 }

Friends And Related Function Documentation

◆ DataHeaderCnv

friend class DataHeaderCnv

friend

Definition at line 209 of file DataHeader.h.

◆ DataHeaderCnv_p3

friend class DataHeaderCnv_p3

friend

Definition at line 205 of file DataHeader.h.

◆ DataHeaderCnv_p4

friend class DataHeaderCnv_p4

friend

Definition at line 206 of file DataHeader.h.

◆ DataHeaderCnv_p5

friend class DataHeaderCnv_p5

friend

Definition at line 207 of file DataHeader.h.

◆ DataHeaderCnv_p6

friend class DataHeaderCnv_p6

friend

Definition at line 208 of file DataHeader.h.

Member Data Documentation

◆ m_attrList

const coral::AttributeList* DataHeader::m_attrList

private

Optional pointer to AttributeList to enable writing of TAG Attributes to Payload files.

Definition at line 220 of file DataHeader.h.

◆ m_dataHeader

std::vector<DataHeaderElement> DataHeader::m_dataHeader

private

vector with DataHeaderElement to "DataObject".

Definition at line 212 of file DataHeader.h.

◆ m_dhFormToken

std::string DataHeader::m_dhFormToken

private

Token to the DH format object.

Definition at line 224 of file DataHeader.h.

◆ m_evtRefTokenStr

std::string DataHeader::m_evtRefTokenStr

private

Optional Token String for Event Reference to enable writing of TAG to Payload files.

Definition at line 222 of file DataHeader.h.

◆ m_inputDataHeader

std::vector<DataHeaderElement> DataHeader::m_inputDataHeader

private

vector with DataHeaderElement to upstream DataHeader ("Provenance").

Definition at line 214 of file DataHeader.h.

◆ m_processTag

std::string DataHeader::m_processTag

private

ProcessTag (e.g.: "StreamESD", "StreamAOD" ...).

Definition at line 218 of file DataHeader.h.

◆ m_status

statusFlag DataHeader::m_status

private

StatusFlag (i.e.: Output, Primary, Input, Manual, Other).

Definition at line 216 of file DataHeader.h.

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

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ statusFlag

Constructor & Destructor Documentation

◆ DataHeader() [1/2]

◆ DataHeader() [2/2]

◆ ~DataHeader()

Member Function Documentation

◆ addHash()

◆ begin()

◆ beginProvenance()

◆ dhFormToken()

◆ dump()

◆ elements()

◆ end()

◆ endProvenance()

◆ getAttributeList()

◆ getEvtRefTokenStr()

◆ getProcessTag()

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ insertProvenance()

◆ isInput()

◆ operator=()

◆ recycle()

◆ setAttributeList()

◆ setDhFormToken()

◆ setEvtRefTokenStr()

◆ setProcessTag()

◆ setStatus()

◆ size()

◆ sizeProvenance()

Friends And Related Function Documentation

◆ DataHeaderCnv

◆ DataHeaderCnv_p3

◆ DataHeaderCnv_p4

◆ DataHeaderCnv_p5

◆ DataHeaderCnv_p6

Member Data Documentation

◆ m_attrList

◆ m_dataHeader

◆ m_dhFormToken

◆ m_evtRefTokenStr

◆ m_inputDataHeader

◆ m_processTag

◆ m_status