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 67 of file RFile.hxx.

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

Public Member Functions
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
const std::string &	GetPath () const
	Returns the absolute path of this key, i.e. the directory part plus the object name.
const std::string &	GetTitle () const

Private Attributes
ECategory	fCategory = ECategory::kInvalid
std::string	fClassName
std::uint16_t	fCycle = 0
std::string	fPath
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 72 of file RFile.hxx.

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 89 of file RFile.hxx.

GetCategory()

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

inline

Definition at line 93 of file RFile.hxx.

GetClassName()

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

inline

Definition at line 91 of file RFile.hxx.

GetCycle()

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

inline

Definition at line 92 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 87 of file RFile.hxx.

GetTitle()

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

inline

Definition at line 90 of file RFile.hxx.

Friends And Related Symbol Documentation

ROOT::Experimental::RFile

friend class ROOT::Experimental::RFile

friend

Definition at line 68 of file RFile.hxx.

ROOT::Experimental::RFileKeyIterable

friend class ROOT::Experimental::RFileKeyIterable

friend

Definition at line 69 of file RFile.hxx.

Member Data Documentation

fCategory

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

private

Definition at line 83 of file RFile.hxx.

fClassName

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

private

Definition at line 81 of file RFile.hxx.

fCycle

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

private

Definition at line 82 of file RFile.hxx.

fPath

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

private

Definition at line 79 of file RFile.hxx.

fTitle

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

private

Definition at line 80 of file RFile.hxx.

Libraries for ROOT::Experimental::RKeyInfo:

---

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

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