Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Experimental::RRecordField Class Reference

The field for an untyped record.

The subfields are stored consequitively in a memory block, i.e. the memory layout is identical to one that a C++ struct would have

Definition at line 41 of file RFieldRecord.hxx.

Classes

class  RRecordDeleter
 

Public Member Functions

 RRecordField (RRecordField &&other)=default
 
 RRecordField (std::string_view fieldName, std::vector< std::unique_ptr< RFieldBase > > &&itemFields)
 Construct a RRecordField based on a vector of child fields.
 
 RRecordField (std::string_view fieldName, std::vector< std::unique_ptr< RFieldBase > > &itemFields)
 
 ~RRecordField () override=default
 
void AcceptVisitor (Detail::RFieldVisitor &visitor) const final
 
size_t GetAlignment () const final
 As a rule of thumb, the alignment is equal to the size of the type.
 
const std::vector< std::size_t > & GetOffsets () const
 
size_t GetValueSize () const final
 The number of bytes taken by a value of the appropriate type.
 
RRecordFieldoperator= (RRecordField &&other)=default
 
std::vector< RValueSplitValue (const RValue &value) const final
 Creates the list of direct child values given a value for this field.
 
- Public Member Functions inherited from ROOT::Experimental::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.
 
virtual ~RFieldBase ()=default
 
RSchemaIterator begin ()
 
RValue BindValue (std::shared_ptr< void > objPtr)
 Creates a value from a memory location with an already constructed object.
 
RConstSchemaIterator cbegin () const
 
RConstSchemaIterator cend () const
 
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.
 
RBulk CreateBulk ()
 The returned bulk is initially empty; RBulk::ReadBulk will construct the array of values.
 
template<>
std::unique_ptr< void, typename RFieldBase::RCreateObjectDeleter< void >::deleter > CreateObject () const
 
template<typename T >
std::unique_ptr< T, typename RCreateObjectDeleter< T >::deleter > CreateObject () const
 Generates an object of the field type and allocates new initialized memory according to the type.
 
template<>
std::unique_ptr< void, typename ROOT::Experimental::RFieldBase::RCreateObjectDeleter< void >::deleter > CreateObject () const
 
RValue CreateValue ()
 Generates an object of the field type and wraps the created object in a shared pointer and returns it an RValue connected to the field.
 
RSchemaIterator end ()
 
RColumnRepresentations::Selection_t GetColumnRepresentatives () const
 Returns the fColumnRepresentative pointee or, if unset, the field's default representative.
 
const std::string & GetDescription () const
 Get the field's description.
 
const std::string & GetFieldName () const
 
virtual std::uint32_t GetFieldVersion () const
 Indicates an evolution of the mapping scheme from C++ type to columns.
 
NTupleSize_t GetNElements () const
 
std::size_t GetNRepetitions () const
 
DescriptorId_t GetOnDiskId () const
 
std::uint32_t GetOnDiskTypeChecksum () const
 Return checksum stored in the field descriptor; only valid after a call to ConnectPageSource(), if the field stored a type checksum.
 
std::uint32_t GetOnDiskTypeVersion () const
 Return the C++ type version stored in the field descriptor; only valid after a call to ConnectPageSource()
 
const RFieldBaseGetParent () const
 
std::string GetQualifiedFieldName () const
 Returns the field name and parent field names separated by dots ("grandparent.parent.child")
 
EState GetState () const
 
ENTupleStructure GetStructure () const
 
std::vector< RFieldBase * > GetSubFields ()
 
std::vector< const RFieldBase * > GetSubFields () const
 
int GetTraits () const
 
const std::string & GetTypeAlias () const
 
virtual std::uint32_t GetTypeChecksum () const
 Return the current TClass reported checksum of this class. Only valid if kTraitTypeChecksum is set.
 
const std::string & GetTypeName () const
 
virtual std::uint32_t GetTypeVersion () const
 Indicates an evolution of the C++ type itself.
 
bool HasDefaultColumnRepresentative () const
 Whether or not an explicit column representative was set.
 
bool HasReadCallbacks () const
 
bool IsSimple () const
 
RFieldBaseoperator= (const RFieldBase &)=delete
 
RFieldBaseoperator= (RFieldBase &&)=default
 
void SetColumnRepresentatives (const RColumnRepresentations::Selection_t &representatives)
 Fixes a column representative.
 
void SetDescription (std::string_view description)
 
void SetOnDiskId (DescriptorId_t id)
 

Protected Member Functions

template<std::size_t N>
 RRecordField (std::string_view fieldName, std::array< std::unique_ptr< 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< RFieldBase > > &&itemFields, const std::vector< std::size_t > &offsets, std::string_view typeName="")
 
std::size_t AppendImpl (const void *from) final
 Operations on values of complex types, e.g.
 
std::unique_ptr< RFieldBaseCloneImpl (std::string_view newName) const override
 Called by Clone(), which additionally copies the on-disk ID.
 
void ConstructValue (void *where) const override
 Constructs value in a given location of size at least GetValueSize(). Called by the base class' CreateValue().
 
std::unique_ptr< RDeleterGetDeleter () const override
 
std::size_t GetItemPadding (std::size_t baseOffset, std::size_t itemAlignment) const
 
void ReadGlobalImpl (NTupleSize_t globalIndex, void *to) final
 
void ReadInClusterImpl (RClusterIndex clusterIndex, void *to) final
 
- Protected Member Functions inherited from ROOT::Experimental::RFieldBase
size_t AddReadCallback (ReadCallback_t func)
 Set a user-defined function to be called after reading a value, giving a chance to inspect and/or modify the value object.
 
std::size_t Append (const void *from)
 Write the given value into columns.
 
void Attach (std::unique_ptr< RFieldBase > child)
 Add a new subfield to the list of nested fields.
 
void AutoAdjustColumnTypes (const RNTupleWriteOptions &options)
 When connecting a field to a page sink, the field's default column representation is subject to adjustment according to the write options.
 
virtual void CommitClusterImpl ()
 
const ColumnRepresentation_tEnsureCompatibleColumnTypes (const RNTupleDescriptor &desc, std::uint16_t representationIndex) const
 Returns the on-disk column types found in the provided descriptor for fOnDiskId and the given representation index.
 
virtual void GenerateColumns ()
 Implementations in derived classes should create the backing columns corresponsing to the field type for writing.
 
virtual void GenerateColumns (const RNTupleDescriptor &)
 Implementations in derived classes should create the backing columns corresponsing to the field type for reading.
 
template<typename... ColumnCppTs>
void GenerateColumnsImpl ()
 For writing, use the currently set column representative.
 
template<std::uint32_t ColumnIndexT, typename HeadT , typename... TailTs>
void GenerateColumnsImpl (const ColumnRepresentation_t &representation, std::uint16_t representationIndex)
 Helpers for generating columns.
 
template<typename... ColumnCppTs>
void GenerateColumnsImpl (const RNTupleDescriptor &desc)
 For reading, use the on-disk column list.
 
virtual const RColumnRepresentationsGetColumnRepresentations () const
 Implementations in derived classes should return a static RColumnRepresentations object.
 
virtual RExtraTypeInfoDescriptor GetExtraTypeInfo () const
 
virtual bool HasExtraTypeInfo () const
 
virtual void OnConnectPageSource ()
 Called by ConnectPageSource() once connected; derived classes may override this as appropriate.
 
void Read (NTupleSize_t globalIndex, void *to)
 Populate a single value with data from the field.
 
void Read (RClusterIndex clusterIndex, void *to)
 Populate a single value with data from the field.
 
std::size_t ReadBulk (const RBulkSpec &bulkSpec)
 Returns the number of newly available values, that is the number of bools in bulkSpec.fMaskAvail that flipped from false to true.
 
virtual std::size_t ReadBulkImpl (const RBulkSpec &bulkSpec)
 General implementation of bulk read.
 
void RemoveReadCallback (size_t idx)
 

Protected Attributes

std::size_t fMaxAlignment = 1
 
std::vector< std::size_t > fOffsets
 
std::size_t fSize = 0
 
- Protected Attributes inherited from ROOT::Experimental::RFieldBase
Internal::RColumnfAuxiliaryColumn = nullptr
 Some fields have a second column in its column representation.
 
std::vector< std::unique_ptr< Internal::RColumn > > fAvailableColumns
 The columns are connected either to a sink or to a source (not to both); they are owned by the field.
 
std::vector< std::reference_wrapper< const ColumnRepresentation_t > > fColumnRepresentatives
 Pointers into the static vector GetColumnRepresentations().GetSerializationTypes() when SetColumnRepresentatives is called.
 
std::uint32_t fOnDiskTypeChecksum = 0
 TClass checksum cached from the descriptor after a call to ConnectPageSource().
 
std::uint32_t fOnDiskTypeVersion = kInvalidTypeVersion
 C++ type version cached from the descriptor after a call to ConnectPageSource()
 
RFieldBasefParent
 Sub fields point to their mother field.
 
Internal::RColumnfPrincipalColumn = nullptr
 All fields that have columns have a distinct main column.
 
std::vector< ReadCallback_tfReadCallbacks
 List of functions to be called after reading a value.
 
std::vector< std::unique_ptr< RFieldBase > > fSubFields
 Collections and classes own sub fields.
 
int fTraits = 0
 Properties of the type that allow for optimizations of collections of that type.
 
std::string fTypeAlias
 A typedef or using name that was used when creating the field.
 

Additional Inherited Members

- Public Types inherited from ROOT::Experimental::RFieldBase
using ColumnRepresentation_t = std::vector< EColumnType >
 
enum class  EState { kUnconnected , kConnectedToSink , kConnectedToSource }
 During its lifetime, a field undergoes the following possible state transitions: More...
 
using RConstSchemaIterator = RSchemaIteratorTemplate< true >
 
using RSchemaIterator = RSchemaIteratorTemplate< false >
 
- Static Public Member Functions inherited from ROOT::Experimental::RFieldBase
static std::vector< RCheckResultCheck (const std::string &fieldName, const std::string &typeName)
 Checks if the given type is supported by RNTuple.
 
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.
 
static RResult< void > EnsureValidFieldName (std::string_view fieldName)
 Check whether a given string is a valid field name.
 
- Static Public Attributes inherited from ROOT::Experimental::RFieldBase
static constexpr std::uint32_t kInvalidTypeVersion = -1U
 
static constexpr int kTraitMappable = 0x04
 A field of a fundamental type that can be directly mapped via RField<T>::Map(), i.e.
 
static constexpr int kTraitTriviallyConstructible = 0x01
 No constructor needs to be called, i.e.
 
static constexpr int kTraitTriviallyDestructible = 0x02
 The type is cleaned up just by freeing its memory. I.e. the destructor performs a no-op.
 
static constexpr int kTraitTrivialType = kTraitTriviallyConstructible | kTraitTriviallyDestructible
 Shorthand for types that are both trivially constructible and destructible.
 
static constexpr int kTraitTypeChecksum = 0x08
 The TClass checksum is set and valid.
 
- Static Protected Member Functions inherited from ROOT::Experimental::RFieldBase
static std::size_t CallAppendOn (RFieldBase &other, const void *from)
 Allow derived classes to call Append and Read on other (sub) fields.
 
static void CallConstructValueOn (const RFieldBase &other, void *where)
 Allow derived classes to call ConstructValue(void *) and GetDeleter on other (sub) fields.
 
static void CallReadOn (RFieldBase &other, NTupleSize_t globalIndex, void *to)
 
static void CallReadOn (RFieldBase &other, RClusterIndex clusterIndex, void *to)
 
static RResult< std::unique_ptr< RFieldBase > > Create (const std::string &fieldName, const std::string &canonicalType, const std::string &typeAlias, bool fContinueOnError=false)
 Factory method to resurrect a field from the stored on-disk type information.
 
static std::unique_ptr< RDeleterGetDeleterOf (const RFieldBase &other)
 
static Internal::RColumnGetPrincipalColumnOf (const RFieldBase &other)
 Fields may need direct access to the principal column of their sub fields, e.g. in RRVecField::ReadBulk.
 

#include <ROOT/RField/RFieldRecord.hxx>

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

Constructor & Destructor Documentation

◆ RRecordField() [1/5]

ROOT::Experimental::RRecordField::RRecordField ( std::string_view  fieldName,
std::vector< std::unique_ptr< RFieldBase > > &&  itemFields,
const std::vector< std::size_t > &  offsets,
std::string_view  typeName = "" 
)
protected

Definition at line 2392 of file RField.cxx.

◆ RRecordField() [2/5]

template<std::size_t N>
ROOT::Experimental::RRecordField::RRecordField ( std::string_view  fieldName,
std::array< std::unique_ptr< RFieldBase >, N > &&  itemFields,
const std::array< std::size_t, N > &  offsets,
std::string_view  typeName = "" 
)
inlineprotected

Definition at line 76 of file RFieldRecord.hxx.

◆ RRecordField() [3/5]

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

Construct a RRecordField based on a vector of child fields.

The ownership of the child fields is transferred to the RRecordField instance.

Definition at line 2407 of file RField.cxx.

◆ RRecordField() [4/5]

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

Definition at line 2426 of file RField.cxx.

◆ RRecordField() [5/5]

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

◆ ~RRecordField()

ROOT::Experimental::RRecordField::~RRecordField ( )
overridedefault

Member Function Documentation

◆ AcceptVisitor()

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

Reimplemented from ROOT::Experimental::RFieldBase.

Definition at line 2512 of file RField.cxx.

◆ AppendImpl()

std::size_t ROOT::Experimental::RRecordField::AppendImpl ( const void *  from)
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::RFieldBase.

Definition at line 2452 of file RField.cxx.

◆ CloneImpl()

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

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

Implements ROOT::Experimental::RFieldBase.

Reimplemented in ROOT::Experimental::RTupleField.

Definition at line 2443 of file RField.cxx.

◆ ConstructValue()

void ROOT::Experimental::RRecordField::ConstructValue ( void *  where) const
overrideprotectedvirtual

Constructs value in a given location of size at least GetValueSize(). Called by the base class' CreateValue().

Implements ROOT::Experimental::RFieldBase.

Reimplemented in ROOT::Experimental::RTupleField.

Definition at line 2475 of file RField.cxx.

◆ GetAlignment()

size_t ROOT::Experimental::RRecordField::GetAlignment ( ) const
inlinefinalvirtual

As a rule of thumb, the alignment is equal to the size of the type.

There are, however, various exceptions to this rule depending on OS and CPU architecture. So enforce the alignment to be explicitly spelled out.

Implements ROOT::Experimental::RFieldBase.

Definition at line 101 of file RFieldRecord.hxx.

◆ GetDeleter()

std::unique_ptr< ROOT::Experimental::RFieldBase::RDeleter > ROOT::Experimental::RRecordField::GetDeleter ( ) const
overrideprotectedvirtual

Reimplemented from ROOT::Experimental::RFieldBase.

Reimplemented in ROOT::Experimental::RTupleField.

Definition at line 2490 of file RField.cxx.

◆ GetItemPadding()

std::size_t ROOT::Experimental::RRecordField::GetItemPadding ( std::size_t  baseOffset,
std::size_t  itemAlignment 
) const
protected

Definition at line 2432 of file RField.cxx.

◆ GetOffsets()

const std::vector< std::size_t > & ROOT::Experimental::RRecordField::GetOffsets ( ) const
inline

Definition at line 104 of file RFieldRecord.hxx.

◆ GetValueSize()

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

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

Implements ROOT::Experimental::RFieldBase.

Definition at line 100 of file RFieldRecord.hxx.

◆ operator=()

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

◆ ReadGlobalImpl()

void ROOT::Experimental::RRecordField::ReadGlobalImpl ( NTupleSize_t  globalIndex,
void *  to 
)
finalprotectedvirtual

Reimplemented from ROOT::Experimental::RFieldBase.

Definition at line 2461 of file RField.cxx.

◆ ReadInClusterImpl()

void ROOT::Experimental::RRecordField::ReadInClusterImpl ( RClusterIndex  clusterIndex,
void *  to 
)
finalprotectedvirtual

Reimplemented from ROOT::Experimental::RFieldBase.

Definition at line 2468 of file RField.cxx.

◆ SplitValue()

std::vector< ROOT::Experimental::RFieldBase::RValue > ROOT::Experimental::RRecordField::SplitValue ( const RValue 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::RFieldBase.

Definition at line 2501 of file RField.cxx.

Member Data Documentation

◆ fMaxAlignment

std::size_t ROOT::Experimental::RRecordField::fMaxAlignment = 1
protected

Definition at line 57 of file RFieldRecord.hxx.

◆ fOffsets

std::vector<std::size_t> ROOT::Experimental::RRecordField::fOffsets
protected

Definition at line 59 of file RFieldRecord.hxx.

◆ fSize

std::size_t ROOT::Experimental::RRecordField::fSize = 0
protected

Definition at line 58 of file RFieldRecord.hxx.

Libraries for ROOT::Experimental::RRecordField:

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