Template specializations for ROOT's RVec.

The type-erased field for a RVec<Type>

Definition at line 114 of file RFieldSequenceContainer.hxx.

Classes
class	RRVecDeleter

Public Member Functions
	RRVecField (const RRVecField &)=delete

	RRVecField (RRVecField &&)=default

	RRVecField (std::string_view fieldName, std::unique_ptr< RFieldBase > itemField)

	~RRVecField () override=default

void	AcceptVisitor (ROOT::Detail::RFieldVisitor &visitor) const final

size_t	GetAlignment () const final
	As a rule of thumb, the alignment is equal to the size of the type.

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

RRVecField &	operator= (RRVecField &&)=default

RRVecField &	operator= (RRVecField &)=delete

std::vector< RValue >	SplitValue (const RValue &value) const final
	Creates the list of direct child values given an existing value for this field.

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

	RFieldBase (RFieldBase &&)=default

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

virtual	~RFieldBase ()=default

RSchemaIterator	begin ()

RConstSchemaIterator	begin () const

RValue	BindValue (std::shared_ptr< void > objPtr)
	Creates a value from a memory location with an already constructed object.

RConstSchemaIterator	cbegin () const

RConstSchemaIterator	cend () const

std::unique_ptr< RFieldBase >	Clone (std::string_view newName) const
	Copies the field and its subfields using a possibly new name and a new, unconnected set of columns.

RBulkValues	CreateBulk ()
	Creates a new, initially empty bulk.

template<>
std::unique_ptr< void, typename RFieldBase::RCreateObjectDeleter< void >::deleter >	CreateObject () const

template<typename T >
std::unique_ptr< T, typename RCreateObjectDeleter< T >::deleter >	CreateObject () const
	Generates an object of the field type and allocates new initialized memory according to the type.

template<>
std::unique_ptr< void, typename ROOT::RFieldBase::RCreateObjectDeleter< void >::deleter >	CreateObject () const

RValue	CreateValue ()
	Generates an object of the field's type, wraps it in a shared pointer and returns it as an RValue connected to the field.

RSchemaIterator	end ()

RConstSchemaIterator	end () const

RColumnRepresentations::Selection_t	GetColumnRepresentatives () const
	Returns the `fColumnRepresentative` pointee or, if unset (always the case for artificial fields), the field's default representative.

std::vector< const RFieldBase * >	GetConstSubfields () const

const std::string &	GetDescription () const
	Get the field's description.

const std::string &	GetFieldName () const

virtual std::uint32_t	GetFieldVersion () const
	Indicates an evolution of the mapping scheme from C++ type to columns.

std::vector< RFieldBase * >	GetMutableSubfields ()

std::size_t	GetNRepetitions () const

ROOT::DescriptorId_t	GetOnDiskId () const

std::uint32_t	GetOnDiskTypeChecksum () const
	Return checksum stored in the field descriptor; only valid after a call to ConnectPageSource(), if the field stored a type checksum.

std::uint32_t	GetOnDiskTypeVersion () const
	Return the C++ type version stored in the field descriptor; only valid after a call to ConnectPageSource()

const RFieldBase *	GetParent () const

std::string	GetQualifiedFieldName () const
	Returns the field name and parent field names separated by dots (`grandparent.parent.child`)

EState	GetState () const

ROOT::ENTupleStructure	GetStructure () const

std::uint32_t	GetTraits () const

const std::string &	GetTypeAlias () const

virtual std::uint32_t	GetTypeChecksum () const
	Return the current TClass reported checksum of this class. Only valid if `kTraitTypeChecksum` is set.

const std::string &	GetTypeName () const

virtual std::uint32_t	GetTypeVersion () const
	Indicates an evolution of the C++ type itself.

bool	HasDefaultColumnRepresentative () const
	Whether or not an explicit column representative was set.

bool	HasReadCallbacks () const

bool	IsArtificial () const

bool	IsSimple () const

RFieldBase &	operator= (const RFieldBase &)=delete

RFieldBase &	operator= (RFieldBase &&)=default

void	SetColumnRepresentatives (const RColumnRepresentations::Selection_t &representatives)
	Fixes a column representative.

void	SetDescription (std::string_view description)

void	SetOnDiskId (ROOT::DescriptorId_t id)

Protected Member Functions
std::size_t	AppendImpl (const void *from) final
	Operations on values of complex types, e.g.

std::unique_ptr< RFieldBase >	BeforeConnectPageSource (ROOT::Internal::RPageSource &pageSource) final
	Called by ConnectPageSource() before connecting; derived classes may override this as appropriate, e.g.

std::unique_ptr< RFieldBase >	CloneImpl (std::string_view newName) const final
	Called by Clone(), which additionally copies the on-disk ID.

void	CommitClusterImpl () final

void	ConstructValue (void *where) const final
	Constructs value in a given location of size at least GetValueSize(). Called by the base class' CreateValue().

void	GenerateColumns () final
	Implementations in derived classes should create the backing columns corresponding to the field type for writing.

void	GenerateColumns (const ROOT::RNTupleDescriptor &desc) final
	Implementations in derived classes should create the backing columns corresponding to the field type for reading.

const RColumnRepresentations &	GetColumnRepresentations () const final
	Implementations in derived classes should return a static RColumnRepresentations object.

std::unique_ptr< RDeleter >	GetDeleter () const final

std::size_t	ReadBulkImpl (const RBulkSpec &bulkSpec) final
	General implementation of bulk read.

void	ReadGlobalImpl (ROOT::NTupleSize_t globalIndex, void *to) final

void	ReconcileOnDiskField (const RNTupleDescriptor &desc) final
	For non-artificial fields, check compatibility of the in-memory field and the on-disk field.

Protected Member Functions inherited from ROOT::RFieldBase
size_t	AddReadCallback (ReadCallback_t func)
	Set a user-defined function to be called after reading a value, giving a chance to inspect and/or modify the value object.

std::size_t	Append (const void *from)
	Write the given value into columns.

void	Attach (std::unique_ptr< RFieldBase > child)
	Add a new subfield to the list of nested fields.

void	AutoAdjustColumnTypes (const ROOT::RNTupleWriteOptions &options)
	When connecting a field to a page sink, the field's default column representation is subject to adjustment according to the write options.

std::uint32_t	CompareOnDiskField (const RFieldDescriptor &fieldDesc, std::uint32_t ignoreBits) const
	Returns a combination of kDiff... flags, indicating peroperties that are different between the field at hand and the given on-disk field.

void *	CreateObjectRawPtr () const
	Factory method for the field's type. The caller owns the returned pointer.

const ColumnRepresentation_t &	EnsureCompatibleColumnTypes (const ROOT::RNTupleDescriptor &desc, std::uint16_t representationIndex) const
	Returns the on-disk column types found in the provided descriptor for `fOnDiskId` and the given representation index.

RResult< void >	EnsureMatchingOnDiskField (const RFieldDescriptor &fieldDesc, std::uint32_t ignoreBits=0) const
	Compares the field to the provieded on-disk field descriptor.

RResult< void >	EnsureMatchingTypePrefix (const RFieldDescriptor &fieldDesc, const std::vector< std::string > &prefixes) const
	Many fields accept a range of type prefixes for schema evolution, e.g.

template<typename... ColumnCppTs>
void	GenerateColumnsImpl ()
	For writing, use the currently set column representative.

template<std::uint32_t ColumnIndexT, typename HeadT , typename... TailTs>
void	GenerateColumnsImpl (const ColumnRepresentation_t &representation, std::uint16_t representationIndex)
	Helpers for generating columns.

template<typename... ColumnCppTs>
void	GenerateColumnsImpl (const ROOT::RNTupleDescriptor &desc)
	For reading, use the on-disk column list.

virtual ROOT::RExtraTypeInfoDescriptor	GetExtraTypeInfo () const

virtual bool	HasExtraTypeInfo () const

void	Read (RNTupleLocalIndex localIndex, void *to)
	Populate a single value with data from the field.

void	Read (ROOT::NTupleSize_t globalIndex, void *to)
	Populate a single value with data from the field.

std::size_t	ReadBulk (const RBulkSpec &bulkSpec)
	Returns the number of newly available values, that is the number of bools in `bulkSpec.fMaskAvail` that flipped from false to true.

virtual void	ReadInClusterImpl (RNTupleLocalIndex localIndex, void *to)

void	RemoveReadCallback (size_t idx)

Protected Attributes
std::size_t	fBulkNRepetition = 1

RFieldBase *	fBulkSubfield = nullptr
	May be a direct PoD subfield or a sub-subfield of a fixed-size array of PoD.

std::size_t	fItemSize

ROOT::Internal::RColumnIndex	fNWritten

std::size_t	fValueSize

Protected Attributes inherited from ROOT::RFieldBase
ROOT::Internal::RColumn *	fAuxiliaryColumn = nullptr
	Some fields have a second column in its column representation.

std::vector< std::unique_ptr< ROOT::Internal::RColumn > >	fAvailableColumns
	The columns are connected either to a sink or to a source (not to both); they are owned by the field.

std::vector< std::reference_wrapper< const ColumnRepresentation_t > >	fColumnRepresentatives
	Pointers into the static vector returned by RColumnRepresentations::GetSerializationTypes() when SetColumnRepresentatives() is called.

std::uint32_t	fOnDiskTypeChecksum = 0
	TClass checksum cached from the descriptor after a call to ConnectPageSource().

std::uint32_t	fOnDiskTypeVersion = kInvalidTypeVersion
	C++ type version cached from the descriptor after a call to ConnectPageSource()

RFieldBase *	fParent
	Subfields point to their mother field.

ROOT::Internal::RColumn *	fPrincipalColumn = nullptr
	All fields that have columns have a distinct main column.

std::vector< ReadCallback_t >	fReadCallbacks
	List of functions to be called after reading a value.

std::vector< std::unique_ptr< RFieldBase > >	fSubfields
	Collections and classes own subfields.

std::uint32_t	fTraits = 0
	Properties of the type that allow for optimizations of collections of that type.

std::string	fTypeAlias
	A typedef or using name that was used when creating the field.

Static Private Member Functions
static unsigned char *	ResizeRVec (void rvec, std::size_t nItems, std::size_t itemSize, const RFieldBase itemField, RDeleter *itemDeleter)

Private Attributes
std::unique_ptr< RDeleter >	fItemDeleter

Friends
class	RArrayAsRVecField

Additional Inherited Members
Public Types inherited from ROOT::RFieldBase
enum	{ kTraitTriviallyConstructible = 0x01 , kTraitTriviallyDestructible = 0x02 , kTraitMappable = 0x04 , kTraitTypeChecksum = 0x08 , kTraitInvalidField = 0x10 , kTraitEmulatedField = 0x20 , kTraitTrivialType = kTraitTriviallyConstructible \| kTraitTriviallyDestructible }

using	ColumnRepresentation_t = std::vector<ROOT::ENTupleColumnType>

enum class	EState { kUnconnected , kConnectedToSink , kConnectedToSource }
	During its lifetime, a field undergoes the following possible state transitions: More...

using	RConstSchemaIterator = RSchemaIteratorTemplate<true>

using	RSchemaIterator = RSchemaIteratorTemplate<false>

Static Public Member Functions inherited from ROOT::RFieldBase
static std::vector< RCheckResult >	Check (const std::string &fieldName, const std::string &typeName)
	Checks if the given type is supported by RNTuple.

static RResult< std::unique_ptr< RFieldBase > >	Create (const std::string &fieldName, const std::string &typeName)
	Factory method to create a field from a certain type given as string.

Static Public Attributes inherited from ROOT::RFieldBase
static constexpr std::uint32_t	kInvalidTypeVersion = -1U

Protected Types inherited from ROOT::RFieldBase
enum	{ kDiffFieldVersion = 0x01 , kDiffTypeVersion = 0x02 , kDiffStructure = 0x04 , kDiffTypeName = 0x08 , kDiffNRepetitions = 0x10 }
	Bits used in CompareOnDisk() More...

Static Protected Member Functions inherited from ROOT::RFieldBase
static std::size_t	CallAppendOn (RFieldBase &other, const void *from)
	Allow derived classes to call Append() and Read() on other (sub)fields.

static void	CallConstructValueOn (const RFieldBase &other, void *where)
	Allow derived classes to call ConstructValue(void *) and GetDeleter() on other (sub)fields.

static void *	CallCreateObjectRawPtrOn (RFieldBase &other)

static void	CallReadOn (RFieldBase &other, RNTupleLocalIndex localIndex, void *to)

static void	CallReadOn (RFieldBase &other, ROOT::NTupleSize_t globalIndex, void *to)

static void	CallSetArtificialOn (RFieldBase &other)
	Allow parents to mark their childs as artificial fields (used in class and record fields)

static RResult< std::unique_ptr< RFieldBase > >	Create (const std::string &fieldName, const std::string &typeName, const ROOT::RCreateFieldOptions &options, const ROOT::RNTupleDescriptor *desc, ROOT::DescriptorId_t fieldId)
	Factory method to resurrect a field from the stored on-disk type information.

static std::unique_ptr< RDeleter >	GetDeleterOf (const RFieldBase &other)

static ROOT::Internal::RColumn *	GetPrincipalColumnOf (const RFieldBase &other)
	Fields may need direct access to the principal column of their subfields, e.g. in RRVecField::ReadBulk()

static void	SetTypeAliasOf (RFieldBase &other, const std::string &alias)
	Allow class fields to adjust the type alias of their members.

#include <ROOT/RField/RFieldSequenceContainer.hxx>

Inheritance diagram for ROOT::RRVecField:

[legend]

Constructor & Destructor Documentation

◆ RRVecField() [1/3]

ROOT::RRVecField::RRVecField	(	std::string_view	fieldName,
		std::unique_ptr< RFieldBase >	itemField )

Definition at line 226 of file RFieldSequenceContainer.cxx.

◆ RRVecField() [2/3]

ROOT::RRVecField::RRVecField ( RRVecField && )

default

◆ RRVecField() [3/3]

ROOT::RRVecField::RRVecField ( const RRVecField & )

delete

◆ ~RRVecField()

ROOT::RRVecField::~RRVecField ( )

overridedefault

Member Function Documentation

◆ AcceptVisitor()

void ROOT::RRVecField::AcceptVisitor ( ROOT::Detail::RFieldVisitor & visitor ) const

finalvirtual

Reimplemented from ROOT::RFieldBase.

Definition at line 521 of file RFieldSequenceContainer.cxx.

◆ AppendImpl()

std::size_t ROOT::RRVecField::AppendImpl ( const void * from )

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::RFieldBase.

Definition at line 257 of file RFieldSequenceContainer.cxx.

◆ BeforeConnectPageSource()

std::unique_ptr< ROOT::RFieldBase > ROOT::RRVecField::BeforeConnectPageSource ( ROOT::Internal::RPageSource & )

finalprotectedvirtual

Called by ConnectPageSource() before connecting; derived classes may override this as appropriate, e.g.

for the application of I/O rules. In the process, the field at hand or its subfields may be marked as "artifical", i.e. introduced by schema evolution and not backed by on-disk information. May return a field substitute that fits the on-disk schema as a replacement for the field at hand. A field substitute must read into the same in-memory layout than the original field and field substitutions must not be cyclic.

Reimplemented from ROOT::RFieldBase.

Definition at line 447 of file RFieldSequenceContainer.cxx.

◆ CloneImpl()

std::unique_ptr< ROOT::RFieldBase > ROOT::RRVecField::CloneImpl ( std::string_view newName ) const

finalprotectedvirtual

Called by Clone(), which additionally copies the on-disk ID.

Implements ROOT::RFieldBase.

Definition at line 251 of file RFieldSequenceContainer.cxx.

◆ CommitClusterImpl()

void ROOT::RRVecField::CommitClusterImpl ( )

inlinefinalprotectedvirtual

Reimplemented from ROOT::RFieldBase.

Definition at line 164 of file RFieldSequenceContainer.hxx.

◆ ConstructValue()

void ROOT::RRVecField::ConstructValue ( void * where ) const

finalprotectedvirtual

Constructs value in a given location of size at least GetValueSize(). Called by the base class' CreateValue().

Implements ROOT::RFieldBase.

Definition at line 468 of file RFieldSequenceContainer.cxx.

◆ GenerateColumns() [1/2]

void ROOT::RRVecField::GenerateColumns ( )

finalprotectedvirtual

Implementations in derived classes should create the backing columns corresponding to the field type for writing.

The default implementation does not attach any columns to the field.

Reimplemented from ROOT::RFieldBase.

Definition at line 437 of file RFieldSequenceContainer.cxx.

◆ GenerateColumns() [2/2]

void ROOT::RRVecField::GenerateColumns ( const ROOT::RNTupleDescriptor & )

finalprotectedvirtual

Implementations in derived classes should create the backing columns corresponding to the field type for reading.

The default implementation does not attach any columns to the field. The method should check, using the page source and fOnDiskId, if the column types match and throw if they don't.

Reimplemented from ROOT::RFieldBase.

Definition at line 442 of file RFieldSequenceContainer.cxx.

◆ GetAlignment()

size_t ROOT::RRVecField::GetAlignment ( ) const

finalvirtual

As a rule of thumb, the alignment is equal to the size of the type.

There are, however, various exceptions to this rule depending on OS and CPU architecture. So enforce the alignment to be explicitly spelled out.

Implements ROOT::RFieldBase.

Definition at line 516 of file RFieldSequenceContainer.cxx.

◆ GetColumnRepresentations()

const ROOT::RFieldBase::RColumnRepresentations & ROOT::RRVecField::GetColumnRepresentations ( ) const

finalprotectedvirtual

Implementations in derived classes should return a static RColumnRepresentations object.

The default implementation does not attach any columns to the field.

Reimplemented from ROOT::RFieldBase.

Definition at line 427 of file RFieldSequenceContainer.cxx.

◆ GetDeleter()

std::unique_ptr< ROOT::RFieldBase::RDeleter > ROOT::RRVecField::GetDeleter ( ) const

finalprotectedvirtual

Reimplemented from ROOT::RFieldBase.

Definition at line 491 of file RFieldSequenceContainer.cxx.

◆ GetValueSize()

size_t ROOT::RRVecField::GetValueSize ( ) const

finalvirtual

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

Implements ROOT::RFieldBase.

Definition at line 511 of file RFieldSequenceContainer.cxx.

◆ operator=() [1/2]

RRVecField & ROOT::RRVecField::operator= ( RRVecField && )

default

◆ operator=() [2/2]

RRVecField & ROOT::RRVecField::operator= ( RRVecField & )

delete

◆ ReadBulkImpl()

std::size_t ROOT::RRVecField::ReadBulkImpl ( const RBulkSpec & bulkSpec )

finalprotectedvirtual

General implementation of bulk read.

Loop over the required range and read values that are required and not already present. Derived classes may implement more optimized versions of this method. See ReadBulk() for the return value.

Reimplemented from ROOT::RFieldBase.

Definition at line 361 of file RFieldSequenceContainer.cxx.

◆ ReadGlobalImpl()

void ROOT::RRVecField::ReadGlobalImpl	(	ROOT::NTupleSize_t	globalIndex,
		void *	to )

finalprotectedvirtual

Reimplemented from ROOT::RFieldBase.

Definition at line 338 of file RFieldSequenceContainer.cxx.

◆ ReconcileOnDiskField()

void ROOT::RRVecField::ReconcileOnDiskField ( const RNTupleDescriptor & desc )

finalprotectedvirtual

For non-artificial fields, check compatibility of the in-memory field and the on-disk field.

In the process, the field at hand may change its on-disk ID or perform other tasks related to automatic schema evolution. If the on-disk field is incompatible with the in-memory field at hand, an exception is thrown.

Reimplemented from ROOT::RFieldBase.

Definition at line 463 of file RFieldSequenceContainer.cxx.

◆ ResizeRVec()

unsigned char * ROOT::RRVecField::ResizeRVec	(	void *	rvec,
		std::size_t	nItems,
		std::size_t	itemSize,
		const RFieldBase *	itemField,
		RDeleter *	itemDeleter )

staticprivate

Definition at line 276 of file RFieldSequenceContainer.cxx.

◆ SplitValue()

std::vector< ROOT::RFieldBase::RValue > ROOT::RRVecField::SplitValue ( const RValue & value ) const

finalvirtual

Creates the list of direct child values given an existing value for this field.

E.g. a single value for the correct std::variant or all the elements of a collection. The default implementation assumes no subvalues and returns an empty vector.

Reimplemented from ROOT::RFieldBase.

Definition at line 498 of file RFieldSequenceContainer.cxx.