RootAuxDynIO::TBranchAuxDynWriter Class Reference

#include <TBranchAuxDynWriter.h>

Inheritance diagram for RootAuxDynIO::TBranchAuxDynWriter:

Collaboration diagram for RootAuxDynIO::TBranchAuxDynWriter:

Public Member Functions
	TBranchAuxDynWriter (TTree &tree, TClass &cls, int bufferSize, int splitLevel, int offsettab_len, bool branch_fill)
virtual	~TBranchAuxDynWriter ()
virtual void	setBranchFillMode (bool mode) override final
	set Filling mode (true/false) for branch containers
void	createAuxBranch (AuxInfo &info)
void	setBranchOffsetTabLen (TBranch *b, int offsettab_len)
virtual int	writeAuxAttributes (const std::string &base_branchname, void *store, size_t backfill_nrows) override final
	handle writing of dynamic xAOD attributes of an object called from RootTreeContainer::writeObject()
virtual bool	needsCommit () override final
	is there a need to call commit()?
virtual int	commit () override final
	Call Fill() on the ROOT object used by this writer.
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.
bool	hasAuxDynStore () const

Protected Member Functions
int	auxStoreOffset (TClass &tc)
SG::IAuxStoreIO *	castIOStore (void *object)

Protected Attributes
TFile *	m_tfile = nullptr
TTree *	m_ttree = nullptr
int	m_bufferSize = 8192
int	m_splitLevel = 1
int	m_branchOffsetTabLen = 0
bool	m_branchFillMode = false
bool	m_needsFill = false
std::map< SG::auxid_t, AuxInfo >	m_auxInfoMap
	cached aux branches data by auxid
TClass &	m_holderType
	TClass of the type containing the AuxStore with attributes.
int	m_ioStoreOffset
	AuxStoreIO interface offset in the subclass type (for casting). negative means no inheritance.

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

Private Attributes
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

Definition at line 51 of file TBranchAuxDynWriter.h.

Constructor & Destructor Documentation

TBranchAuxDynWriter()

RootAuxDynIO::TBranchAuxDynWriter::TBranchAuxDynWriter	(	TTree &	tree,
		TClass &	cls,
		int	bufferSize,
		int	splitLevel,
		int	offsettab_len,
		bool	branch_fill )

Definition at line 42 of file TBranchAuxDynWriter.cxx.

                                                                                   :
      AthMessaging ("TBranchAuxDynWriter"), AuxDynAttrAccess(cls),
      m_ttree( &tree ),
      m_bufferSize( bufferSize ),
      m_splitLevel( splitLevel ),
      m_branchOffsetTabLen( offsettab_len ),
      m_branchFillMode( branch_fill )
   { }

~TBranchAuxDynWriter()

virtual RootAuxDynIO::TBranchAuxDynWriter::~TBranchAuxDynWriter ( )

inlinevirtual

Definition at line 55 of file TBranchAuxDynWriter.h.

{ }

Member Function Documentation

auxStoreOffset()

int RootAuxDynIO::AuxDynAttrAccess::auxStoreOffset ( TClass & tc )

protectedinherited

Definition at line 29 of file RootAuxDynIO.cxx.

   {
      TClass *storeTClass = tc.GetBaseClass("SG::IAuxStoreIO");
      if( storeTClass ) {
         // This is a class implementing SG::IAuxStoreIO
         // Find IAuxStoreIO interface offset
         return tc.GetBaseClassOffset( storeTClass );
      }
      return -1;
   }

castIOStore()

SG::IAuxStoreIO * RootAuxDynIO::AuxDynAttrAccess::castIOStore ( void * object )

protectedinherited

Definition at line 45 of file RootAuxDynIO.cxx.

                                                            {
      return ( hasAuxDynStore()?
               reinterpret_cast<SG::IAuxStoreIO*>( (char*)object + m_ioStoreOffset )
               : nullptr);
   }

commit()

int RootAuxDynIO::TBranchAuxDynWriter::commit ( )

finaloverridevirtual

Call Fill() on the ROOT object used by this writer.

Implements RootAuxDynIO::IRootAuxDynWriter.

Definition at line 193 of file TBranchAuxDynWriter.cxx.

                                   {
      ATH_MSG_WARNING("Commit for TBranchAuxDynWriter should be handled on the DB level");
      return 0;
   }

createAuxBranch()

void RootAuxDynIO::TBranchAuxDynWriter::createAuxBranch

(

AuxInfo &

info

)

Definition at line 68 of file TBranchAuxDynWriter.cxx.

                                                            {
      std::string error_type("is unknown");
      const std::type_info& ti = *info.typeinfo;
      try {
         auto createBasicAuxBranch = [&](const char* typeopt) {
            info.is_basic_type = true;
            info.branch = m_ttree->Branch(info.branch_name.c_str(), info.buffer, (info.name+typeopt).c_str(), 2048);
            ATH_MSG_VERBOSE("Created branch with name=" << info.branch_name << "  type: " << info.name+typeopt);
         };
         if     ( ti == typeid(UInt_t) )    createBasicAuxBranch("/i");
         else if( ti == typeid(Int_t) )     createBasicAuxBranch("/I");
         else if( ti == typeid(Double_t) )  createBasicAuxBranch("/D");
         else if( ti == typeid(Float_t) )   createBasicAuxBranch("/F");
         else if( ti == typeid(Long64_t)  or ti == typeid(std::int64_t) )  createBasicAuxBranch("/L");
         else if( ti == typeid(ULong64_t) or ti == typeid(std::uint64_t) ) createBasicAuxBranch("/l");
         else if( ti == typeid(Short_t) )   createBasicAuxBranch("/S");
         else if( ti == typeid(UShort_t) )  createBasicAuxBranch("/s");
         else if( ti == typeid(Char_t) )    createBasicAuxBranch("/B");
         else if( ti == typeid(UChar_t) )   createBasicAuxBranch("/b");
         else if( ti == typeid(bool) )      createBasicAuxBranch("/O");
         else if( ti == typeid(char*) || ti == typeid(unsigned char*) ) createBasicAuxBranch("/C");
         else {
            TClass* cl = TClass::GetClass(info.type_name.c_str());
            if( !cl ) {
               error_type =" has no TClass";
            } else if( !cl->GetStreamerInfo() )  {
               error_type =" has no streamer";
            } else if( !cl->HasDictionary() ) {
               error_type =" has no dictionary";
            } else {
               info.tclass = cl;
               int split = cl->CanSplit() ? m_splitLevel : 0;
               info.branch = m_ttree->Branch( info.branch_name.c_str(),  // Branch name
                                              cl->GetName(),             // Object class
                                              (void*)&info.buffer,       // Object address
                                              m_bufferSize,                // Buffer size
                                              split);                    // Split Mode (Levels)
            ATH_MSG_VERBOSE("Created branch with name=" << info.branch_name << "  type: " << cl->GetName());
            }
         }
      } catch( const std::exception& e ) {
         error_type += std::string("  Exception msg: ") + e.what();
      }
      catch (...)   {
         error_type += "  Unknown exception.";
      }
 
      if( !info.branch ) {
         throw std::runtime_error( std::string("Failed to create Auxiliary branch '") + info.branch_name
                                   + "'. Class: " + info.type_name + error_type );
      }
      // Set AUTO-DELETE OFF.  ROOT will not delete objects created by the framework
      info.branch->SetAutoDelete(kFALSE);
 
      setBranchOffsetTabLen( info.branch, m_branchOffsetTabLen );
   }

hasAuxDynStore()

bool RootAuxDynIO::AuxDynAttrAccess::hasAuxDynStore ( ) const

inherited

Definition at line 40 of file RootAuxDynIO.cxx.

   {
      return m_ioStoreOffset >= 0;
   }

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();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

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 163 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 178 of file AthMessaging.h.

{ 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_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

needsCommit()

virtual bool RootAuxDynIO::TBranchAuxDynWriter::needsCommit ( )

inlinefinaloverridevirtual

is there a need to call commit()?

Implements RootAuxDynIO::IRootAuxDynWriter.

Definition at line 72 of file TBranchAuxDynWriter.h.

{ return m_needsFill; }

setBranchFillMode()

virtual void RootAuxDynIO::TBranchAuxDynWriter::setBranchFillMode ( bool mode )

inlinefinaloverridevirtual

set Filling mode (true/false) for branch containers

Implements RootAuxDynIO::IRootAuxDynWriter.

Definition at line 58 of file TBranchAuxDynWriter.h.

{ m_branchFillMode = mode; }

setBranchOffsetTabLen()

void RootAuxDynIO::TBranchAuxDynWriter::setBranchOffsetTabLen	(	TBranch *	b,
		int	offsettab_len )

Definition at line 54 of file TBranchAuxDynWriter.cxx.

                                                                                {
      if( offsettab_len > 0 ) {
         if( b->GetEntryOffsetLen() > 0 )
            b->SetEntryOffsetLen( offsettab_len );
         TIter biter( b->GetListOfBranches() );
         TBranch* subbranch(nullptr);
         while( (subbranch = (TBranch*)biter.Next()) ) {
            setBranchOffsetTabLen( subbranch, offsettab_len );
         }
      }
   }

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;
}

writeAuxAttributes()

int RootAuxDynIO::TBranchAuxDynWriter::writeAuxAttributes ( const std::string & base_branchname, void * store, size_t backfill_nrows )

finaloverridevirtual

handle writing of dynamic xAOD attributes of an object called from RootTreeContainer::writeObject()

handle writing of dynamic xAOD attributes of an object - called from RootTreeContainer::writeObject()

Implements RootAuxDynIO::IRootAuxDynWriter.

Definition at line 128 of file TBranchAuxDynWriter.cxx.

   {
      SG::IAuxStoreIO *store = castIOStore(object);
      int bytes_written = 0;
      const SG::auxid_set_t selection = store->getSelectedAuxIDs();
      ATH_MSG_DEBUG("Writing " << base_branchname << " with " << selection.size() << " Dynamic attributes");
 
      // mark all attributes as not written yet
      for( auto& aux_info_entry : m_auxInfoMap )  aux_info_entry.second.written = false;
      m_needsFill = false;
 
      for(SG::auxid_t id : selection) {
         AuxInfo& attrInfo = m_auxInfoMap[id];
         if( !attrInfo.branch ) {
            // new attribute info, fill it
            attrInfo.typeinfo = store->getIOType(id);
            attrInfo.type_name = SG::normalizedTypeinfoName( *attrInfo.typeinfo );
            attrInfo.name = SG::AuxTypeRegistry::instance().getName(id);
            attrInfo.branch_name = RootAuxDynIO::auxBranchName(attrInfo.name, base_branchname);
 
            ATH_MSG_DEBUG("Creating branch for new dynamic attribute, Id=" << id << ": type=" << attrInfo.type_name
                          << ",  branch=" << attrInfo.branch_name );
            createAuxBranch( attrInfo );
            // backfill here
            if( backfill_nrows ) {
               // if this is not the first row, catch up with the rows written already to other branches
               ATH_MSG_DEBUG("  Backfilling " << backfill_nrows << " entries for " << attrInfo.name);
               // As of root 6.22, calling SetAddress with nullptr may not work as expected if the address had
               // previously been set to something non-null.
               // So we need to create the temp object ourselves.
               attrInfo.setDummyAddr();
               for( size_t r=0; r<backfill_nrows; ++r ) {
                  bytes_written += attrInfo.branch->BackFill();
                  ATH_MSG_VERBOSE("BACKFilled branch:" << m_ttree->GetName() << "::" << attrInfo.branch->GetName() <<
                                  " Tree size=" << m_ttree->GetEntries()
                                  << "  branch size:" << attrInfo.branch->GetEntries() );
               }
            }
         }
         void *obj ATLAS_THREAD_SAFE = const_cast<void*>( store->getIOData(id) );
         attrInfo.object = obj;
         attrInfo.branch->SetAddress( attrInfo.objectAddr() );
         attrInfo.written = true;
      }
 
      for( auto& aux_info_entry : m_auxInfoMap ) {
         AuxInfo& attrInfo = aux_info_entry.second;
         // if an attribute was not written create a default object for it
         if( !attrInfo.written ) {
            attrInfo.setDummyAddr();
            ATH_MSG_DEBUG("Default object added to branch: " << attrInfo.branch_name);
         }
         // if writing to branches independently, do it now
         if( m_branchFillMode ) {
            bytes_written += attrInfo.branch->Fill();
         } else {
            m_needsFill = true;
         }
      }
      return bytes_written;
   }

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_auxInfoMap

std::map<SG::auxid_t, AuxInfo> RootAuxDynIO::TBranchAuxDynWriter::m_auxInfoMap

protected

cached aux branches data by auxid

Definition at line 86 of file TBranchAuxDynWriter.h.

m_branchFillMode

bool RootAuxDynIO::TBranchAuxDynWriter::m_branchFillMode = false

protected

Definition at line 82 of file TBranchAuxDynWriter.h.

m_branchOffsetTabLen

int RootAuxDynIO::TBranchAuxDynWriter::m_branchOffsetTabLen = 0

protected

Definition at line 81 of file TBranchAuxDynWriter.h.

m_bufferSize

int RootAuxDynIO::TBranchAuxDynWriter::m_bufferSize = 8192

protected

Definition at line 79 of file TBranchAuxDynWriter.h.

m_holderType

TClass& RootAuxDynIO::AuxDynAttrAccess::m_holderType

protectedinherited

TClass of the type containing the AuxStore with attributes.

Definition at line 30 of file RootAuxDynIO.h.

m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_ioStoreOffset

int RootAuxDynIO::AuxDynAttrAccess::m_ioStoreOffset

protectedinherited

AuxStoreIO interface offset in the subclass type (for casting). negative means no inheritance.

Definition at line 32 of file RootAuxDynIO.h.

m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

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_needsFill

bool RootAuxDynIO::TBranchAuxDynWriter::m_needsFill = false

protected

Definition at line 83 of file TBranchAuxDynWriter.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_splitLevel

int RootAuxDynIO::TBranchAuxDynWriter::m_splitLevel = 1

protected

Definition at line 80 of file TBranchAuxDynWriter.h.

m_tfile

TFile* RootAuxDynIO::TBranchAuxDynWriter::m_tfile = nullptr

protected

Definition at line 77 of file TBranchAuxDynWriter.h.

m_ttree

TTree* RootAuxDynIO::TBranchAuxDynWriter::m_ttree = nullptr

protected

Definition at line 78 of file TBranchAuxDynWriter.h.

---

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

• TBranchAuxDynWriter.h
• TBranchAuxDynWriter.cxx