Specialization of RootAuxDynStore for reading Aux Dynamic attributes from RNTuple. More...

Classes
struct	AuxInfo

class	IRNTupleAuxDynWriter
	Interface for a RNTuple-based Writer that handles AuxDyn attributes Works in conjuction with the generic writer. More...

class	IRootAuxDynReader

class	IRootAuxDynWriter
	Interface for an AuxDyn Writer - TTree based. More...

class	RNTupleAuxDynReader

class	RNTupleAuxDynWriter

class	TBranchAuxDynWriter

Typedefs
typedef std::tuple< std::string, std::string, void * >	attrDataTuple

Functions
bool	endsWithAuxPostfix (std::string_view str)
	Check if a string ends with AUX_POSTFIX. More...

bool	removeAuxPostfix (std::string &str)
	if a string ends with AUX_POSTFIX then remove it More...

std::string	auxBranchName (const std::string &attr_name, const std::string &baseBranchName)
	Construct branch name for a given dynamic attribute. More...

std::string	auxFieldName (const std::string &attr_name, const std::string &baseName)
	Construct field name for a given dynamic attribute. More...

bool	hasAuxStore (std::string_view fieldname, TClass *tc)
	check if a field/branch with fieldname and type tc has IAuxStore interface More...

bool	isAuxDynBranch (TBranch *branch)
	Check is a branch holds AuxStore objects. More...

std::string	getKeyFromBranch (TBranch *branch)
	Exctract the Aux object SG Key from the branch name. More...

std::unique_ptr< IRootAuxDynReader >	getBranchAuxDynReader (TTree , TBranch )

std::unique_ptr< IRootAuxDynWriter >	getBranchAuxDynWriter (TTree *tree, int bufferSize, int splitLevel, int offsettab_len, bool do_branch_fill)
	generate TBranchAuxDynWriter tree -> destination tree do_branch_fill -> flag telling to Fill each TBranch immediately More...

std::unique_ptr< IRootAuxDynReader >	getNTupleAuxDynReader (const std::string &field_name, const std::string &field_type, RNTupleReader *reader)

std::unique_ptr< IRNTupleAuxDynWriter >	getNTupleAuxDynWriter ()

std::unique_ptr< IRNTupleWriter >	getNTupleWriter (TFile *, const std::string &ntupleName, bool enableBufferedWrite, bool enableMetrics)

Variables
constexpr char	AUX_POSTFIX [] = "Aux."
	Common post-fix for the names of auxiliary containers in StoreGate. More...

constexpr size_t	AUX_POSTFIX_LEN = sizeof(AUX_POSTFIX)-1

constexpr char	AUXDYN_POSTFIX [] = "Dyn."

constexpr size_t	AUXDYN_POSTFIX_LEN = sizeof(AUXDYN_POSTFIX)-1

Detailed Description

Specialization of RootAuxDynStore for reading Aux Dynamic attributes from RNTuple.

Author: Marcin Nowak

Typedef Documentation

◆ attrDataTuple

typedef std::tuple<std::string, std::string, void*> RootAuxDynIO::attrDataTuple

Definition at line 72 of file RootAuxDynIO.h.

Function Documentation

◆ auxBranchName()

std::string RootAuxDynIO::auxBranchName	(	const std::string &	attr_name,
		const std::string &	baseBranchName
	)

inline

Construct branch name for a given dynamic attribute.

Parameters

attr_name	the name of the attribute
baseBranchName	branch name for the main AuxStore object

Definition at line 60 of file RootAuxDynDefs.h.

 {
    std::string branch_name = baseBranchName;
    if( !branch_name.empty() and branch_name.back() == '.' )  branch_name.pop_back();
    branch_name += RootAuxDynIO::AUXDYN_POSTFIX + attr_name;
    return branch_name;
 }

◆ auxFieldName()

std::string RootAuxDynIO::auxFieldName	(	const std::string &	attr_name,
		const std::string &	baseName
	)

inline

Construct field name for a given dynamic attribute.

Parameters

attr_name	the name of the attribute
baseBranchName	branch name for the main AuxStore object

Definition at line 69 of file RootAuxDynDefs.h.

 {
    // RNTuple field names cannot contain dot characters '.'
    // Therefore, for now, we're using a colon instead ':'
    // This can be changed in the future
    std::string field_name = baseName;
    if (field_name.ends_with(':')) {
      field_name.pop_back();
    }
    field_name = std::format("{}Dyn:{}", field_name, attr_name);
    return field_name;
 }

◆ endsWithAuxPostfix()

bool RootAuxDynIO::endsWithAuxPostfix ( std::string_view str )

inline

Check if a string ends with AUX_POSTFIX.

Parameters

str	the string to check

Definition at line 21 of file RootAuxDynDefs.h.

                                                       {
       return str.ends_with(AUX_POSTFIX);
    }

◆ getBranchAuxDynReader()

std::unique_ptr< RootAuxDynIO::IRootAuxDynReader > RootAuxDynIO::getBranchAuxDynReader	(	TTree *	tree,
		TBranch *	branch
	)

Definition at line 78 of file RootAuxDynIO.cxx.

                                                        {
       return std::make_unique<TBranchAuxDynReader>(tree, branch);
    }

◆ getBranchAuxDynWriter()

std::unique_ptr< RootAuxDynIO::IRootAuxDynWriter > RootAuxDynIO::getBranchAuxDynWriter	(	TTree *	tree,
		int	bufferSize,
		int	splitLevel,
		int	offsettab_len,
		bool	do_branch_fill
	)

generate TBranchAuxDynWriter tree -> destination tree do_branch_fill -> flag telling to Fill each TBranch immediately

Definition at line 93 of file RootAuxDynIO.cxx.

                                                                                                                {
       return std::make_unique<TBranchAuxDynWriter>(tree, bufferSize, splitLevel, offsettab_len, do_branch_fill);
    }

◆ getKeyFromBranch()

std::string RootAuxDynIO::getKeyFromBranch ( TBranch * branch )

Exctract the Aux object SG Key from the branch name.

Parameters

branch TBranch with Key in its name

Definition at line 38 of file RootAuxDynIO.cxx.

    {
       TClass *tc = 0;
       EDataType type;
       if( branch->GetExpectedType(tc, type) == 0  && tc != nullptr) {
          const char* brname = branch->GetName();
          const char* clname = tc->GetName();
          size_t namelen = strlen (clname);
          std::string key = brname;
          if( strncmp(brname, clname, namelen) == 0 && brname[namelen] == '_' ) {
             key.erase (0, namelen+1);
          }
          removeAuxPostfix(key);
          return key;
       }
       return "";
    }

◆ getNTupleAuxDynReader()

std::unique_ptr< RootAuxDynIO::IRootAuxDynReader > RootAuxDynIO::getNTupleAuxDynReader	(	const std::string &	field_name,
		const std::string &	field_type,
		RNTupleReader *	reader
	)

Definition at line 83 of file RootAuxDynIO.cxx.

                                                                                                           {
       return std::make_unique<RNTupleAuxDynReader>(field_name, field_type, reader);
    }

◆ getNTupleAuxDynWriter()

std::unique_ptr< RootAuxDynIO::IRNTupleAuxDynWriter > RootAuxDynIO::getNTupleAuxDynWriter ( )

Definition at line 98 of file RootAuxDynIO.cxx.

                            {
       return std::make_unique<RNTupleAuxDynWriter>();
    }

◆ getNTupleWriter()

std::unique_ptr<IRNTupleWriter> RootAuxDynIO::getNTupleWriter	(	TFile *	,
		const std::string &	ntupleName,
		bool	enableBufferedWrite,
		bool	enableMetrics
	)

◆ hasAuxStore()

bool RootAuxDynIO::hasAuxStore	(	std::string_view	fieldname,
		TClass *	tc
	)

check if a field/branch with fieldname and type tc has IAuxStore interface

Definition at line 28 of file RootAuxDynIO.cxx.

                                                      {
       // check the name first, and only if it does not match AUX_POSTFIX ask TClass
       return endsWithAuxPostfix(fieldname)
          or ( tc and ( tc->GetBaseClass("SG::IAuxStore")
                        // the IAuxStore property is used in DataModelTests
                        or RootType(tc).Properties().HasProperty("IAuxStore") ));
    }

◆ isAuxDynBranch()

bool RootAuxDynIO::isAuxDynBranch ( TBranch * branch )

Check is a branch holds AuxStore objects.

Parameters

branch TBranch to check

Definition at line 58 of file RootAuxDynIO.cxx.

    {
       const std::string bname = branch->GetName();
       TClass *tc = 0;
       EDataType type;
       if( branch->GetExpectedType(tc, type) ) {
          // error - not expecting this to happen ever, but better report
          errorcheck::ReportMessage msg (MSG::WARNING, ERRORCHECK_ARGS, "RootAuxDynIO::isAuxDynBranch");
          msg << "GetExpectedType() failed for branch: " << bname;
          return false;
       }
       if( hasAuxStore(bname, tc) ) {
           return tc->GetBaseClass("SG::IAuxStoreHolder") != nullptr;
       }
       return false;
    }

◆ removeAuxPostfix()

bool RootAuxDynIO::removeAuxPostfix ( std::string & str )

inline

if a string ends with AUX_POSTFIX then remove it

Parameters

str	the string to modify

Definition at line 49 of file RootAuxDynDefs.h.

 {
    if( endsWithAuxPostfix(str) ) {
       str.resize( str.size() - AUX_POSTFIX_LEN );
       return true;
    }
    return false;
 }

Variable Documentation

◆ AUX_POSTFIX

constexpr char RootAuxDynIO::AUX_POSTFIX[] = "Aux."

constexpr

Common post-fix for the names of auxiliary containers in StoreGate.

Definition at line 12 of file RootAuxDynDefs.h.

◆ AUX_POSTFIX_LEN

constexpr size_t RootAuxDynIO::AUX_POSTFIX_LEN = sizeof(AUX_POSTFIX)-1

constexpr

Definition at line 13 of file RootAuxDynDefs.h.

◆ AUXDYN_POSTFIX

constexpr char RootAuxDynIO::AUXDYN_POSTFIX[] = "Dyn."

constexpr

Definition at line 14 of file RootAuxDynDefs.h.

◆ AUXDYN_POSTFIX_LEN

constexpr size_t RootAuxDynIO::AUXDYN_POSTFIX_LEN = sizeof(AUXDYN_POSTFIX)-1

constexpr

Definition at line 15 of file RootAuxDynDefs.h.

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ attrDataTuple

Function Documentation

◆ auxBranchName()

◆ auxFieldName()

◆ endsWithAuxPostfix()

◆ getBranchAuxDynReader()

◆ getBranchAuxDynWriter()

◆ getKeyFromBranch()

◆ getNTupleAuxDynReader()

◆ getNTupleAuxDynWriter()

◆ getNTupleWriter()

◆ hasAuxStore()

◆ isAuxDynBranch()

◆ removeAuxPostfix()

Variable Documentation

◆ AUX_POSTFIX

◆ AUX_POSTFIX_LEN

◆ AUXDYN_POSTFIX

◆ AUXDYN_POSTFIX_LEN