Logo ROOT  
Reference Guide
ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > > Class Template Reference

template<typename ItemT>
class ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >

The RVec type has different layouts depending on the item type, therefore we cannot go with a generic RVec implementation as we can with std::vector.

Definition at line 1355 of file RField.hxx.

Public Member Functions

 RField (RField &&other)=default
 
 RField (std::string_view fieldName, std::unique_ptr< Detail::RFieldBase > itemField)
 
 RField (std::string_view name)
 
 ~RField ()=default
 
Detail::RFieldValue CaptureValue (void *where) final
 Creates a value from a memory location with an already constructed object. More...
 
void CommitCluster () final
 Perform housekeeping tasks for global to cluster-local index translation. 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...
 
ROOT::Experimental::Detail::RFieldValue GenerateValue (void *where) final
 Generates a tree value in a given location of size at least GetValueSize(). More...
 
template<typename... ArgsT>
ROOT::Experimental::Detail::RFieldValue GenerateValue (void *where, ArgsT &&... args)
 
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...
 
RFieldoperator= (RField &&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, 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...
 

Static Public Member Functions

static std::string TypeName ()
 
- 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 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
 
- 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 Types

using ContainerT = typename ROOT::VecOps::RVec< ItemT >
 

Private Attributes

size_t fItemSize
 
ClusterSize_t fNWritten
 

Additional Inherited Members

- 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::RField< ROOT::VecOps::RVec< ItemT > >:
[legend]

Member Typedef Documentation

◆ ContainerT

template<typename ItemT >
using ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::ContainerT = typename ROOT::VecOps::RVec<ItemT>
private

Definition at line 1356 of file RField.hxx.

Constructor & Destructor Documentation

◆ RField() [1/3]

template<typename ItemT >
ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::RField ( std::string_view  fieldName,
std::unique_ptr< Detail::RFieldBase itemField 
)
inline

Definition at line 1390 of file RField.hxx.

◆ RField() [2/3]

template<typename ItemT >
ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::RField ( std::string_view  name)
inlineexplicit

Definition at line 1397 of file RField.hxx.

◆ RField() [3/3]

template<typename ItemT >
ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::RField ( RField< ROOT::VecOps::RVec< ItemT > > &&  other)
default

◆ ~RField()

template<typename ItemT >
ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::~RField ( )
default

Member Function Documentation

◆ AppendImpl()

template<typename ItemT >
void ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::AppendImpl ( const Detail::RFieldValue value)
inlinefinalprotectedvirtual

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

◆ CaptureValue()

template<typename ItemT >
Detail::RFieldValue ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::CaptureValue ( void where)
inlinefinalvirtual

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

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

Definition at line 1438 of file RField.hxx.

◆ CloneImpl()

template<typename ItemT >
std::unique_ptr< Detail::RFieldBase > ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::CloneImpl ( std::string_view  newName) const
inlinefinalprotectedvirtual

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

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

Definition at line 1362 of file RField.hxx.

◆ CommitCluster()

template<typename ItemT >
void ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::CommitCluster ( )
inlinefinalvirtual

Perform housekeeping tasks for global to cluster-local index translation.

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

Definition at line 1425 of file RField.hxx.

◆ DestroyValue()

template<typename ItemT >
void ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::DestroyValue ( const Detail::RFieldValue value,
bool  dtorOnly = false 
)
inlinefinalvirtual

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

◆ GenerateColumnsImpl() [1/2]

template<typename ItemT >
void ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::GenerateColumnsImpl ( )
inlinefinalvirtual

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

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

Definition at line 1405 of file RField.hxx.

◆ GenerateColumnsImpl() [2/2]

template<typename ItemT >
void ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::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 1411 of file RField.hxx.

◆ GenerateValue() [1/2]

template<typename ItemT >
ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::GenerateValue ( void where)
inlinefinalvirtual

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

◆ GenerateValue() [2/2]

template<typename ItemT >
template<typename... ArgsT>
ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::GenerateValue ( void where,
ArgsT &&...  args 
)
inline

Definition at line 1431 of file RField.hxx.

◆ GetAlignment()

template<typename ItemT >
size_t ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::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 1442 of file RField.hxx.

◆ GetValueSize()

template<typename ItemT >
size_t ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::GetValueSize ( ) const
inlinefinalvirtual

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

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

Definition at line 1441 of file RField.hxx.

◆ operator=()

template<typename ItemT >
RField & ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::operator= ( RField< ROOT::VecOps::RVec< ItemT > > &&  other)
default

◆ ReadGlobalImpl()

template<typename ItemT >
void ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::ReadGlobalImpl ( NTupleSize_t  globalIndex,
Detail::RFieldValue value 
)
inlinefinalprotectedvirtual

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

Definition at line 1377 of file RField.hxx.

◆ TypeName()

template<typename ItemT >
static std::string ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::TypeName ( )
inlinestatic

Definition at line 1427 of file RField.hxx.

Member Data Documentation

◆ fItemSize

template<typename ItemT >
size_t ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::fItemSize
private

Definition at line 1358 of file RField.hxx.

◆ fNWritten

template<typename ItemT >
ClusterSize_t ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::fNWritten
private

Definition at line 1359 of file RField.hxx.


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