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 321 of file RField.hxx.

Public Member Functions

 RRecordField (RRecordField &&other)=default
 
 RRecordField (std::string_view fieldName, std::vector< std::unique_ptr< Detail::RFieldBase > > &itemFields)
 
 ~RRecordField ()=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) 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 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...
 
Detail::RFieldValue GenerateValue (void *where) final
 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
 
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)
 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...
 
std::string GetDescription () const
 Get the field's description. More...
 
virtual RNTupleVersion 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
 
RFieldBaseGetParent () const
 
ENTupleStructure GetStructure () const
 
std::vector< RFieldBase * > GetSubFields () 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
 
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 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

void 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 final
 Called by Clone(), which additionally copies the on-disk ID. More...
 
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
virtual void 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...
 
ROOT::Experimental::EColumnType EnsureColumnType (const std::vector< EColumnType > &requestedTypes, unsigned int columnIndex, const RNTupleDescriptor &desc)
 Throws an exception if the column given by fOnDiskId and the columnIndex in the provided descriptor is not of one of the requested types. 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 void ReadGlobalImpl (NTupleSize_t globalIndex, RFieldValue *value)
 
virtual void ReadInClusterImpl (const RClusterIndex &clusterIndex, RFieldValue *value)
 

Private Member Functions

std::size_t GetItemPadding (std::size_t baseOffset, std::size_t itemAlignment) const
 

Private Attributes

std::size_t fMaxAlignment = 1
 
std::size_t fSize = 0
 

Additional Inherited Members

- 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< voidEnsureValidFieldName (std::string_view fieldName)
 Check whether a given string is a valid field name. 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...
 
RFieldBasefParent
 Sub fields point to their mother field. More...
 
RColumnfPrincipalColumn
 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::RRecordField:
[legend]

Constructor & Destructor Documentation

◆ RRecordField() [1/2]

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

Definition at line 869 of file RField.cxx.

◆ RRecordField() [2/2]

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

◆ ~RRecordField()

ROOT::Experimental::RRecordField::~RRecordField ( )
default

Member Function Documentation

◆ AcceptVisitor()

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

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

Definition at line 971 of file RField.cxx.

◆ AppendImpl()

void 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 900 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 952 of file RField.cxx.

◆ CloneImpl()

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

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

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

Definition at line 892 of file RField.cxx.

◆ DestroyValue()

void ROOT::Experimental::RRecordField::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 939 of file RField.cxx.

◆ GenerateColumnsImpl() [1/2]

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

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

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

Definition at line 340 of file RField.hxx.

◆ GenerateColumnsImpl() [2/2]

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

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 341 of file RField.hxx.

◆ GenerateValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RRecordField::GenerateValue ( void where)
finalvirtual

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.

Definition at line 929 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 348 of file RField.hxx.

◆ GetItemPadding()

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

Definition at line 881 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 347 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 909 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 919 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 959 of file RField.cxx.

Member Data Documentation

◆ fMaxAlignment

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

Definition at line 323 of file RField.hxx.

◆ fSize

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

Definition at line 324 of file RField.hxx.


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