ROOT::Experimental::RKeyInfo Class Reference

Information about an RFile object's Key.

Every object inside a ROOT file has an associated "Key" which contains metadata on the object, such as its name, type etc. Querying this information can be done via RFile::ListKeys(). Reading an object's Key doesn't deserialize the full object, so it's a relatively lightweight operation.

Definition at line 70 of file RFile.hxx.

Public Types
enum class	ECategory : std::uint16_t { kInvalid , kObject , kDirectory }

Public Member Functions
	RKeyInfo ()=default
std::string	GetBaseName () const
	Returns the base name of this key, i.e. the name of the object without the directory part.
ECategory	GetCategory () const
const std::string &	GetClassName () const
std::uint16_t	GetCycle () const
std::uint64_t	GetLenObj () const
	Returns the in-memory size of the uncompressed object.
std::uint64_t	GetNBytesKey () const
	Returns the on-disk size of this object's key.
std::uint64_t	GetNBytesObj () const
	Returns the on-disk size of the (potentially compressed) object, excluding its key.
const std::string &	GetPath () const
	Returns the absolute path of this key, i.e. the directory part plus the object name.
std::uint64_t	GetSeekKey () const
	Returns the on-disk offset of this object's key.
std::uint64_t	GetSeekParentDir () const
	Returns the on-disk offset of this object's parent directory key.
const std::string &	GetTitle () const

Private Member Functions
	RKeyInfo (const TKey &key)

Private Attributes
ECategory	fCategory = ECategory::kInvalid
std::string	fClassName
std::uint16_t	fCycle = 0
std::uint64_t	fLenObj = 0
std::uint64_t	fNBytesKey = 0
std::uint64_t	fNBytesObj = 0
std::string	fPath
std::uint64_t	fSeekKey = 0
std::uint64_t	fSeekParentDir = 0
std::string	fTitle

Friends
class	ROOT::Experimental::RFile
class	ROOT::Experimental::RFileKeyIterable

#include <ROOT/RFile.hxx>

Member Enumeration Documentation

ECategory

enum class ROOT::Experimental::RKeyInfo::ECategory : std::uint16_t

strong

Enumerator
kInvalid
kObject
kDirectory

Definition at line 75 of file RFile.hxx.

Constructor & Destructor Documentation

RKeyInfo() [1/2]

ROOT::Experimental::RKeyInfo::RKeyInfo ( const TKey & key )

explicitprivate

Definition at line 545 of file RFile.cxx.

RKeyInfo() [2/2]

ROOT::Experimental::RKeyInfo::RKeyInfo ( )

default

Member Function Documentation

GetBaseName()

std::string ROOT::Experimental::RKeyInfo::GetBaseName ( ) const

inline

Returns the base name of this key, i.e. the name of the object without the directory part.

Definition at line 101 of file RFile.hxx.

GetCategory()

ECategory ROOT::Experimental::RKeyInfo::GetCategory ( ) const

inline

Definition at line 105 of file RFile.hxx.

GetClassName()

const std::string & ROOT::Experimental::RKeyInfo::GetClassName ( ) const

inline

Definition at line 103 of file RFile.hxx.

GetCycle()

std::uint16_t ROOT::Experimental::RKeyInfo::GetCycle ( ) const

inline

Definition at line 104 of file RFile.hxx.

GetLenObj()

std::uint64_t ROOT::Experimental::RKeyInfo::GetLenObj ( ) const

inline

Returns the in-memory size of the uncompressed object.

Definition at line 108 of file RFile.hxx.

GetNBytesKey()

std::uint64_t ROOT::Experimental::RKeyInfo::GetNBytesKey ( ) const

inline

Returns the on-disk size of this object's key.

Definition at line 113 of file RFile.hxx.

GetNBytesObj()

std::uint64_t ROOT::Experimental::RKeyInfo::GetNBytesObj ( ) const

inline

Returns the on-disk size of the (potentially compressed) object, excluding its key.

Definition at line 110 of file RFile.hxx.

GetPath()

const std::string & ROOT::Experimental::RKeyInfo::GetPath ( ) const

inline

Returns the absolute path of this key, i.e. the directory part plus the object name.

Definition at line 99 of file RFile.hxx.

GetSeekKey()

std::uint64_t ROOT::Experimental::RKeyInfo::GetSeekKey ( ) const

inline

Returns the on-disk offset of this object's key.

Definition at line 115 of file RFile.hxx.

GetSeekParentDir()

std::uint64_t ROOT::Experimental::RKeyInfo::GetSeekParentDir ( ) const

inline

Returns the on-disk offset of this object's parent directory key.

Definition at line 118 of file RFile.hxx.

GetTitle()

const std::string & ROOT::Experimental::RKeyInfo::GetTitle ( ) const

inline

Definition at line 102 of file RFile.hxx.

Friends And Related Symbol Documentation

ROOT::Experimental::RFile

friend class ROOT::Experimental::RFile

friend

Definition at line 71 of file RFile.hxx.

ROOT::Experimental::RFileKeyIterable

friend class ROOT::Experimental::RFileKeyIterable

friend

Definition at line 72 of file RFile.hxx.

Member Data Documentation

fCategory

ECategory ROOT::Experimental::RKeyInfo::fCategory = ECategory::kInvalid

private

Definition at line 86 of file RFile.hxx.

fClassName

std::string ROOT::Experimental::RKeyInfo::fClassName

private

Definition at line 84 of file RFile.hxx.

fCycle

std::uint16_t ROOT::Experimental::RKeyInfo::fCycle = 0

private

Definition at line 85 of file RFile.hxx.

fLenObj

std::uint64_t ROOT::Experimental::RKeyInfo::fLenObj = 0

private

Definition at line 87 of file RFile.hxx.

fNBytesKey

std::uint64_t ROOT::Experimental::RKeyInfo::fNBytesKey = 0

private

Definition at line 89 of file RFile.hxx.

fNBytesObj

std::uint64_t ROOT::Experimental::RKeyInfo::fNBytesObj = 0

private

Definition at line 88 of file RFile.hxx.

fPath

std::string ROOT::Experimental::RKeyInfo::fPath

private

Definition at line 82 of file RFile.hxx.

fSeekKey

std::uint64_t ROOT::Experimental::RKeyInfo::fSeekKey = 0

private

Definition at line 90 of file RFile.hxx.

fSeekParentDir

std::uint64_t ROOT::Experimental::RKeyInfo::fSeekParentDir = 0

private

Definition at line 91 of file RFile.hxx.

fTitle

std::string ROOT::Experimental::RKeyInfo::fTitle

private

Definition at line 83 of file RFile.hxx.

Libraries for ROOT::Experimental::RKeyInfo:

---

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

• io/io/inc/ROOT/RFile.hxx
• io/io/src/RFile.cxx