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

Definition at line 423 of file RField.hxx.

Public Member Functions

 RFieldCollection (std::string_view name, std::shared_ptr< RCollectionNTuple > collectionNTuple, std::unique_ptr< RNTupleModel > collectionModel)
 
 RFieldCollection (RFieldCollection &&other)=default
 
 ~RFieldCollection ()=default
 
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 CommitCluster () final
 Perform housekeeping tasks for global to cluster-local index translation. More...
 
void GenerateColumnsImpl () final
 Creates the backing columns corresponsing to the field type and name. More...
 
ROOT::Experimental::Detail::RFieldValue GenerateValue (void *where) final
 Generates a tree value in a given location of size at least GetValueSize(). More...
 
size_t GetValueSize () const final
 The number of bytes taken by a value of the appropriate type. More...
 
RFieldCollectionoperator= (RFieldCollection &&other)=default
 
- 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 ()
 
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 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 a tree value of the field type and allocates new initialized memory according to the type. 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...
 
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)
 
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 RFieldBaseCreate (const std::string &fieldName, const std::string &typeName)
 Factory method to resurrect a field from the stored on-disk type information. More...
 

Private Attributes

std::shared_ptr< RCollectionNTuplefCollectionNTuple
 Save the link to the collection ntuple in order to reset the offset counter when committing the cluster. More...
 

Additional Inherited Members

- 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 ReadGlobalImpl (NTupleSize_t globalIndex, RFieldValue *value)
 
virtual void ReadInClusterImpl (const RClusterIndex &clusterIndex, RFieldValue *value)
 
- 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::RFieldCollection:
[legend]

Constructor & Destructor Documentation

◆ RFieldCollection() [1/2]

ROOT::Experimental::RFieldCollection::RFieldCollection ( std::string_view  name,
std::shared_ptr< RCollectionNTuple collectionNTuple,
std::unique_ptr< RNTupleModel collectionModel 
)

Definition at line 985 of file RField.cxx.

◆ RFieldCollection() [2/2]

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

◆ ~RFieldCollection()

ROOT::Experimental::RFieldCollection::~RFieldCollection ( )
default

Member Function Documentation

◆ CaptureValue()

Detail::RFieldValue ROOT::Experimental::RFieldCollection::CaptureValue ( void where)
inlinefinalvirtual

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

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

Definition at line 445 of file RField.hxx.

◆ Clone()

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

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

Definition at line 1008 of file RField.cxx.

◆ CommitCluster()

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

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

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

Definition at line 1022 of file RField.cxx.

◆ GenerateColumnsImpl()

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

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

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

Definition at line 999 of file RField.cxx.

◆ GenerateValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RFieldCollection::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 440 of file RField.hxx.

◆ GetValueSize()

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

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

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

Definition at line 449 of file RField.hxx.

◆ operator=()

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

◆ TypeName()

static std::string ROOT::Experimental::RFieldCollection::TypeName ( )
inlinestatic

Definition at line 428 of file RField.hxx.

Member Data Documentation

◆ fCollectionNTuple

std::shared_ptr<RCollectionNTuple> ROOT::Experimental::RFieldCollection::fCollectionNTuple
private

Save the link to the collection ntuple in order to reset the offset counter when committing the cluster.

Definition at line 426 of file RField.hxx.


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