Logo ROOT  
Reference Guide
ROOT::Experimental::RFieldVector Class Reference

The generic field for a (nested) std::vector<Type> except for std::vector<bool>

Definition at line 297 of file RField.hxx.

Public Member Functions

 RFieldVector (RFieldVector &&other)=default
 
 RFieldVector (std::string_view fieldName, std::unique_ptr< Detail::RFieldBase > itemField)
 
 ~RFieldVector ()=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...
 
RFieldBaseClone (std::string_view newName) final
 
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 and name. 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...
 
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...
 
RFieldVectoroperator= (RFieldVector &&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...
 
virtual RFieldBaseClone (std::string_view newName)=0
 
virtual void CommitCluster ()
 Perform housekeeping tasks for global to cluster-local index translation. More...
 
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...
 
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
 
const RFieldBaseGetParent () const
 
ENTupleStructure GetStructure () const
 
std::vector< const 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...
 
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...
 
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 void GenerateColumnsImpl ()=0
 Creates the backing columns corresponsing to the field type and name. More...
 
virtual void ReadGlobalImpl (NTupleSize_t globalIndex, RFieldValue *value)
 
virtual void ReadInClusterImpl (const RClusterIndex &clusterIndex, RFieldValue *value)
 

Private Attributes

std::size_t fItemSize
 
ClusterSize_t fNWritten
 

Additional Inherited Members

- Static Public Member Functions inherited from ROOT::Experimental::Detail::RFieldBase
static RFieldBaseCreate (const std::string &fieldName, const std::string &typeName)
 Factory method to resurrect a field from the stored on-disk type information. 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::RFieldVector:
[legend]

Constructor & Destructor Documentation

◆ RFieldVector() [1/2]

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

Definition at line 605 of file RField.cxx.

◆ RFieldVector() [2/2]

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

◆ ~RFieldVector()

ROOT::Experimental::RFieldVector::~RFieldVector ( )
default

Member Function Documentation

◆ AcceptVisitor()

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

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

Definition at line 698 of file RField.cxx.

◆ AppendImpl()

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

◆ CaptureValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RFieldVector::CaptureValue ( void where)
overridevirtual

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

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

Definition at line 675 of file RField.cxx.

◆ Clone()

ROOT::Experimental::Detail::RFieldBase * ROOT::Experimental::RFieldVector::Clone ( std::string_view  newName)
finalvirtual

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

Definition at line 614 of file RField.cxx.

◆ CommitCluster()

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

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

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

Definition at line 693 of file RField.cxx.

◆ DestroyValue()

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

◆ GenerateColumnsImpl()

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

Creates the backing columns corresponsing to the field type and name.

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

Definition at line 648 of file RField.cxx.

◆ GenerateValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RFieldVector::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.

Definition at line 656 of file RField.cxx.

◆ GetAlignment()

size_t ROOT::Experimental::RFieldVector::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 320 of file RField.hxx.

◆ GetCollectionInfo() [1/2]

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

Definition at line 326 of file RField.hxx.

◆ GetCollectionInfo() [2/2]

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

Definition at line 323 of file RField.hxx.

◆ GetValueSize()

size_t ROOT::Experimental::RFieldVector::GetValueSize ( ) const
inlineoverridevirtual

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

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

Definition at line 319 of file RField.hxx.

◆ operator=()

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

◆ ReadGlobalImpl()

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

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

Definition at line 633 of file RField.cxx.

◆ SplitValue()

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

Member Data Documentation

◆ fItemSize

std::size_t ROOT::Experimental::RFieldVector::fItemSize
private

Definition at line 299 of file RField.hxx.

◆ fNWritten

ClusterSize_t ROOT::Experimental::RFieldVector::fNWritten
private

Definition at line 300 of file RField.hxx.

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

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