The field for a class with dictionary.

Definition at line 242 of file RField.hxx.

Public Member Functions
	RFieldClass (RFieldClass &&other)=default

	RFieldClass (std::string_view fieldName, std::string_view className)

	~RFieldClass ()=default

Detail::RFieldValue	CaptureValue (void *where) final
	Creates a value from a memory location with an already constructed object. More...

RFieldBase *	Clone (std::string_view newName) final

void	DestroyValue (const Detail::RFieldValue &value, bool dtorOnly=false) final
	Releases the resources acquired during GenerateValue (memory and constructor) This implementation works for simple types but needs to be overwritten for complex ones. More...

void	DoGenerateColumns () final
	Creates the backing columns corresponsing to the field type and name. More...

Detail::RFieldValue	GenerateValue (void *where) override
	Generates a tree value in a given location of size at least GetValueSize(). More...

unsigned int	GetNColumns () const final
	Returns the number of columns generated to store data for the field; defaults to 1. More...

size_t	GetValueSize () const override
	The number of bytes taken by a value of the appropriate type. More...

RFieldClass &	operator= (RFieldClass &&other)=default

Public Member Functions inherited from ROOT::Experimental::Detail::RFieldBase
	RFieldBase (const RFieldBase &)=delete

	RFieldBase (RFieldBase &&)=default

	RFieldBase (std::string_view name, std::string_view type, ENTupleStructure structure, bool isSimple)
	The constructor creates the underlying column objects and connects them to either a sink or a source. More...

virtual	~RFieldBase ()

void	Append (const RFieldValue &value)
	Write the given value into columns. The value object has to be of the same type as the field. More...

void	Attach (std::unique_ptr< Detail::RFieldBase > child)

RIterator	begin ()

virtual RFieldValue	CaptureValue (void *where)=0
	Creates a value from a memory location with an already constructed object. More...

virtual RFieldBase *	Clone (std::string_view newName)=0

virtual void	CommitCluster ()
	Perform housekeeping tasks for global to cluster-local index translation. More...

void	ConnectColumns (Detail::RPageStorage *pageStorage)
	Registeres (or re-registers) the backing columns with the physical storage. More...

virtual void	DestroyValue (const RFieldValue &value, bool dtorOnly=false)
	Releases the resources acquired during GenerateValue (memory and constructor) This implementation works for simple types but needs to be overwritten for complex ones. More...

RIterator	end ()

void	Flush () const
	Ensure that all received items are written from page buffers to the storage. More...

RFieldValue	GenerateValue ()
	Generates a tree value of the field type and allocates new initialized memory according to the type. More...

virtual RFieldValue	GenerateValue (void *where)=0
	Generates a tree value in a given location of size at least GetValueSize(). More...

virtual RNTupleVersion	GetFieldVersion () const
	Indicates an evolution of the mapping scheme from C++ type to columns. More...

std::string	GetName () const

virtual unsigned int	GetNColumns () const =0
	Returns the number of columns generated to store data for the field; defaults to 1. More...

NTupleSize_t	GetNItems ()
	The number of elements in the principal column. For top level fields, the number of entries. More...

const RFieldBase *	GetParent () const

ENTupleStructure	GetStructure () const

std::string	GetType () const

virtual RNTupleVersion	GetTypeVersion () const
	Indicates an evolution of the C++ type itself. More...

virtual size_t	GetValueSize () const =0
	The number of bytes taken by a value of the appropriate type. More...

bool	IsSimple () const

RFieldBase &	operator= (const RFieldBase &)=delete

RFieldBase &	operator= (RFieldBase &&)=default

void	Read (NTupleSize_t index, RFieldValue *value)
	Populate a single value with data from the tree, which needs to be of the fitting type. More...

void	ReadV (NTupleSize_t index, NTupleSize_t count, void *dst)
	Type unsafe bulk read interface; dst must point to a vector of objects of the field type. More...

Protected Member Functions
void	DoAppend (const Detail::RFieldValue &value) final
	Operations on values of complex types, e.g. More...

void	DoRead (NTupleSize_t index, Detail::RFieldValue *value) final

Protected Member Functions inherited from ROOT::Experimental::Detail::RFieldBase
virtual void	DoAppend (const RFieldValue &value)
	Operations on values of complex types, e.g. More...

virtual void	DoGenerateColumns ()=0
	Creates the backing columns corresponsing to the field type and name. More...

virtual void	DoRead (NTupleSize_t index, RFieldValue *value)

virtual void	DoReadV (NTupleSize_t index, NTupleSize_t count, void *dst)

Private Attributes
TClass *	fClass

Additional Inherited Members
Static Public Member Functions inherited from ROOT::Experimental::Detail::RFieldBase
static RFieldBase *	Create (const std::string &fieldName, const std::string &typeName)
	Factory method to resurrect a field from the stored on-disk type information. More...

static std::string	GetCollectionName (const std::string &parentName)
	Get the name for an item sub field that is part of a collection, e.g. the float field of std::vector<float> More...

static std::string	GetLeafName (const std::string &fullName)
	Get the tail of the field name up to the last dot. More...

Static Public Attributes inherited from ROOT::Experimental::Detail::RFieldBase
static constexpr char	kCollectionSeparator = '/'
	Field names convey the level of subfields; sub fields (nested collections) are separated by a dot. More...

Protected Attributes inherited from ROOT::Experimental::Detail::RFieldBase
std::vector< std::unique_ptr< RColumn > >	fColumns
	The columns are connected either to a sink or to a source (not to both); they are owned by the field. More...

RFieldBase *	fParent
	Sub fields point to their mother field. More...

RColumn *	fPrincipalColumn
	All fields have a main column. For collection fields, the main column is the index field. Points into fColumns. More...

std::vector< std::unique_ptr< RFieldBase > >	fSubFields
	Collections and classes own sub fields. More...

#include <ROOT/RField.hxx>

Inheritance diagram for ROOT::Experimental::RFieldClass:

[legend]

Constructor & Destructor Documentation

◆ RFieldClass() [1/2]

ROOT::Experimental::RFieldClass::RFieldClass	(	std::string_view	fieldName,
		std::string_view	className
	)

Definition at line 327 of file RField.cxx.

◆ RFieldClass() [2/2]

ROOT::Experimental::RFieldClass::RFieldClass ( RFieldClass && other )

default

◆ ~RFieldClass()

ROOT::Experimental::RFieldClass::~RFieldClass ( )

default

Member Function Documentation

◆ CaptureValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RFieldClass::CaptureValue ( void * where )

finalvirtual

Creates a value from a memory location with an already constructed object.

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 389 of file RField.cxx.

◆ Clone()

ROOT::Experimental::Detail::RFieldBase * ROOT::Experimental::RFieldClass::Clone ( std::string_view newName )

finalvirtual

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 343 of file RField.cxx.

◆ DestroyValue()

void ROOT::Experimental::RFieldClass::DestroyValue	(	const Detail::RFieldValue &	value,
		bool	dtorOnly = `false`
	)

finalvirtual

Releases the resources acquired during GenerateValue (memory and constructor) This implementation works for simple types but needs to be overwritten for complex ones.

Reimplemented from ROOT::Experimental::Detail::RFieldBase.

Definition at line 382 of file RField.cxx.

◆ DoAppend()

void ROOT::Experimental::RFieldClass::DoAppend ( const Detail::RFieldValue & value )

finalprotectedvirtual

Operations on values of complex types, e.g.

ones that involve multiple columns or for which no direct column type exists.

Reimplemented from ROOT::Experimental::Detail::RFieldBase.

Definition at line 348 of file RField.cxx.

◆ DoGenerateColumns()

void ROOT::Experimental::RFieldClass::DoGenerateColumns ( )

finalvirtual

Creates the backing columns corresponsing to the field type and name.

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 368 of file RField.cxx.

◆ DoRead()

void ROOT::Experimental::RFieldClass::DoRead	(	NTupleSize_t	index,
		Detail::RFieldValue *	value
	)

finalprotectedvirtual

Reimplemented from ROOT::Experimental::Detail::RFieldBase.

Definition at line 358 of file RField.cxx.

◆ GenerateValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RFieldClass::GenerateValue ( void * where )

overridevirtual

Generates a tree value in a given location of size at least GetValueSize().

Assumes that where has been allocated by malloc().

Implements ROOT::Experimental::Detail::RFieldBase.

Reimplemented in ROOT::Experimental::RField< T, typename >.

Definition at line 377 of file RField.cxx.

◆ GetNColumns()

unsigned int ROOT::Experimental::RFieldClass::GetNColumns ( ) const

finalvirtual

Returns the number of columns generated to store data for the field; defaults to 1.

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 372 of file RField.cxx.

◆ GetValueSize()

size_t ROOT::Experimental::RFieldClass::GetValueSize ( ) const

overridevirtual

The number of bytes taken by a value of the appropriate type.

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 394 of file RField.cxx.

◆ operator=()

RFieldClass & ROOT::Experimental::RFieldClass::operator= ( RFieldClass && other )

default

Member Data Documentation

◆ fClass

TClass* ROOT::Experimental::RFieldClass::fClass

private

Definition at line 244 of file RField.hxx.

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

tree/ntuple/v7/inc/ROOT/RField.hxx
tree/ntuple/v7/src/RField.cxx

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RFieldClass() [1/2]

◆ RFieldClass() [2/2]

◆ ~RFieldClass()

Member Function Documentation

◆ CaptureValue()

◆ Clone()

◆ DestroyValue()

◆ DoAppend()

◆ DoGenerateColumns()

◆ DoRead()

◆ GenerateValue()

◆ GetNColumns()

◆ GetValueSize()

◆ operator=()

Member Data Documentation

◆ fClass