Logo ROOT  
Reference Guide
ROOT::Experimental::RRVecField Class Reference

The type-erased field for a RVec<Type>

Definition at line 487 of file RField.hxx.

Public Member Functions

 RRVecField (const RRVecField &)=delete
 
 RRVecField (RRVecField &&)=default
 
 RRVecField (std::string_view fieldName, std::unique_ptr< Detail::RFieldBase > itemField)
 
 ~RRVecField () override=default
 
void AcceptVisitor (Detail::RFieldVisitor &visitor) const final
 
Detail::RFieldValue CaptureValue (void *where) override
 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) 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...
 
void GenerateColumnsImpl () final
 Creates the backing columns corresponsing to the field type for writing. More...
 
void GenerateColumnsImpl (const RNTupleDescriptor &desc) final
 Creates the backing columns corresponsing to the field type for reading. 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 override
 For many types, the alignment requirement is equal to the size; otherwise override. More...
 
void GetCollectionInfo (const RClusterIndex &clusterIndex, RClusterIndex *collectionStart, ClusterSize_t *size) const
 
void GetCollectionInfo (NTupleSize_t globalIndex, RClusterIndex *collectionStart, ClusterSize_t *size) const
 
size_t GetValueSize () const override
 The number of bytes taken by a value of the appropriate type. More...
 
RRVecFieldoperator= (RRVecField &&)=default
 
RRVecFieldoperator= (RRVecField &)=delete
 
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...
 
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
 
RFieldBaseGetParent () const
 
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 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

std::size_t AppendImpl (const Detail::RFieldValue &value) override
 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 ReadGlobalImpl (NTupleSize_t globalIndex, Detail::RFieldValue *value) override
 
- Protected Member Functions inherited from ROOT::Experimental::Detail::RFieldBase
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...
 
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)
 

Protected Attributes

std::size_t fItemSize
 
ClusterSize_t fNWritten
 
std::size_t fValueSize
 
- 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...
 
int fTraits = 0
 Properties of the type that allow for optimizations of collections of that type. More...
 

Private Member Functions

std::size_t EvalValueSize () const
 Evaluate the constant returned by GetValueSize. More...
 

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< 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 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 combining all other shortcut traits. More...
 

#include <ROOT/RField.hxx>

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

Constructor & Destructor Documentation

◆ RRVecField() [1/3]

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

Definition at line 1405 of file RField.cxx.

◆ RRVecField() [2/3]

ROOT::Experimental::RRVecField::RRVecField ( RRVecField &&  )
default

◆ RRVecField() [3/3]

ROOT::Experimental::RRVecField::RRVecField ( const RRVecField )
delete

◆ ~RRVecField()

ROOT::Experimental::RRVecField::~RRVecField ( )
overridedefault

Member Function Documentation

◆ AcceptVisitor()

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

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

Definition at line 1643 of file RField.cxx.

◆ AppendImpl()

std::size_t ROOT::Experimental::RRVecField::AppendImpl ( const Detail::RFieldValue value)
overrideprotectedvirtual

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.

Reimplemented in ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >.

Definition at line 1421 of file RField.cxx.

◆ CaptureValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RRVecField::CaptureValue ( void *  where)
overridevirtual

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

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

Reimplemented in ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >.

Definition at line 1559 of file RField.cxx.

◆ CloneImpl()

std::unique_ptr< ROOT::Experimental::Detail::RFieldBase > ROOT::Experimental::RRVecField::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::RField< ROOT::VecOps::RVec< ItemT > >.

Definition at line 1415 of file RField.cxx.

◆ CommitCluster()

void ROOT::Experimental::RRVecField::CommitCluster ( )
finalvirtual

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

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

Definition at line 1638 of file RField.cxx.

◆ DestroyValue()

void ROOT::Experimental::RRVecField::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::RField< ROOT::VecOps::RVec< ItemT > >.

Definition at line 1530 of file RField.cxx.

◆ EvalValueSize()

size_t ROOT::Experimental::RRVecField::EvalValueSize ( ) const
private

Evaluate the constant returned by GetValueSize.

Definition at line 1578 of file RField.cxx.

◆ GenerateColumnsImpl() [1/2]

void ROOT::Experimental::RRVecField::GenerateColumnsImpl ( )
finalvirtual

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

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

Definition at line 1506 of file RField.cxx.

◆ GenerateColumnsImpl() [2/2]

void ROOT::Experimental::RRVecField::GenerateColumnsImpl ( const RNTupleDescriptor desc)
finalvirtual

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 1513 of file RField.cxx.

◆ GenerateValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RRVecField::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< ROOT::VecOps::RVec< ItemT > >.

Definition at line 1519 of file RField.cxx.

◆ GetAlignment()

size_t ROOT::Experimental::RRVecField::GetAlignment ( ) const
overridevirtual

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

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

Reimplemented in ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >.

Definition at line 1631 of file RField.cxx.

◆ GetCollectionInfo() [1/2]

void ROOT::Experimental::RRVecField::GetCollectionInfo ( const RClusterIndex clusterIndex,
RClusterIndex collectionStart,
ClusterSize_t size 
) const
inline

Definition at line 525 of file RField.hxx.

◆ GetCollectionInfo() [2/2]

void ROOT::Experimental::RRVecField::GetCollectionInfo ( NTupleSize_t  globalIndex,
RClusterIndex collectionStart,
ClusterSize_t size 
) const
inline

Definition at line 521 of file RField.hxx.

◆ GetValueSize()

size_t ROOT::Experimental::RRVecField::GetValueSize ( ) const
overridevirtual

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

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

Reimplemented in ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >.

Definition at line 1626 of file RField.cxx.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ ReadGlobalImpl()

void ROOT::Experimental::RRVecField::ReadGlobalImpl ( NTupleSize_t  globalIndex,
Detail::RFieldValue value 
)
overrideprotectedvirtual

◆ SplitValue()

std::vector< ROOT::Experimental::Detail::RFieldValue > ROOT::Experimental::RRVecField::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 1565 of file RField.cxx.

Member Data Documentation

◆ fItemSize

std::size_t ROOT::Experimental::RRVecField::fItemSize
protected

Definition at line 494 of file RField.hxx.

◆ fNWritten

ClusterSize_t ROOT::Experimental::RRVecField::fNWritten
protected

Definition at line 495 of file RField.hxx.

◆ fValueSize

std::size_t ROOT::Experimental::RRVecField::fValueSize
protected

Definition at line 496 of file RField.hxx.

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

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