An implicit collection implementation of the ICollection interface. More...

#include <ImplicitCollection.h>

Inheritance diagram for pool::ImplicitCollection:

Collaboration diagram for pool::ImplicitCollection:

Public Types
typedef Gaudi::PluginService::Factory< ICollection (const ICollectionDescription , ICollection::OpenMode, ISession *)>	Factory

enum	OpenMode { CREATE, CREATE_AND_OVERWRITE, UPDATE, READ }
	Enumeration of the possible open modes of the collection. More...

Public Member Functions
	ImplicitCollection (ISession *session, const std::string &connection, const std::string &name, ICollection::OpenMode mode)
	Constructor - old style Throws POOL exception. More...

	ImplicitCollection (const ICollectionDescription description, ICollection::OpenMode mode, ISession session)
	Constructor compying to the new Collections API parameters as above, but name and connection passed in description. More...

	~ImplicitCollection ()
	Destructor. More...

	ImplicitCollection (const ImplicitCollection &)=delete

ImplicitCollection &	operator= (const ImplicitCollection &)=delete

virtual ICollection::OpenMode	openMode () const
	Return openMode. More...

ImplicitCollectionIterator *	select (const std::string &primaryQuery="", std::string secondaryQuery="", std::string options="")
	Method that returns collection's iterator Throws POOL exception. More...

virtual void	insertRow (const pool::CollectionRowBuffer &inputRowBuffer)
	Adds a new row of data to the collection. Will always throw exception. More...

void	commit (bool reopen=false)
	Commits the last changes made to the collection. Will always return true. More...

void	rollback ()
	Aborts the last changes made to the collection. Will always return true. More...

void	close ()
	no-op at the moment More...

void	open ()
	no-op at the moment More...

bool	isOpen () const
	Checks if the collection is open. More...

virtual const ICollectionDescription &	description () const
	Returns an object used to describe the collection properties. More...

virtual ICollectionQuery *	newQuery ()
	Returns an object used to query the collection. More...

virtual void	initNewRow (pool::CollectionRowBuffer &row) const
	Initialize a new RowBuffer by adding all Attributes adn Tokens of this collection to it. More...

bool	msgLvl (const MSG::Level lvl) const
	Test the output level. More...

MsgStream &	msg () const
	The standard message stream. More...

MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...

void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

Protected Member Functions
void	open (ICollection::OpenMode mode, ISession *session)

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
IContainer *	m_container
	The underlying container handle. More...

CollectionDescription	m_description

std::string	m_nm
	Message source name. More...

boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...

std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...

std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...

std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

An implicit collection implementation of the ICollection interface.

Definition at line 26 of file ImplicitCollection.h.

Member Typedef Documentation

◆ Factory

typedef Gaudi::PluginService::Factory<ICollection*( const ICollectionDescription*, ICollection::OpenMode, ISession*)> pool::ImplicitCollection::Factory

Definition at line 30 of file ImplicitCollection.h.

Member Enumeration Documentation

◆ OpenMode

enum pool::ICollection::OpenMode

inherited

Enumeration of the possible open modes of the collection.

Enumerator
CREATE
CREATE_AND_OVERWRITE
UPDATE
READ

Definition at line 26 of file ICollection.h.

26 { CREATE, CREATE_AND_OVERWRITE, UPDATE, READ } OpenMode;

Constructor & Destructor Documentation

◆ ImplicitCollection() [1/3]

pool::ImplicitCollection::ImplicitCollection	(	ISession *	session,
		const std::string &	connection,
		const std::string &	name,
		ICollection::OpenMode	mode
	)

Constructor - old style Throws POOL exception.

Parameters

session	the session object
connection	database connection string. It has the format databaseNameType:databaseName, where databaseNameType can be FID, PFN or LFN.
name	the container name in the database
mode	collection's open mode. For the moment only READONLY mode is allowed.

◆ ImplicitCollection() [2/3]

pool::ImplicitCollection::ImplicitCollection	(	const ICollectionDescription *	description,
		ICollection::OpenMode	mode,
		ISession *	session
	)

Constructor compying to the new Collections API parameters as above, but name and connection passed in description.

◆ ~ImplicitCollection()

pool::ImplicitCollection::~ImplicitCollection ( )

Destructor.

◆ ImplicitCollection() [3/3]

pool::ImplicitCollection::ImplicitCollection ( const ImplicitCollection & )

delete

Member Function Documentation

◆ close()

void pool::ImplicitCollection::close ( )

virtual

no-op at the moment

Implements pool::ICollection.

◆ commit()

void pool::ImplicitCollection::commit ( bool reopen = false )

virtual

Commits the last changes made to the collection. Will always return true.

Implements pool::ICollection.

◆ description()

virtual const ICollectionDescription& pool::ImplicitCollection::description ( ) const

virtual

Returns an object used to describe the collection properties.

Implements pool::ICollection.

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

 {
   m_imsg = Athena::getMessageSvc();
   m_lvl = m_imsg ?
     static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
     MSG::INFO;
 }

◆ initNewRow()

virtual void pool::ICollection::initNewRow ( pool::CollectionRowBuffer & row ) const

virtualinherited

Initialize a new RowBuffer by adding all Attributes adn Tokens of this collection to it.

◆ insertRow()

virtual void pool::ImplicitCollection::insertRow ( const pool::CollectionRowBuffer & inputRowBuffer )

virtual

Adds a new row of data to the collection. Will always throw exception.

Implements pool::ICollection.

◆ isOpen()

bool pool::ImplicitCollection::isOpen ( ) const

virtual

Checks if the collection is open.

Implements pool::ICollection.

◆ msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 164 of file AthMessaging.h.

 {
   MsgStream* ms = m_msg_tls.get();
   if (!ms) {
     if (!m_initialized.test_and_set()) initMessaging();
     ms = new MsgStream(m_imsg,m_nm);
     m_msg_tls.reset( ms );
   }
  
   ms->setLevel (m_lvl);
   return *ms;
 }

◆ msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 179 of file AthMessaging.h.

180 { return msg() << lvl; }

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns: boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

 {
   if (!m_initialized.test_and_set()) initMessaging();
   if (m_lvl <= lvl) {
     msg() << lvl;
     return true;
   } else {
     return false;
   }
 }

◆ newQuery()

virtual ICollectionQuery* pool::ImplicitCollection::newQuery ( )

virtual

Returns an object used to query the collection.

Implements pool::ICollection.

◆ open() [1/2]

void pool::ImplicitCollection::open ( )

virtual

no-op at the moment

Implements pool::ICollection.

◆ open() [2/2]

void pool::ImplicitCollection::open	(	ICollection::OpenMode	mode,
		ISession *	session
	)

protected

◆ openMode()

virtual ICollection::OpenMode pool::ImplicitCollection::openMode ( ) const

virtual

Return openMode.

Implements pool::ICollection.

◆ operator=()

ImplicitCollection& pool::ImplicitCollection::operator= ( const ImplicitCollection & )

delete

◆ rollback()

void pool::ImplicitCollection::rollback ( )

Aborts the last changes made to the collection. Will always return true.

◆ select()

ImplicitCollectionIterator* pool::ImplicitCollection::select	(	const std::string &	primaryQuery = `""`,
		std::string	secondaryQuery = `""`,
		std::string	options = `""`
	)

Method that returns collection's iterator Throws POOL exception.

Parameters

primaryQuery	query string passed to the underlying StorageSvc implementation.
secondaryQuery	parameter currently unused
options	type currently unused

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

 {
   m_lvl = lvl;
 }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_container

IContainer* pool::ImplicitCollection::m_container

private

The underlying container handle.

Definition at line 99 of file ImplicitCollection.h.

◆ m_description

CollectionDescription pool::ImplicitCollection::m_description

private

Definition at line 101 of file ImplicitCollection.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

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

ImplicitCollection.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Factory

Member Enumeration Documentation

◆ OpenMode

Constructor & Destructor Documentation

◆ ImplicitCollection() [1/3]

◆ ImplicitCollection() [2/3]

◆ ~ImplicitCollection()

◆ ImplicitCollection() [3/3]

Member Function Documentation

◆ close()

◆ commit()

◆ description()

◆ initMessaging()

◆ initNewRow()

◆ insertRow()

◆ isOpen()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ newQuery()

◆ open() [1/2]

◆ open() [2/2]

◆ openMode()

◆ operator=()

◆ rollback()

◆ select()

◆ setLevel()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_container

◆ m_description

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nm