DataHeaderElement Class Reference

This class provides a persistent form for the TransientAddress. More...

#include <DataHeader.h>

Collaboration diagram for DataHeaderElement:

Public Types
using	sgkey_t = SG::sgkey_t

Public Member Functions
	DataHeaderElement ()
	Default Constructor.
	DataHeaderElement (const DataHeaderElement &rhs)
	Copy Constructor.
	DataHeaderElement (const SG::TransientAddress *sgAddress, IOpaqueAddress *tokAddress, const std::string &pTag)
	Constructor.
	DataHeaderElement (const SG::DataProxy *proxy, IOpaqueAddress *tokAddress, const std::string &pTag)
	Constructor.
	DataHeaderElement (const CLID classID, const std::string &key, Token &&token)
	Constructor.
virtual	~DataHeaderElement ()
	Destructor.
DataHeaderElement &	operator= (const DataHeaderElement &rhs)
	Assignment Operator.
CLID	getPrimaryClassID () const
const std::set< CLID >	getClassIDs () const
const std::string &	getKey () const
const std::vector< std::string > &	getAlias () const
const Token *	getToken () const
const std::vector< sgkey_t > &	getHashes () const
SG::TransientAddress *	getAddress (long storageType) const
SG::TransientAddress *	getAddress (long storageType, const std::string &key) const
void	addHash (IStringPool *pool)
	Add new entry to hash map.
void	dump (std::ostream &ostr) const

Private Member Functions
	DataHeaderElement (CLID clid, const std::string &name, const std::vector< CLID > &tClids, std::vector< std::string > &&alias, IOpaqueAddress *tadAddress, IOpaqueAddress *tokAddress, const std::string &pTag)
	Internal constructor.

Private Attributes
CLID	m_pClid
	primary ClassID.
std::vector< CLID >	m_clids
	vector of unsigned long to store ClassID's for symlinked container.
std::string	m_key
	string with StoreGate key.
std::vector< std::string >	m_alias
	vector of StoreGate alias string.
Token	m_token
	Transient address token.
std::vector< sgkey_t >	m_hashes
	hash table for ElementLink host container keys.

Friends
class	DataHeaderElementCnv_p3
class	DataHeaderElementCnv_p4
class	DataHeaderElementCnv_p5
class	DataHeaderCnv_p6

Detailed Description

This class provides a persistent form for the TransientAddress.

Definition at line 37 of file DataHeader.h.

Member Typedef Documentation

sgkey_t

using DataHeaderElement::sgkey_t = SG::sgkey_t

Definition at line 39 of file DataHeader.h.

Constructor & Destructor Documentation

DataHeaderElement() [1/6]

DataHeaderElement::DataHeaderElement

(

)

Default Constructor.

Definition at line 20 of file DataHeader.cxx.

                                     : m_pClid(0), m_clids(), m_key(), m_alias(), m_hashes() {
}

DataHeaderElement() [2/6]

DataHeaderElement::DataHeaderElement

(

const DataHeaderElement &

rhs

)

Copy Constructor.

Definition at line 23 of file DataHeader.cxx.

                                                                 : m_pClid(rhs.m_pClid),
    m_clids(rhs.m_clids),
    m_key(rhs.m_key),
    m_alias(rhs.m_alias),
        m_token(rhs.getToken()),
    m_hashes(rhs.m_hashes) {
}

DataHeaderElement() [3/6]

DataHeaderElement::DataHeaderElement	(	const SG::TransientAddress *	sgAddress,
		IOpaqueAddress *	tokAddress,
		const std::string &	pTag )

Constructor.

Parameters

sgAddress	[IN] pointer to TransientAddress for which a DataHeaderElement is created.
pTag	[IN] string used as key element in DataHeader (SG key for DataObjects).

Definition at line 31 of file DataHeader.cxx.

  : DataHeaderElement (sgAddress->clID(),
                       sgAddress->name(),
                       sgAddress->transientID(),
                       std::vector<std::string>(sgAddress->alias()),
                       sgAddress->address(),
                       tokAddress, pTag)
{
}

DataHeaderElement() [4/6]

DataHeaderElement::DataHeaderElement	(	const SG::DataProxy *	proxy,
		IOpaqueAddress *	tokAddress,
		const std::string &	pTag )

Constructor.

Parameters

proxy	[IN] pointer to DataProxy for which a DataHeaderElement is created.
pTag	[IN] string used as key element in DataHeader (SG key for DataObjects).

Definition at line 42 of file DataHeader.cxx.

  : DataHeaderElement (proxy->clID(),
                       proxy->name(),
                       proxy->transientID(),
                       proxy->alias(),
                       proxy->address(),
                       tokAddress, pTag)
{
}

DataHeaderElement() [5/6]

DataHeaderElement::DataHeaderElement	(	const CLID	classID,
		const std::string &	key,
		Token &&	token )

Constructor.

Parameters

classID	[IN] Primary ClassID of the DataObject for which a DataHeaderElement is created.
key	[IN] SG Key of the DataObject for which a DataHeaderElement is created.
token	[IN] Token of the DataObject for which a DataHeaderElement is created.

Definition at line 85 of file DataHeader.cxx.

    : m_pClid(classID), m_clids(), m_key(key), m_alias(), m_token(std::move(token)), m_hashes() {
}

~DataHeaderElement()

DataHeaderElement::~DataHeaderElement ( )

virtual

Destructor.

Definition at line 90 of file DataHeader.cxx.

                                      {
}

DataHeaderElement() [6/6]

DataHeaderElement::DataHeaderElement ( CLID clid, const std::string & name, const std::vector< CLID > & tClids, std::vector< std::string > && alias, IOpaqueAddress * tadAddress, IOpaqueAddress * tokAddress, const std::string & pTag )

private

Internal constructor.

Definition at line 53 of file DataHeader.cxx.

  : m_pClid(clid),
    m_clids(tClids),
    m_key((pTag.empty()) ? name : pTag),
    m_alias(std::move(alias)),
    m_hashes()
{
  std::ranges::sort (m_clids);
  const auto ret = std::ranges::unique (m_clids);
  m_clids.erase (ret.begin(), ret.end());
  std::erase (m_clids, m_pClid);
  TokenAddress* tokAddr = dynamic_cast<TokenAddress*>(tokAddress);
  if (tokAddr != 0 && tokAddr->getToken() != 0) {
    tokAddr->getToken()->setData (&m_token);
  } else {
    tokAddr = dynamic_cast<TokenAddress*>(tadAddress);
    if (tokAddr != 0 && tokAddr->getToken() != 0) {
      tokAddr->getToken()->setData (&m_token);
    } else if (tokAddress != 0) {
      m_token.fromString(*(tokAddress->par()));
    } else if (tadAddress != 0) {
      m_token.fromString(*(tadAddress->par()));
    }
  }
}

Member Function Documentation

addHash()

void DataHeaderElement::addHash

(

IStringPool *

pool

)

Add new entry to hash map.

Definition at line 135 of file DataHeader.cxx.

                                                 {
   if (!m_hashes.empty()) {
      return;
   }
   std::set<CLID> clids = getClassIDs();
   for (std::set<CLID>::iterator iter = clids.begin(), last = clids.end(); iter != last; ++iter) {
      m_hashes.push_back(pool->stringToKey(m_key, *iter));
   }
}

dump()

void DataHeaderElement::dump

(

std::ostream &

ostr

)

const

Definition at line 173 of file DataHeader.cxx.

{
   using namespace std;
   std::println (ostr, "SGKey: {}", getKey());
   std::print (ostr, "CLID: {}", getPrimaryClassID());
   if( getClassIDs().size() > 1 ) {
      std::print (ostr, " ||");
      for( auto& c : getClassIDs() ) std::print (ostr, " {}", c);
   }
   std::println();
   if( getAlias().size() > 0 ) {
      std::print (ostr, "Alias: ");
      for( const std::string& a : getAlias() ) std::print (ostr, " {}", a);
      std::println();
   }
   std::println (ostr, "Token: {}", m_token.toString());
   if( m_hashes.size() ) {
      std::print (ostr, "Hashes:");
      for( auto h : m_hashes ) std::print (ostr,  " {}", h);
      std::println();
   }
}

getAddress() [1/2]

SG::TransientAddress * DataHeaderElement::getAddress

(

long

storageType

)

const

Returns

a pointer to the TransientAddress of the DataObject.

Definition at line 145 of file DataHeader.cxx.

                                                                        {
   return getAddress(storageType, m_key);
}

getAddress() [2/2]

SG::TransientAddress * DataHeaderElement::getAddress	(	long	storageType,
		const std::string &	key ) const

Returns

a pointer to the TransientAddress of the DataObject, with new transient key.

Definition at line 149 of file DataHeader.cxx.

                                                                                              {
   CLID primaryClID = getPrimaryClassID();
   TokenAddress* tokAdd = new TokenAddress(storageType, primaryClID, "", m_key, 0, &m_token);
   SG::TransientAddress* sgAddress = new SG::TransientAddress(primaryClID, key, tokAdd, m_clids);
   if (!m_hashes.empty()) {
     // If we have the sgkey corresponding to the primary clid, record
     // it in the address.  This will allow us to do lookups later by sgkey
     // rather than by name.
     // But be careful: the key for the primary clid is not necessarily
     // the first one in m_hashes.  The keys in m_hashes correspond to
     // all the CLIDs in ascending order.  m_clids holds all CLIDs
     // _except_ for the primary one, in sorted order.
     // So we want to find the index at which the primary CLID would
     // be inserted into m_clids to keep it sorted.  We could do this
     // using std::upper_bound.  However, in the common cases, we only
     // have about 2 entries in m_clids.  In that case, it's faster
     // to just do a linear search.
     auto it = std::ranges::find_if (m_clids, std::bind_front(std::less<int>{}, primaryClID));
     sgAddress->setSGKey (m_hashes[it - m_clids.begin()]);
   }
   sgAddress->setAlias(m_alias);
   return(sgAddress);
}

getAlias()

const std::vector< std::string > & DataHeaderElement::getAlias

(

)

const

Returns

StoreGate alias string vector.

Definition at line 122 of file DataHeader.cxx.

                                                              {
   return(m_alias);
}

getClassIDs()

const std::set< CLID > DataHeaderElement::getClassIDs

(

)

const

Returns

a set of all ClassIDs (primary and symlinked).

Definition at line 112 of file DataHeader.cxx.

                                                        {
  std::set<CLID> allClids (m_clids.begin(), m_clids.end());
  allClids.insert(m_pClid);
  return(allClids);
}

getHashes()

const std::vector< DataHeaderElement::sgkey_t > & DataHeaderElement::getHashes

(

)

const

Returns

the list of hash codes. In 1-1 correspondence with the CLID set.

Definition at line 131 of file DataHeader.cxx.

                                   {
   return(m_hashes);
}

getKey()

const std::string & DataHeaderElement::getKey

(

)

const

Returns

StoreGate key string.

Definition at line 118 of file DataHeader.cxx.

                                                 {
   return(m_key);
}

getPrimaryClassID()

CLID DataHeaderElement::getPrimaryClassID

(

)

const

Returns

primary ClassID.

Definition at line 105 of file DataHeader.cxx.

                                                {
   if (m_pClid > 0) {
      return(m_pClid);
   }
   return(m_clids.front());
}

getToken()

const Token * DataHeaderElement::getToken

(

)

const

Returns

token by pointer (and give away ownership).

Definition at line 126 of file DataHeader.cxx.

                                               {
   return(&m_token);
}

operator=()

DataHeaderElement & DataHeaderElement::operator=

(

const DataHeaderElement &

rhs

)

Assignment Operator.

Definition at line 93 of file DataHeader.cxx.

                                                                          {
   if (this != &rhs) {
      m_pClid = rhs.m_pClid;
      m_clids = rhs.m_clids;
      m_key = rhs.m_key;
      m_alias = rhs.m_alias;
      rhs.getToken()->setData(&m_token);
      m_hashes = rhs.m_hashes;
   }
   return(*this);
}

Friends And Related Symbol Documentation

DataHeaderCnv_p6

friend class DataHeaderCnv_p6

friend

Definition at line 94 of file DataHeader.h.

DataHeaderElementCnv_p3

friend class DataHeaderElementCnv_p3

friend

Definition at line 91 of file DataHeader.h.

DataHeaderElementCnv_p4

friend class DataHeaderElementCnv_p4

friend

Definition at line 92 of file DataHeader.h.

DataHeaderElementCnv_p5

friend class DataHeaderElementCnv_p5

friend

Definition at line 93 of file DataHeader.h.

Member Data Documentation

m_alias

std::vector<std::string> DataHeaderElement::m_alias

private

vector of StoreGate alias string.

Definition at line 111 of file DataHeader.h.

m_clids

std::vector<CLID> DataHeaderElement::m_clids

private

vector of unsigned long to store ClassID's for symlinked container.

Definition at line 107 of file DataHeader.h.

m_hashes

std::vector<sgkey_t> DataHeaderElement::m_hashes

private

hash table for ElementLink host container keys.

Definition at line 115 of file DataHeader.h.

m_key

std::string DataHeaderElement::m_key

private

string with StoreGate key.

Definition at line 109 of file DataHeader.h.

m_pClid

CLID DataHeaderElement::m_pClid

private

primary ClassID.

Definition at line 105 of file DataHeader.h.

m_token

Token DataHeaderElement::m_token

private

Transient address token.

Definition at line 113 of file DataHeader.h.

---

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

• DataHeader.h
• DataHeader.cxx