Gaudi::RootConnectionSetup Class Reference

#include </builds/gaudi/Gaudi/RootCnv/include/RootCnv/RootDataConnection.h>

Collaboration diagram for Gaudi::RootConnectionSetup:

Public Types
typedef std::vector< std::string >	StringVec
	Type definition for string maps.

Public Member Functions
	RootConnectionSetup ()=default
	Standard constructor.
void	setMessageSvc (MsgStream *m)
	Set message service reference.
MsgStream &	msgSvc () const
	Retrieve message service.
void	setIncidentSvc (IIncidentSvc *m)
	Set incident service reference.
IIncidentSvc *	incidentSvc () const
	Retrieve incident service.

Static Public Member Functions
static StatusCode	setCompression (std::string_view compression)
	Set the global compression level.
static int	compression ()
	Access to global compression level.

Public Attributes
StringVec	cacheBranches
	Vector of strings with branches to be cached for input files.
StringVec	vetoBranches
	Vector of strings with branches to NOT be cached for input files.
std::string	loadSection
	RootCnvSvc Property: Root data cache size.
int	cacheSize { 0 }
	RootCnvSvc Property: Root data cache size.
int	learnEntries { 0 }
	RootCnvSvc Property: ROOT cache learn entries.
Gaudi::Property< bool >	produceReproducibleFiles
Gaudi::Property< bool >	root630ForwardCompatibility

Private Attributes
std::unique_ptr< MsgStream >	m_msgSvc
	Reference to message service.
SmartIF< IIncidentSvc >	m_incidentSvc = nullptr
	Reference to incident service.

Detailed Description

Definition at line 54 of file RootDataConnection.h.

Member Typedef Documentation

StringVec

typedef std::vector<std::string> Gaudi::RootConnectionSetup::StringVec

Type definition for string maps.

Definition at line 63 of file RootDataConnection.h.

Constructor & Destructor Documentation

RootConnectionSetup()

Gaudi::RootConnectionSetup::RootConnectionSetup ( )

default

Standard constructor.

Member Function Documentation

compression()

int RootConnectionSetup::compression ( )

static

Access to global compression level.

Global compression level.

Definition at line 166 of file RootDataConnection.cpp.

{ return s_compressionLevel; }

incidentSvc()

IIncidentSvc * Gaudi::RootConnectionSetup::incidentSvc ( ) const

inline

Retrieve incident service.

Definition at line 101 of file RootDataConnection.h.

{ return m_incidentSvc.get(); }

msgSvc()

MsgStream & Gaudi::RootConnectionSetup::msgSvc ( ) const

inline

Retrieve message service.

Definition at line 96 of file RootDataConnection.h.

{ return *m_msgSvc; }

setCompression()

StatusCode RootConnectionSetup::setCompression ( std::string_view compression )

static

Set the global compression level.

Definition at line 126 of file RootDataConnection.cpp.

                                                                           {
#if ROOT_VERSION_CODE >= ROOT_VERSION( 5, 33, 0 )
  int  res = 0, level = ROOT::CompressionSettings( ROOT::RCompressionSetting::EAlgorithm::kLZMA, 6 );
  auto idx = compression.find( ':' );
  if ( idx != string::npos ) {
    auto                                           alg      = compression.substr( 0, idx );
    ROOT::RCompressionSetting::EAlgorithm::EValues alg_code = ROOT::RCompressionSetting::EAlgorithm::kUseGlobal;
    if ( alg.size() == 4 && strncasecmp( alg.data(), "ZLIB", 4 ) == 0 )
      alg_code = ROOT::RCompressionSetting::EAlgorithm::kZLIB;
    else if ( alg.size() == 4 && strncasecmp( alg.data(), "LZMA", 4 ) == 0 )
      alg_code = ROOT::RCompressionSetting::EAlgorithm::kLZMA;
    else if ( alg.size() == 3 && strncasecmp( alg.data(), "LZ4", 3 ) == 0 )
      alg_code = ROOT::RCompressionSetting::EAlgorithm::kLZ4;
#  if ROOT_VERSION_CODE >= ROOT_VERSION( 6, 20, 0 )
    else if ( alg.size() == 4 && strncasecmp( alg.data(), "ZSTD", 4 ) == 0 )
      alg_code = ROOT::RCompressionSetting::EAlgorithm::kZSTD;
#  endif
    else
      throw runtime_error( "ERROR: request to set unknown ROOT compression algorithm:" + std::string{ alg } );
    res = ::sscanf( std::string{ compression.substr( idx + 1 ) }.c_str(), "%d",
                    &level ); // TODO: use C++17 std::from_chars instead...
    if ( res == 1 ) {
      s_compressionLevel = ROOT::CompressionSettings( alg_code, level );
      return StatusCode::SUCCESS;
    }
    throw runtime_error( "ERROR: request to set unknown ROOT compression level:" +
                         std::string{ compression.substr( idx + 1 ) } );
  } else if ( 1 == ::sscanf( std::string{ compression }.c_str(), "%d", &level ) ) { // TODO: use C++17 std::from_chars
                                                                                    // instead
    s_compressionLevel = level;
    return StatusCode::SUCCESS;
  }
  throw runtime_error( "ERROR: request to set unknown ROOT compression mechanism:" + std::string{ compression } );
#else
  if ( !compression.empty() ) {}
  return StatusCode::SUCCESS;
#endif
}

setIncidentSvc()

void RootConnectionSetup::setIncidentSvc

(

IIncidentSvc *

m

)

Set incident service reference.

Definition at line 172 of file RootDataConnection.cpp.

{ m_incidentSvc.reset( s ); }

setMessageSvc()

void RootConnectionSetup::setMessageSvc

(

MsgStream *

m

)

Set message service reference.

Definition at line 169 of file RootDataConnection.cpp.

{ m_msgSvc.reset( m ); }

Member Data Documentation

cacheBranches

StringVec Gaudi::RootConnectionSetup::cacheBranches

Vector of strings with branches to be cached for input files.

Definition at line 66 of file RootDataConnection.h.

cacheSize

int Gaudi::RootConnectionSetup::cacheSize { 0 }

RootCnvSvc Property: Root data cache size.

Definition at line 72 of file RootDataConnection.h.

{ 0 };

learnEntries

int Gaudi::RootConnectionSetup::learnEntries { 0 }

RootCnvSvc Property: ROOT cache learn entries.

Definition at line 74 of file RootDataConnection.h.

{ 0 };

loadSection

std::string Gaudi::RootConnectionSetup::loadSection

RootCnvSvc Property: Root data cache size.

Definition at line 70 of file RootDataConnection.h.

m_incidentSvc

SmartIF<IIncidentSvc> Gaudi::RootConnectionSetup::m_incidentSvc = nullptr

private

Reference to incident service.

Definition at line 59 of file RootDataConnection.h.

m_msgSvc

std::unique_ptr<MsgStream> Gaudi::RootConnectionSetup::m_msgSvc

private

Reference to message service.

Definition at line 57 of file RootDataConnection.h.

produceReproducibleFiles

Gaudi::Property<bool> Gaudi::RootConnectionSetup::produceReproducibleFiles

Initial value:

{ "ProduceReproducibleFiles", true,
                                                    "configure output files to be more reproducible" }

Definition at line 76 of file RootDataConnection.h.

                                                { "ProduceReproducibleFiles", true,
                                                    "configure output files to be more reproducible" };

root630ForwardCompatibility

Gaudi::Property<bool> Gaudi::RootConnectionSetup::root630ForwardCompatibility

Initial value:

{
        "ROOT630ForwardCompatibility", false,
        "When opening a file for CREATE or RECREATE, enable ROOT 6.30 forward compatibility "
        "(i.e. write a file that is readable with ROOT 6.24). Requires ROOT >= 6.30.06, see "
        "<https://github.com/root-project/root/issues/14793>." }

Definition at line 79 of file RootDataConnection.h.

                                                   {
        "ROOT630ForwardCompatibility", false,
        "When opening a file for CREATE or RECREATE, enable ROOT 6.30 forward compatibility "
        "(i.e. write a file that is readable with ROOT 6.24). Requires ROOT >= 6.30.06, see "
        "<https://github.com/root-project/root/issues/14793>." };

vetoBranches

StringVec Gaudi::RootConnectionSetup::vetoBranches

Vector of strings with branches to NOT be cached for input files.

Definition at line 68 of file RootDataConnection.h.

---

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

• RootCnv/include/RootCnv/RootDataConnection.h
• RootCnv/src/RootDataConnection.cpp