RootAuxDynIO Namespace Reference

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

Classes
class	AuxDynAttrAccess
struct	AuxInfo
class	FactoryTool
class	IFactoryTool
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.
bool	removeAuxPostfix (std::string &str)
	if a string ends with AUX_POSTFIX then remove it
std::string	auxBranchName (const std::string &attr_name, const std::string &baseBranchName)
	Construct branch name for a given dynamic attribute.
std::string	auxFieldName (const std::string &attr_name, const std::string &baseName)
	Construct field name for a given dynamic attribute.
std::string	getKeyFromBranch (TBranch *branch)
	Exctract the Aux object SG Key from the branch name.

Variables
constexpr char	AUX_POSTFIX [] = "Aux."
	Common post-fix for the names of auxiliary containers in StoreGate.
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 29 of file IRootAuxDynIO.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);
   }

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

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

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

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

constexpr

Definition at line 13 of file RootAuxDynDefs.h.

AUXDYN_POSTFIX

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

constexpr

Definition at line 14 of file RootAuxDynDefs.h.

AUXDYN_POSTFIX_LEN

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

constexpr

Definition at line 15 of file RootAuxDynDefs.h.