Logo ROOT  
Reference Guide
ROOT::Experimental::RRecordField Class Reference

The field for an untyped record.

The subfields are stored consequitively in a memory block, i.e. the memory layout is identical to one that a C++ struct would have

Definition at line 494 of file RField.hxx.

Public Member Functions

 RRecordField (RRecordField &&other)=default
 
 RRecordField (std::string_view fieldName, std::vector< std::unique_ptr< Detail::RFieldBase > > &&itemFields)
 Construct a RRecordField based on a vector of child fields. More...
 
 RRecordField (std::string_view fieldName, std::vector< std::unique_ptr< Detail::RFieldBase > > &itemFields)
 
 ~RRecordField () override=default
 
void AcceptVisitor (Detail::RFieldVisitor &visitor) const final
 
Detail::RFieldValue CaptureValue (void *where) final
 Creates a value from a memory location with an already constructed object. More...
 
void DestroyValue (const Detail::RFieldValue &value, bool dtorOnly=false) override
 Releases the resources acquired during GenerateValue (memory and constructor) This implementation works for simple types but needs to be overwritten for complex ones. More...
 
Detail::RFieldValue GenerateValue (void *where) override
 Generates a tree value in a given location of size at least GetValueSize(). More...
 
size_t GetAlignment () const final
 For many types, the alignment requirement is equal to the size; otherwise override. More...
 
size_t GetValueSize () const final
 The number of bytes taken by a value of the appropriate type. More...
 
RRecordFieldoperator= (RRecordField &&other)=default
 
std::vector< Detail::RFieldValueSplitValue (const Detail::RFieldValue &value) const final
 Creates the list of direct child values given a value for this field. More...
 
- 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, std::size_t nRepetitions=0)
 The constructor creates the underlying column objects and connects them to either a sink or a source. More...
 
virtual ~RFieldBase ()
 
virtual void AcceptVisitor (RFieldVisitor &visitor) const
 
std::size_t Append (const RFieldValue &value)
 Write the given value into columns. More...
 
void Attach (std::unique_ptr< Detail::RFieldBase > child)
 Add a new subfield to the list of nested fields. More...
 
RSchemaIterator begin ()
 
virtual RFieldValue CaptureValue (void *where)=0
 Creates a value from a memory location with an already constructed object. More...
 
std::unique_ptr< RFieldBaseClone (std::string_view newName) const
 Copies the field and its sub fields using a possibly new name and a new, unconnected set of columns. More...
 
virtual void CommitCluster ()
 Perform housekeeping tasks for global to cluster-local index translation. More...
 
void ConnectPageSink (RPageSink &pageSink)
 Fields and their columns live in the void until connected to a physical page storage. More...
 
void ConnectPageSource (RPageSource &pageSource)
 
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...
 
RSchemaIterator end ()
 
void Flush () const
 Ensure that all received items are written from page buffers to the storage. More...
 
RFieldValue GenerateValue ()
 Generates an object 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 size_t GetAlignment () const
 For many types, the alignment requirement is equal to the size; otherwise override. More...
 
const ColumnRepresentation_tGetColumnRepresentative () const
 Returns the fColumnRepresentative pointee or, if unset, the field's default representative. More...
 
std::string GetDescription () const
 Get the field's description. More...
 
virtual std::uint32_t GetFieldVersion () const
 Indicates an evolution of the mapping scheme from C++ type to columns. More...
 
std::string GetName () const
 
NTupleSize_t GetNElements () const
 
std::size_t GetNRepetitions () const
 
DescriptorId_t GetOnDiskId () const
 
std::uint32_t GetOnDiskTypeVersion () const
 Return the C++ type version stored in the field descriptor; only valid after a call to ConnectPageSource() More...
 
RFieldBaseGetParent () const
 
std::string GetQualifiedFieldName () const
 Returns the field name and parent field names separated by dots ("grandparent.parent.child") More...
 
ENTupleStructure GetStructure () const
 
std::vector< RFieldBase * > GetSubFields () const
 
int GetTraits () const
 
std::string GetType () const
 
virtual std::uint32_t 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 HasReadCallbacks () const
 
bool IsSimple () const
 
RFieldBaseoperator= (const RFieldBase &)=delete
 
RFieldBaseoperator= (RFieldBase &&)=default
 
void Read (const RClusterIndex &clusterIndex, RFieldValue *value)
 
void Read (NTupleSize_t globalIndex, RFieldValue *value)
 Populate a single value with data from the tree, which needs to be of the fitting type. More...
 
void SetColumnRepresentative (const ColumnRepresentation_t &representative)
 Fixes a column representative. More...
 
void SetDescription (std::string_view description)
 
void SetOnDiskId (DescriptorId_t id)
 
virtual std::vector< RFieldValueSplitValue (const RFieldValue &value) const
 Creates the list of direct child values given a value for this field. More...
 

Protected Member Functions

template<std::size_t N>
 RRecordField (std::string_view fieldName, std::array< std::unique_ptr< Detail::RFieldBase >, N > &&itemFields, const std::array< std::size_t, N > &offsets, std::string_view typeName="")
 
 RRecordField (std::string_view fieldName, std::vector< std::unique_ptr< Detail::RFieldBase > > &&itemFields, const std::vector< std::size_t > &offsets, std::string_view typeName="")
 
std::size_t AppendImpl (const Detail::RFieldValue &value) final
 Operations on values of complex types, e.g. More...
 
std::unique_ptr< Detail::RFieldBaseCloneImpl (std::string_view newName) const override
 Called by Clone(), which additionally copies the on-disk ID. More...
 
void GenerateColumnsImpl () final
 Creates the backing columns corresponsing to the field type for writing. More...
 
void GenerateColumnsImpl (const RNTupleDescriptor &) final
 Creates the backing columns corresponsing to the field type for reading. More...
 
std::size_t GetItemPadding (std::size_t baseOffset, std::size_t itemAlignment) const
 
void ReadGlobalImpl (NTupleSize_t globalIndex, Detail::RFieldValue *value) final
 
void ReadInClusterImpl (const RClusterIndex &clusterIndex, Detail::RFieldValue *value) final
 
- Protected Member Functions inherited from ROOT::Experimental::Detail::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. More...
 
virtual std::size_t AppendImpl (const RFieldValue &value)
 Operations on values of complex types, e.g. More...
 
virtual std::unique_ptr< RFieldBaseCloneImpl (std::string_view newName) const =0
 Called by Clone(), which additionally copies the on-disk ID. More...
 
const ColumnRepresentation_tEnsureCompatibleColumnTypes (const RNTupleDescriptor &desc) const
 Returns the on-disk column types found in the provided descriptor for fOnDiskId. More...
 
virtual void GenerateColumnsImpl ()=0
 Creates the backing columns corresponsing to the field type for writing. More...
 
virtual void GenerateColumnsImpl (const RNTupleDescriptor &desc)=0
 Creates the backing columns corresponsing to the field type for reading. More...
 
virtual const RColumnRepresentationsGetColumnRepresentations () const
 Implementations in derived classes should return a static RColumnRepresentations object. More...
 
virtual void OnConnectPageSource ()
 Called by ConnectPageSource() only once connected; derived classes may override this as appropriate. More...
 
virtual void ReadGlobalImpl (NTupleSize_t globalIndex, RFieldValue *value)
 
virtual void ReadInClusterImpl (const RClusterIndex &clusterIndex, RFieldValue *value)
 
void RemoveReadCallback (size_t idx)
 

Protected Attributes

std::size_t fMaxAlignment = 1
 
std::vector< std::size_t > fOffsets
 
std::size_t fSize = 0
 
- Protected Attributes inherited from ROOT::Experimental::Detail::RFieldBase
const ColumnRepresentation_tfColumnRepresentative = nullptr
 Points into the static vector GetColumnRepresentations().GetSerializationTypes() when SetColumnRepresentative is called. More...
 
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...
 
std::uint32_t fOnDiskTypeVersion = kInvalidTypeVersion
 C++ type version cached from the descriptor after a call to ConnectPageSource() More...
 
RFieldBasefParent
 Sub fields point to their mother field. More...
 
RColumnfPrincipalColumn
 Points into fColumns. More...
 
std::vector< ReadCallback_tfReadCallbacks
 List of functions to be called after reading a value. More...
 
std::vector< std::unique_ptr< RFieldBase > > fSubFields
 Collections and classes own sub fields. More...
 
int fTraits = 0
 Properties of the type that allow for optimizations of collections of that type. More...
 

Additional Inherited Members

- Public Types inherited from ROOT::Experimental::Detail::RFieldBase
using ColumnRepresentation_t = std::vector< EColumnType >
 
- Static Public Member Functions inherited from ROOT::Experimental::Detail::RFieldBase
static RResult< std::unique_ptr< 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 RResult< void > EnsureValidFieldName (std::string_view fieldName)
 Check whether a given string is a valid field name. More...
 
- Static Public Attributes inherited from ROOT::Experimental::Detail::RFieldBase
static constexpr std::uint32_t kInvalidTypeVersion = -1U
 
static constexpr int kTraitMappable = 0x04
 A field of a fundamental type that can be directly mapped via RField<T>::Map(), i.e. More...
 
static constexpr int kTraitTriviallyConstructible = 0x01
 No constructor needs to be called, i.e. More...
 
static constexpr int kTraitTriviallyDestructible = 0x02
 The type is cleaned up just by freeing its memory. I.e. DestroyValue() is a no-op. More...
 
static constexpr int kTraitTrivialType = kTraitTriviallyConstructible | kTraitTriviallyDestructible
 Shorthand for types that are both trivially constructible and destructible. More...
 

#include <ROOT/RField.hxx>

Inheritance diagram for ROOT::Experimental::RRecordField:
[legend]

Constructor & Destructor Documentation

◆ RRecordField() [1/5]

ROOT::Experimental::RRecordField::RRecordField ( std::string_view  fieldName,
std::vector< std::unique_ptr< Detail::RFieldBase > > &&  itemFields,
const std::vector< std::size_t > &  offsets,
std::string_view  typeName = "" 
)
protected

Definition at line 1345 of file RField.cxx.

◆ RRecordField() [2/5]

template<std::size_t N>
ROOT::Experimental::RRecordField::RRecordField ( std::string_view  fieldName,
std::array< std::unique_ptr< Detail::RFieldBase >, N > &&  itemFields,
const std::array< std::size_t, N > &  offsets,
std::string_view  typeName = "" 
)
inlineprotected

Definition at line 513 of file RField.hxx.

◆ RRecordField() [3/5]

ROOT::Experimental::RRecordField::RRecordField ( std::string_view  fieldName,
std::vector< std::unique_ptr< Detail::RFieldBase > > &&  itemFields 
)

Construct a RRecordField based on a vector of child fields.

The ownership of the child fields is transferred to the RRecordField instance.

Definition at line 1360 of file RField.cxx.

◆ RRecordField() [4/5]

ROOT::Experimental::RRecordField::RRecordField ( std::string_view  fieldName,
std::vector< std::unique_ptr< Detail::RFieldBase > > &  itemFields 
)

Definition at line 1378 of file RField.cxx.

◆ RRecordField() [5/5]

ROOT::Experimental::RRecordField::RRecordField ( RRecordField &&  other)
default

◆ ~RRecordField()

ROOT::Experimental::RRecordField::~RRecordField ( )
overridedefault

Member Function Documentation

◆ AcceptVisitor()

void ROOT::Experimental::RRecordField::AcceptVisitor ( Detail::RFieldVisitor visitor) const
finalvirtual

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

Definition at line 1464 of file RField.cxx.

◆ AppendImpl()

std::size_t ROOT::Experimental::RRecordField::AppendImpl ( 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 1403 of file RField.cxx.

◆ CaptureValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RRecordField::CaptureValue ( void *  where)
finalvirtual

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

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

Definition at line 1447 of file RField.cxx.

◆ CloneImpl()

std::unique_ptr< ROOT::Experimental::Detail::RFieldBase > ROOT::Experimental::RRecordField::CloneImpl ( std::string_view  newName) const
overrideprotectedvirtual

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

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

Reimplemented in ROOT::Experimental::RPairField, and ROOT::Experimental::RTupleField.

Definition at line 1395 of file RField.cxx.

◆ DestroyValue()

void ROOT::Experimental::RRecordField::DestroyValue ( const Detail::RFieldValue value,
bool  dtorOnly = false 
)
overridevirtual

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.

Reimplemented in ROOT::Experimental::RPairField, and ROOT::Experimental::RTupleField.

Definition at line 1436 of file RField.cxx.

◆ GenerateColumnsImpl() [1/2]

void ROOT::Experimental::RRecordField::GenerateColumnsImpl ( )
inlinefinalprotectedvirtual

Creates the backing columns corresponsing to the field type for writing.

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

Definition at line 503 of file RField.hxx.

◆ GenerateColumnsImpl() [2/2]

void ROOT::Experimental::RRecordField::GenerateColumnsImpl ( const RNTupleDescriptor desc)
inlinefinalprotectedvirtual

Creates the backing columns corresponsing to the field type for reading.

The method should to check, using the page source and fOnDiskId, if the column types match and throw if they don't.

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

Definition at line 504 of file RField.hxx.

◆ GenerateValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RRecordField::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::RPairField, and ROOT::Experimental::RTupleField.

Definition at line 1428 of file RField.cxx.

◆ GetAlignment()

size_t ROOT::Experimental::RRecordField::GetAlignment ( ) const
inlinefinalvirtual

For many types, the alignment requirement is equal to the size; otherwise override.

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

Definition at line 541 of file RField.hxx.

◆ GetItemPadding()

std::size_t ROOT::Experimental::RRecordField::GetItemPadding ( std::size_t  baseOffset,
std::size_t  itemAlignment 
) const
protected

Definition at line 1384 of file RField.cxx.

◆ GetValueSize()

size_t ROOT::Experimental::RRecordField::GetValueSize ( ) const
inlinefinalvirtual

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

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

Definition at line 540 of file RField.hxx.

◆ operator=()

RRecordField & ROOT::Experimental::RRecordField::operator= ( RRecordField &&  other)
default

◆ ReadGlobalImpl()

void ROOT::Experimental::RRecordField::ReadGlobalImpl ( NTupleSize_t  globalIndex,
Detail::RFieldValue value 
)
finalprotectedvirtual

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

Definition at line 1412 of file RField.cxx.

◆ ReadInClusterImpl()

void ROOT::Experimental::RRecordField::ReadInClusterImpl ( const RClusterIndex clusterIndex,
Detail::RFieldValue value 
)
finalprotectedvirtual

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

Definition at line 1420 of file RField.cxx.

◆ SplitValue()

std::vector< ROOT::Experimental::Detail::RFieldValue > ROOT::Experimental::RRecordField::SplitValue ( const Detail::RFieldValue value) const
finalvirtual

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

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

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

Definition at line 1454 of file RField.cxx.

Member Data Documentation

◆ fMaxAlignment

std::size_t ROOT::Experimental::RRecordField::fMaxAlignment = 1
protected

Definition at line 496 of file RField.hxx.

◆ fOffsets

std::vector<std::size_t> ROOT::Experimental::RRecordField::fOffsets
protected

Definition at line 498 of file RField.hxx.

◆ fSize

std::size_t ROOT::Experimental::RRecordField::fSize = 0
protected

Definition at line 497 of file RField.hxx.

Libraries for ROOT::Experimental::RRecordField:
[legend]

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