Logo ROOT   master
Reference Guide
ROOT::Experimental::RFieldArray Class Reference

The generic field for fixed size arrays, which do not need an offset column.

Definition at line 333 of file RField.hxx.

Public Member Functions

 RFieldArray (std::string_view fieldName, std::unique_ptr< Detail::RFieldBase > itemField, std::size_t arrayLength)
 
 RFieldArray (RFieldArray &&other)=default
 
 ~RFieldArray ()=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...
 
RFieldBaseClone (std::string_view newName) final
 
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...
 
size_t GetLength () const
 
size_t GetValueSize () const final
 The number of bytes taken by a value of the appropriate type. More...
 
RFieldArrayoperator= (RFieldArray &&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 (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...
 
 RFieldBase (const RFieldBase &)=delete
 
 RFieldBase (RFieldBase &&)=default
 
virtual ~RFieldBase ()
 
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 void CommitCluster ()
 Perform housekeeping tasks for global to cluster-local index translation. 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 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...
 
bool IsSimple () const
 
RFieldBaseoperator= (const RFieldBase &)=delete
 
RFieldBaseoperator= (RFieldBase &&)=default
 
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 Read (const RClusterIndex &clusterIndex, RFieldValue *value)
 

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
 
void ReadInClusterImpl (const RClusterIndex &clusterIndex, Detail::RFieldValue *value) final
 

Private Attributes

std::size_t fArrayLength
 
std::size_t fItemSize
 

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::RFieldArray:
[legend]

Constructor & Destructor Documentation

◆ RFieldArray() [1/2]

ROOT::Experimental::RFieldArray::RFieldArray ( std::string_view  fieldName,
std::unique_ptr< Detail::RFieldBase itemField,
std::size_t  arrayLength 
)

Definition at line 788 of file RField.cxx.

◆ RFieldArray() [2/2]

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

◆ ~RFieldArray()

ROOT::Experimental::RFieldArray::~RFieldArray ( )
default

Member Function Documentation

◆ AcceptVisitor()

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

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

Definition at line 872 of file RField.cxx.

◆ AppendImpl()

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

◆ CaptureValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RFieldArray::CaptureValue ( void where)
finalvirtual

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

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

Definition at line 855 of file RField.cxx.

◆ Clone()

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

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

Definition at line 798 of file RField.cxx.

◆ DestroyValue()

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

◆ GenerateColumnsImpl()

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

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

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

Definition at line 831 of file RField.cxx.

◆ GenerateValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RFieldArray::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 835 of file RField.cxx.

◆ GetAlignment()

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

◆ GetLength()

size_t ROOT::Experimental::RFieldArray::GetLength ( ) const
inline

Definition at line 356 of file RField.hxx.

◆ GetValueSize()

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

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

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

Definition at line 357 of file RField.hxx.

◆ operator=()

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

◆ ReadGlobalImpl()

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

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

Definition at line 812 of file RField.cxx.

◆ ReadInClusterImpl()

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

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

Definition at line 821 of file RField.cxx.

◆ SplitValue()

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

Member Data Documentation

◆ fArrayLength

std::size_t ROOT::Experimental::RFieldArray::fArrayLength
private

Definition at line 336 of file RField.hxx.

◆ fItemSize

std::size_t ROOT::Experimental::RFieldArray::fItemSize
private

Definition at line 335 of file RField.hxx.


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