#include <TransientAddress.h>

Collaboration diagram for SG::TransientAddress:

Public Types
typedef std::vector< CLID >	TransientClidSet
	Strictly a set, but there shouldn't be more than a handful of entries, so store it as a sorted vector instead. More...

typedef std::vector< std::string >	TransientAliasSet

typedef IStringPool::sgkey_t	sgkey_t
	Default Constructor. More...

Public Member Functions
	TransientAddress ()
	Construct from clid and string key: More...

	TransientAddress (CLID id, const std::string &key)
	Construct from clid, key and IOpaqueAddress. More...

	TransientAddress (CLID id, const std::string &key, IOpaqueAddress *addr, bool clearAddress=true)
	Constructor giving full list of symlinked IDs — used from DataHeaderElement::getAddress(). More...

	TransientAddress (CLID id, const std::string &key, IOpaqueAddress *addr, const std::vector< CLID > &clids)

	TransientAddress (const TransientAddress &)

	TransientAddress (TransientAddress &&)
	Destructor. More...

	~TransientAddress ()

TransientAddress &	operator= (const TransientAddress &)

TransientAddress &	operator= (TransientAddress &&)

void	setID (CLID id, const std::string &key)
	Set the CLID / key. More...

void	reset ()
	Retrieve IOpaqueAddress. More...

IOpaqueAddress *address	ATLAS_NOT_CONST_THREAD_SAFE () const
	set IOpaqueAddress More...

void	setAddress (IOpaqueAddress *pAddress)
	Retrieve primary clid. More...

CLID	clID () const
	Retrieve string key: More...

const std::string &	name () const
	Get the primary (hashed) SG key. More...

sgkey_t	sgkey () const
	Set the primary (hashed) SG key. More...

void	setSGKey (sgkey_t sgkey)
	check if it is a transient ID (primary or symLinked): More...

bool	transientID (CLID id) const
	set transient CLID's More...

void	setTransientID (CLID id)
	get transient CLID's More...

const TransientClidSet &	transientID () const
	set alias' More...

void	setAlias (const std::string &key)
	set alias' More...

void	setAlias (const std::vector< std::string > &keys)
	set alias' More...

void	setAlias (std::vector< std::string > &&keys)
	set transient Alias' More...

bool	removeAlias (const std::string &key)
	remove alias from proxy More...

bool	hasAlias (const std::string &key) const
	get transient alias More...

const TransientAliasSet &	alias () const
	set the clearAddress flag: IOA will not be deleted in proxy More...

void	clearAddress (const bool &flag)
	Return the clearAddress flag. More...

bool	clearAddress () const
	this sets the flag whether to consult the provider to update this transient address if the IOA is not valid. More...

void	consultProvider (const bool &flag)
	Check the validity of the Transient Address. More...

bool	isValid (const EventContext *ctx, bool forceUpdate=false)
	cache the pointer to the Address provider which can update this transient address More...

IAddressProvider *	provider ()

StoreID::type	storeID () const

void	setProvider (IAddressProvider *provider, StoreID::type storeID)

Private Member Functions
	TransientAddress (CLID id, const std::string &key, IOpaqueAddress *addr, bool clearAddress, bool consultProvider)

Private Attributes
std::atomic< CLID >	m_clid
	< clid of the concrete class (persistent clid) More...

std::atomic< sgkey_t >	m_sgkey
	Store type, needed by updateAddress. More...

StoreID::type	m_storeID
	Controls if IOpaqueAddress should be deleted: More...

bool	m_clearAddress
	Control whether the Address Provider must be consulted. More...

bool	m_consultProvider
	IOpaqueAddress: More...

IOpaqueAddress *	m_address
	AddressProvider. More...

IAddressProvider *	m_pAddressProvider
	string key of this object More...

CxxUtils::CachedValue< std::string >	m_name
	all transient clids. They come from symlinks More...

TransientClidSet	m_transientID
	all alias names for a DataObject. They come from setAlias More...

TransientAliasSet	m_transientAlias

Static Private Attributes
static const std::string	s_emptyString

Detailed Description

Definition at line 31 of file TransientAddress.h.

Member Typedef Documentation

◆ sgkey_t

typedef IStringPool::sgkey_t SG::TransientAddress::sgkey_t

Default Constructor.

Definition at line 41 of file TransientAddress.h.

◆ TransientAliasSet

typedef std::vector<std::string> SG::TransientAddress::TransientAliasSet

Definition at line 40 of file TransientAddress.h.

◆ TransientClidSet

typedef std::vector<CLID> SG::TransientAddress::TransientClidSet

Strictly a set, but there shouldn't be more than a handful of entries, so store it as a sorted vector instead.

Definition at line 38 of file TransientAddress.h.

Constructor & Destructor Documentation

◆ TransientAddress() [1/7]

TransientAddress::TransientAddress ( )

Construct from clid and string key:

Definition at line 18 of file TransientAddress.cxx.

   : TransientAddress (CLID_NULL, "", nullptr, true, false)
 {
 }

◆ TransientAddress() [2/7]

TransientAddress::TransientAddress	(	CLID	id,
		const std::string &	key
	)

Construct from clid, key and IOpaqueAddress.

Definition at line 25 of file TransientAddress.cxx.

   : TransientAddress (id, key, nullptr, true, false)
 { 
   if (id != CLID_NULL)
     m_transientID.push_back(id);
 }

◆ TransientAddress() [3/7]

TransientAddress::TransientAddress	(	CLID	id,
		const std::string &	key,
		IOpaqueAddress *	addr,
		bool	clearAddress = `true`
	)

Constructor giving full list of symlinked IDs — used from DataHeaderElement::getAddress().

Definition at line 34 of file TransientAddress.cxx.

   : TransientAddress (id, key, addr, clearAddress, true)
 {
   if (id != CLID_NULL)
     m_transientID.push_back(id);
 }

◆ TransientAddress() [4/7]

TransientAddress::TransientAddress	(	CLID	id,
		const std::string &	key,
		IOpaqueAddress *	addr,
		const std::vector< CLID > &	clids
	)

Definition at line 46 of file TransientAddress.cxx.

   : TransientAddress (id, key, addr, true, true)
 {
   m_transientID.reserve (clids.size() + 1);
   m_transientID = clids;
   if (id != CLID_NULL) {
     m_transientID.push_back (id);
     std::ranges::sort (m_transientID);
   }
 }

◆ TransientAddress() [5/7]

TransientAddress::TransientAddress ( const TransientAddress & other )

Definition at line 83 of file TransientAddress.cxx.

   : m_clid (static_cast<CLID>(other.m_clid)),
     m_sgkey (static_cast<sgkey_t>(other.m_sgkey)),
     m_storeID (other.m_storeID),
     m_clearAddress (other.m_clearAddress),
     m_consultProvider (other.m_consultProvider),
     m_pAddressProvider (other.m_pAddressProvider),
     m_name (other.m_name),
     m_transientID (other.m_transientID),
     m_transientAlias (other.m_transientAlias)
 {
   m_address = nullptr;
   setAddress (other.m_address);
 }

◆ TransientAddress() [6/7]

TransientAddress::TransientAddress ( TransientAddress && other )

Destructor.

Definition at line 99 of file TransientAddress.cxx.

   : m_clid (static_cast<CLID>(other.m_clid)),
     m_sgkey (static_cast<sgkey_t>(other.m_sgkey)),
     m_storeID (other.m_storeID),
     m_clearAddress (other.m_clearAddress),
     m_consultProvider (other.m_consultProvider),
     m_pAddressProvider (other.m_pAddressProvider),
     m_name (std::move (other.m_name)),
     m_transientID (std::move (other.m_transientID)),
     m_transientAlias (std::move (other.m_transientAlias))
 {
   m_address = other.m_address;
   other.m_address = nullptr;
 }

◆ ~TransientAddress()

TransientAddress::~TransientAddress ( )

Definition at line 116 of file TransientAddress.cxx.

 { 
   setAddress(0);
 }

◆ TransientAddress() [7/7]

TransientAddress::TransientAddress	(	CLID	id,
		const std::string &	key,
		IOpaqueAddress *	addr,
		bool	clearAddress,
		bool	consultProvider
	)

private

Definition at line 62 of file TransientAddress.cxx.

   : m_clid(id),
     m_sgkey(0),
     m_storeID(StoreID::UNKNOWN),
     m_clearAddress(clearAddress),
     m_consultProvider(consultProvider),
     m_address(nullptr),
     m_pAddressProvider(nullptr)
 {
   if (!key.empty()) {
     m_name.store (key);
   }
   if (addr) {
     setAddress(addr);
   }
 }

Member Function Documentation

◆ alias()

const TransientAddress::TransientAliasSet & SG::TransientAddress::alias ( ) const

inline

set the clearAddress flag: IOA will not be deleted in proxy

get transient Alias'

Definition at line 301 of file TransientAddress.h.

   { 
     return m_transientAlias;
   }

◆ ATLAS_NOT_CONST_THREAD_SAFE()

IOpaqueAddress* address SG::TransientAddress::ATLAS_NOT_CONST_THREAD_SAFE ( ) const

set IOpaqueAddress

◆ clearAddress() [1/2]

bool SG::TransientAddress::clearAddress ( ) const

inline

this sets the flag whether to consult the provider to update this transient address if the IOA is not valid.

Return the clearAddress flag.

Definition at line 315 of file TransientAddress.h.

   {
     return m_clearAddress;
   }

◆ clearAddress() [2/2]

void SG::TransientAddress::clearAddress ( const bool & flag )

inline

Return the clearAddress flag.

set the clearAddress flag: IOA will not be deleted in proxy

Definition at line 308 of file TransientAddress.h.

   {
     m_clearAddress = flag;
   }

◆ clID()

CLID SG::TransientAddress::clID ( ) const

inline

Retrieve string key:

Retrieve clid.

Definition at line 210 of file TransientAddress.h.

   { 
     return m_clid; 
   }

◆ consultProvider()

void SG::TransientAddress::consultProvider ( const bool & flag )

inline

Check the validity of the Transient Address.

cache the pointer to the Address provider which can update this transient address

If forceUpdate is true, then call updateAddress even if we already have an address. If ctx is nullptr, we don't try to update the address.

Definition at line 321 of file TransientAddress.h.

◆ hasAlias()

bool SG::TransientAddress::hasAlias ( const std::string & key ) const

inline

get transient alias

Test for an alias.

Definition at line 294 of file TransientAddress.h.

   {
     return std::ranges::binary_search (m_transientAlias, key);
   }

◆ isValid()

bool TransientAddress::isValid	(	const EventContext *	ctx,
		bool	forceUpdate = `false`
	)

cache the pointer to the Address provider which can update this transient address

Definition at line 201 of file TransientAddress.cxx.

 {
   if (!forceUpdate && 0 != address()) return true;
  
   if (ctx && m_consultProvider && 0 != provider()) {
     if ((provider()->updateAddress(storeID(), this, *ctx)).isSuccess())
       return true;
   }
   return false;
 }

◆ name()

const std::string & SG::TransientAddress::name ( ) const

inline

Get the primary (hashed) SG key.

Return StoreGate key.

Definition at line 217 of file TransientAddress.h.

   {
     // Most of the time, m_name is set when the TransientAddress is created
     // and then never changed.  To handle dummy proxies though, m_name
     // can be created as blank and filled in later, but then never changed
     // again.  Used CachedValue to avoid having to use a lock for this.
     if (m_name.isValid()) {
       return *m_name.ptr();
     }
     return s_emptyString;
   }

◆ operator=() [1/2]

TransientAddress & TransientAddress::operator= ( const TransientAddress & other )

Definition at line 124 of file TransientAddress.cxx.

 {
   if (this != &other) {
     m_clid = static_cast<CLID>(other.m_clid);
     m_name = other.m_name;
     m_transientID = other.m_transientID;
     m_transientAlias = other.m_transientAlias;
     m_clearAddress = other.m_clearAddress;
     m_consultProvider = other.m_consultProvider;
     m_pAddressProvider = other.m_pAddressProvider;
     m_storeID = other.m_storeID;
     m_sgkey = static_cast<sgkey_t>(other.m_sgkey);
  
     setAddress (other.m_address);
   }
   return *this;
 }

◆ operator=() [2/2]

TransientAddress & TransientAddress::operator= ( TransientAddress && other )

Definition at line 143 of file TransientAddress.cxx.

 {
   if (this != &other) {
     m_clid = static_cast<CLID>(other.m_clid);
     m_name = std::move (other.m_name);
     m_transientID = std::move (other.m_transientID);
     m_transientAlias = std::move (other.m_transientAlias);
     m_clearAddress = other.m_clearAddress;
     m_consultProvider = other.m_consultProvider;
     m_pAddressProvider = other.m_pAddressProvider;
     m_storeID = other.m_storeID;
     m_sgkey = static_cast<sgkey_t>(other.m_sgkey);
  
     m_address = other.m_address;
     other.m_address = nullptr;
   }
   return *this;
 }

◆ provider()

IAddressProvider * SG::TransientAddress::provider ( )

inline

Definition at line 329 of file TransientAddress.h.

   {
     return m_pAddressProvider;
   }

◆ removeAlias()

bool SG::TransientAddress::removeAlias ( const std::string & key )

inline

remove alias from proxy

remove alias

Test for an alias.

Definition at line 283 of file TransientAddress.h.

   {
     auto it = std::ranges::lower_bound (m_transientAlias, key);
     if (it != m_transientAlias.end() && *it == key) {
       m_transientAlias.erase (it);
       return true;
     }
     return false;
   }

◆ reset()

void SG::TransientAddress::reset ( )

inline

Retrieve IOpaqueAddress.

Definition at line 196 of file TransientAddress.h.

   {
     if (m_clearAddress) setAddress(0);
   }

◆ setAddress()

void TransientAddress::setAddress ( IOpaqueAddress * pAddress )

Retrieve primary clid.

set IOpaqueAddress

Definition at line 194 of file TransientAddress.cxx.

 { 
   if (0 != pAddress) pAddress->addRef();
   if (0 != m_address) m_address->release();
   m_address = pAddress;
 }

◆ setAlias() [1/3]

void SG::TransientAddress::setAlias ( const std::string & key )

inline

set alias'

set transient Alias'

Definition at line 260 of file TransientAddress.h.

   {
     auto it = std::ranges::lower_bound (m_transientAlias, key);
     if (it == m_transientAlias.end() || *it != key) {
       m_transientAlias.insert (it, key);
     }
   } 

◆ setAlias() [2/3]

void SG::TransientAddress::setAlias ( const std::vector< std::string > & keys )

inline

set alias'

set transient Alias'

Definition at line 270 of file TransientAddress.h.

   {
     m_transientAlias = keys;
   } 

◆ setAlias() [3/3]

void SG::TransientAddress::setAlias ( std::vector< std::string > && keys )

inline

set transient Alias'

Definition at line 277 of file TransientAddress.h.

   {
     m_transientAlias = std::move(keys);
   } 

◆ setID()

void TransientAddress::setID	(	CLID	id,
		const std::string &	key
	)

Set the CLID / key.

This will only succeed if the clid/key are currently clear. Reset

Parameters

id	The new CLID.
key	The new StoreGate key.

This will only succeed if the clid/key are currently clear.

Definition at line 183 of file TransientAddress.cxx.

 {
   assert (m_clid == CLID_NULL && !m_name.isValid() && m_transientID.empty() &&
           m_transientAlias.empty());
   m_clid = id;
   m_name.set (key);
   if (id != CLID_NULL)
     m_transientID.push_back(id);
 }

◆ setProvider()

void SG::TransientAddress::setProvider	(	IAddressProvider *	provider,
		StoreID::type	storeID
	)

inline

Definition at line 340 of file TransientAddress.h.

   {
     m_pAddressProvider = provider;
     m_consultProvider = true;
     m_storeID=storeID;
   }

◆ setSGKey()

void SG::TransientAddress::setSGKey ( sgkey_t sgkey )

inline

check if it is a transient ID (primary or symLinked):

Set the primary (hashed) SG key.

Definition at line 238 of file TransientAddress.h.

   {
     m_sgkey = sgkey;
   }

◆ setTransientID()

void TransientAddress::setTransientID ( CLID id )

get transient CLID's

set transient CLID's

Definition at line 164 of file TransientAddress.cxx.

 {
   if (m_transientID.empty()) {
     m_transientID.push_back (id);
   }
   else if (!transientID (id)) {
     m_transientID.push_back (id);
     std::sort (m_transientID.begin(), m_transientID.end());
   }
 }

◆ sgkey()

TransientAddress::sgkey_t SG::TransientAddress::sgkey ( ) const

inline

Set the primary (hashed) SG key.

Get the primary (hashed) SG key.

Definition at line 231 of file TransientAddress.h.

   {
     return m_sgkey;
   }

◆ storeID()

StoreID::type SG::TransientAddress::storeID ( ) const

inline

Definition at line 334 of file TransientAddress.h.

   {
     return m_storeID;
   }

◆ transientID() [1/2]

const TransientAddress::TransientClidSet & SG::TransientAddress::transientID ( ) const

inline

set alias'

get transient CLID's

Definition at line 253 of file TransientAddress.h.

   {
     return m_transientID; 
   }

◆ transientID() [2/2]

bool SG::TransientAddress::transientID ( CLID id ) const

inline

set transient CLID's

check if it is a transient ID:

Definition at line 245 of file TransientAddress.h.

   {
     return std::find (m_transientID.begin(), m_transientID.end(), id) !=
       m_transientID.end();
   }

Member Data Documentation

◆ m_address

IOpaqueAddress* SG::TransientAddress::m_address

private

AddressProvider.

Definition at line 174 of file TransientAddress.h.

◆ m_clearAddress

bool SG::TransientAddress::m_clearAddress

private

Control whether the Address Provider must be consulted.

Definition at line 168 of file TransientAddress.h.

◆ m_clid

std::atomic<CLID> SG::TransientAddress::m_clid

private

< clid of the concrete class (persistent clid)

(hashed) SG key for primary clid / key.

Definition at line 159 of file TransientAddress.h.

◆ m_consultProvider

bool SG::TransientAddress::m_consultProvider

private

IOpaqueAddress:

Definition at line 171 of file TransientAddress.h.

◆ m_name

CxxUtils::CachedValue<std::string> SG::TransientAddress::m_name

private

all transient clids. They come from symlinks

Definition at line 180 of file TransientAddress.h.

◆ m_pAddressProvider

IAddressProvider* SG::TransientAddress::m_pAddressProvider

private

string key of this object

Definition at line 177 of file TransientAddress.h.

◆ m_sgkey

std::atomic<sgkey_t> SG::TransientAddress::m_sgkey

private

Store type, needed by updateAddress.

Definition at line 162 of file TransientAddress.h.

◆ m_storeID

StoreID::type SG::TransientAddress::m_storeID

private

Controls if IOpaqueAddress should be deleted:

Definition at line 165 of file TransientAddress.h.

◆ m_transientAlias

TransientAliasSet SG::TransientAddress::m_transientAlias

private

Definition at line 186 of file TransientAddress.h.

◆ m_transientID

TransientClidSet SG::TransientAddress::m_transientID

private

all alias names for a DataObject. They come from setAlias

Definition at line 183 of file TransientAddress.h.

◆ s_emptyString

const std::string TransientAddress::s_emptyString

staticprivate

Definition at line 188 of file TransientAddress.h.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ sgkey_t

◆ TransientAliasSet

◆ TransientClidSet

Constructor & Destructor Documentation

◆ TransientAddress() [1/7]

◆ TransientAddress() [2/7]

◆ TransientAddress() [3/7]

◆ TransientAddress() [4/7]

◆ TransientAddress() [5/7]

◆ TransientAddress() [6/7]

◆ ~TransientAddress()

◆ TransientAddress() [7/7]

Member Function Documentation

◆ alias()

◆ ATLAS_NOT_CONST_THREAD_SAFE()

◆ clearAddress() [1/2]

◆ clearAddress() [2/2]

◆ clID()

◆ consultProvider()

◆ hasAlias()

◆ isValid()

◆ name()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ provider()

◆ removeAlias()

◆ reset()

◆ setAddress()

◆ setAlias() [1/3]

◆ setAlias() [2/3]

◆ setAlias() [3/3]

◆ setID()

◆ setProvider()

◆ setSGKey()

◆ setTransientID()

◆ sgkey()

◆ storeID()

◆ transientID() [1/2]

◆ transientID() [2/2]

Member Data Documentation

◆ m_address

◆ m_clearAddress

◆ m_clid

◆ m_consultProvider

◆ m_name

◆ m_pAddressProvider

◆ m_sgkey

◆ m_storeID

◆ m_transientAlias

◆ m_transientID

◆ s_emptyString