Logo ROOT  
Reference Guide
ROOT::Experimental::RTupleField Class Reference

The generic field for std::tuple<Ts...> types.

Definition at line 614 of file RField.hxx.

Public Member Functions

 RTupleField (RTupleField &&other)=default
 
 RTupleField (std::string_view fieldName, std::vector< std::unique_ptr< Detail::RFieldBase > > &itemFields)
 
 ~RTupleField ()=default
 
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...
 
Detail::RFieldValue GenerateValue (void *where) override
 Generates a tree value in a given location of size at least GetValueSize(). More...
 
RTupleFieldoperator= (RTupleField &&other)=default
 
- Public Member Functions inherited from ROOT::Experimental::RRecordField
 RRecordField (RRecordField &&other)=default
 
 RRecordField (std::string_view fieldName, std::vector< std::unique_ptr< Detail::RFieldBase > > &&itemFields)
 Construct a RRecordField based on a vector of child fields. More...
 
 RRecordField (std::string_view fieldName, std::vector< std::unique_ptr< Detail::RFieldBase > > &itemFields)
 
 ~RRecordField ()=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...
 
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 &) 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 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...
 
RRecordFieldoperator= (RRecordField &&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
 
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
 
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

 RTupleField (std::string_view fieldName, std::vector< std::unique_ptr< Detail::RFieldBase > > &&itemFields, const std::vector< std::size_t > &offsets)
 
std::unique_ptr< Detail::RFieldBaseCloneImpl (std::string_view newName) const override
 Called by Clone(), which additionally copies the on-disk ID. More...
 
- Protected Member Functions inherited from ROOT::Experimental::RRecordField
template<std::size_t N>
 RRecordField (std::string_view fieldName, std::array< std::unique_ptr< Detail::RFieldBase >, N > &&itemFields, const std::array< std::size_t, N > &offsets, std::string_view typeName="")
 
 RRecordField (std::string_view fieldName, std::vector< std::unique_ptr< Detail::RFieldBase > > &&itemFields, const std::vector< std::size_t > &offsets, std::string_view typeName="")
 
std::size_t 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 override
 Called by Clone(), which additionally copies the on-disk ID. More...
 
std::size_t GetItemPadding (std::size_t baseOffset, std::size_t itemAlignment) const
 
void ReadGlobalImpl (NTupleSize_t globalIndex, Detail::RFieldValue *value) final
 
void ReadInClusterImpl (const RClusterIndex &clusterIndex, Detail::RFieldValue *value) final
 
- 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)
 

Static Private Member Functions

static std::string GetTypeList (const std::vector< std::unique_ptr< Detail::RFieldBase > > &itemFields)
 

Private Attributes

TClassfClass = nullptr
 

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...
 
- Protected Attributes inherited from ROOT::Experimental::RRecordField
std::size_t fMaxAlignment = 1
 
std::vector< std::size_t > fOffsets
 
std::size_t fSize = 0
 
- 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::RTupleField:
[legend]

Constructor & Destructor Documentation

◆ RTupleField() [1/3]

ROOT::Experimental::RTupleField::RTupleField ( std::string_view  fieldName,
std::vector< std::unique_ptr< Detail::RFieldBase > > &&  itemFields,
const std::vector< std::size_t > &  offsets 
)
protected

Definition at line 1770 of file RField.cxx.

◆ RTupleField() [2/3]

ROOT::Experimental::RTupleField::RTupleField ( std::string_view  fieldName,
std::vector< std::unique_ptr< Detail::RFieldBase > > &  itemFields 
)

Definition at line 1778 of file RField.cxx.

◆ RTupleField() [3/3]

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

◆ ~RTupleField()

ROOT::Experimental::RTupleField::~RTupleField ( )
default

Member Function Documentation

◆ CloneImpl()

std::unique_ptr< ROOT::Experimental::Detail::RFieldBase > ROOT::Experimental::RTupleField::CloneImpl ( std::string_view  newName) const
overrideprotectedvirtual

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

Reimplemented from ROOT::Experimental::RRecordField.

Definition at line 1803 of file RField.cxx.

◆ DestroyValue()

void ROOT::Experimental::RTupleField::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::RRecordField.

Definition at line 1819 of file RField.cxx.

◆ GenerateValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RTupleField::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().

Reimplemented from ROOT::Experimental::RRecordField.

Definition at line 1814 of file RField.cxx.

◆ GetTypeList()

static std::string ROOT::Experimental::RTupleField::GetTypeList ( const std::vector< std::unique_ptr< Detail::RFieldBase > > &  itemFields)
staticprivate

◆ operator=()

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

Member Data Documentation

◆ fClass

TClass* ROOT::Experimental::RTupleField::fClass = nullptr
private

Definition at line 616 of file RField.hxx.

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

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