Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Experimental::RField< RNTupleCardinality< SizeT > > Class Template Reference

template<typename SizeT>
class ROOT::Experimental::RField< RNTupleCardinality< SizeT > >

Definition at line 1500 of file RField.hxx.

Public Member Functions

 RField (RField &&other)=default
 
 RField (std::string_view name)
 
 ~RField ()=default
 
size_t GetAlignment () const final
 As a rule of thumb, the alignment is equal to the size of the type.
 
size_t GetValueSize () const final
 The number of bytes taken by a value of the appropriate type.
 
RFieldoperator= (RField &&other)=default
 
std::size_t ReadBulkImpl (const RBulkSpec &bulkSpec) final
 General implementation of bulk read.
 
void ReadGlobalImpl (NTupleSize_t globalIndex, void *to) final
 Get the number of elements of the collection identified by globalIndex.
 
void ReadInClusterImpl (const RClusterIndex &clusterIndex, void *to) final
 Get the number of elements of the collection identified by clusterIndex.
 
- Public Member Functions inherited from ROOT::Experimental::RCardinalityField
 RCardinalityField (RCardinalityField &&other)=default
 
 ~RCardinalityField ()=default
 
void AcceptVisitor (Detail::RFieldVisitor &visitor) const final
 
const RField< RNTupleCardinality< std::uint32_t > > * As32Bit () const
 
const RField< RNTupleCardinality< std::uint64_t > > * As64Bit () const
 
RCardinalityFieldoperator= (RCardinalityField &&other)=default
 
- 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.
 
virtual ~RFieldBase ()
 
RSchemaIterator begin ()
 
RValue BindValue (void *where)
 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.
 
void CommitCluster ()
 Flushes data from active columns to disk and calls CommitClusterImpl.
 
void ConnectPageSink (RPageSink &pageSink, NTupleSize_t firstEntry=0)
 Fields and their columns live in the void until connected to a physical page storage.
 
void ConnectPageSource (RPageSource &pageSource)
 
RSchemaIterator end ()
 
RBulk GenerateBulk ()
 The returned bulk is initially empty; RBulk::ReadBulk will construct the array of values.
 
RValue GenerateValue ()
 Generates an object of the field type and allocates new initialized memory according to the type.
 
const ColumnRepresentation_tGetColumnRepresentative () const
 Returns the fColumnRepresentative pointee or, if unset, the field's default representative.
 
std::string GetDescription () const
 Get the field's description.
 
virtual std::uint32_t GetFieldVersion () const
 Indicates an evolution of the mapping scheme from C++ type to columns.
 
std::string GetName () const
 
NTupleSize_t GetNElements () const
 
std::size_t GetNRepetitions () const
 
DescriptorId_t GetOnDiskId () const
 
std::uint32_t GetOnDiskTypeVersion () const
 Return the C++ type version stored in the field descriptor; only valid after a call to ConnectPageSource()
 
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 () const
 
int GetTraits () const
 
std::string GetType () const
 
std::string GetTypeAlias () 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 SetColumnRepresentative (const ColumnRepresentation_t &representative)
 Fixes a column representative.
 
void SetDescription (std::string_view description)
 
void SetOnDiskId (DescriptorId_t id)
 
virtual std::vector< RValueSplitValue (const RValue &value) const
 Creates the list of direct child values given a value for this field.
 

Static Public Member Functions

static std::string TypeName ()
 
- 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.
 
static RResult< void > EnsureValidFieldName (std::string_view fieldName)
 Check whether a given string is a valid field name.
 

Protected Member Functions

std::unique_ptr< ROOT::Experimental::Detail::RFieldBaseCloneImpl (std::string_view newName) const final
 Called by Clone(), which additionally copies the on-disk ID.
 
void GenerateValue (void *where) const final
 Constructs value in a given location of size at least GetValueSize(). Called by the base class' GenerateValue().
 
- Protected Member Functions inherited from ROOT::Experimental::RCardinalityField
 RCardinalityField (std::string_view fieldName, std::string_view typeName)
 
void GenerateColumnsImpl () final
 Creates the backing columns corresponsing to the field type for writing.
 
void GenerateColumnsImpl (const RNTupleDescriptor &) final
 Creates the backing columns corresponsing to the field type for reading.
 
const RColumnRepresentationsGetColumnRepresentations () const final
 Implementations in derived classes should return a static RColumnRepresentations object.
 
- Protected Member Functions inherited from ROOT::Experimental::Detail::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.
 
virtual std::size_t AppendImpl (const void *from)
 Operations on values of complex types, e.g.
 
void Attach (std::unique_ptr< Detail::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 ()
 
virtual void DestroyValue (void *objPtr, bool dtorOnly=false) const
 Releases the resources acquired during GenerateValue (memory and constructor) This implementation works for types with a trivial destructor and should be overwritten otherwise.
 
const ColumnRepresentation_tEnsureCompatibleColumnTypes (const RNTupleDescriptor &desc) const
 Returns the on-disk column types found in the provided descriptor for fOnDiskId.
 
virtual void OnConnectPageSource ()
 Called by ConnectPageSource() only once connected; derived classes may override this as appropriate.
 
void Read (const RClusterIndex &clusterIndex, void *to)
 
void Read (NTupleSize_t globalIndex, 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.
 
void RemoveReadCallback (size_t idx)
 

Additional Inherited Members

- Public Types inherited from ROOT::Experimental::Detail::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 Attributes inherited from ROOT::Experimental::Detail::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. DestroyValue() is a no-op.
 
static constexpr int kTraitTrivialType = kTraitTriviallyConstructible | kTraitTriviallyDestructible
 Shorthand for types that are both trivially constructible and destructible.
 
- Static Protected Member Functions inherited from ROOT::Experimental::Detail::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 CallDestroyValueOn (const RFieldBase &other, void *objPtr, bool dtorOnly=false)
 
static void CallGenerateValueOn (const RFieldBase &other, void *where)
 Allow derived classes to call GenerateValue(void *) and DestroyValue on other (sub) fields.
 
static void CallReadOn (RFieldBase &other, const RClusterIndex &clusterIndex, void *to)
 
static void CallReadOn (RFieldBase &other, NTupleSize_t globalIndex, void *to)
 
static RResult< std::unique_ptr< RFieldBase > > Create (const std::string &fieldName, const std::string &canonicalType, const std::string &typeAlias)
 Factory method to resurrect a field from the stored on-disk type information.
 
static RColumnGetPrincipalColumnOf (const RFieldBase &other)
 Fields may need direct access to the principal column of their sub fields, e.g. in RRVecField::ReadBulk.
 
- Protected Attributes inherited from ROOT::Experimental::Detail::RFieldBase
const ColumnRepresentation_tfColumnRepresentative = nullptr
 Points into the static vector GetColumnRepresentations().GetSerializationTypes() when SetColumnRepresentative is called.
 
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.
 
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.
 
RColumnfPrincipalColumn
 Points into fColumns.
 
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.
 

#include <ROOT/RField.hxx>

Inheritance diagram for ROOT::Experimental::RField< RNTupleCardinality< SizeT > >:
[legend]

Constructor & Destructor Documentation

◆ RField() [1/2]

template<typename SizeT >
ROOT::Experimental::RField< RNTupleCardinality< SizeT > >::RField ( std::string_view  name)
inlineexplicit

Definition at line 1510 of file RField.hxx.

◆ RField() [2/2]

template<typename SizeT >
ROOT::Experimental::RField< RNTupleCardinality< SizeT > >::RField ( RField< RNTupleCardinality< SizeT > > &&  other)
default

◆ ~RField()

template<typename SizeT >
ROOT::Experimental::RField< RNTupleCardinality< SizeT > >::~RField ( )
default

Member Function Documentation

◆ CloneImpl()

template<typename SizeT >
std::unique_ptr< ROOT::Experimental::Detail::RFieldBase > ROOT::Experimental::RField< RNTupleCardinality< SizeT > >::CloneImpl ( std::string_view  newName) const
inlinefinalprotectedvirtual

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

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

Definition at line 1502 of file RField.hxx.

◆ GenerateValue()

template<typename SizeT >
void ROOT::Experimental::RField< RNTupleCardinality< SizeT > >::GenerateValue ( void *  where) const
inlinefinalprotectedvirtual

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

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

Definition at line 1506 of file RField.hxx.

◆ GetAlignment()

template<typename SizeT >
size_t ROOT::Experimental::RField< RNTupleCardinality< SizeT > >::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::Detail::RFieldBase.

Definition at line 1517 of file RField.hxx.

◆ GetValueSize()

template<typename SizeT >
size_t ROOT::Experimental::RField< RNTupleCardinality< SizeT > >::GetValueSize ( ) const
inlinefinalvirtual

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

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

Definition at line 1516 of file RField.hxx.

◆ operator=()

template<typename SizeT >
RField & ROOT::Experimental::RField< RNTupleCardinality< SizeT > >::operator= ( RField< RNTupleCardinality< SizeT > > &&  other)
default

◆ ReadBulkImpl()

template<typename SizeT >
std::size_t ROOT::Experimental::RField< RNTupleCardinality< SizeT > >::ReadBulkImpl ( const RBulkSpec bulkSpec)
inlinefinalvirtual

General implementation of bulk read.

Loop over the required range and read values that are required and not already present. Derived classes may implement more optimized versions of this method. See ReadBulk() for the return value.

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

Definition at line 1537 of file RField.hxx.

◆ ReadGlobalImpl()

template<typename SizeT >
void ROOT::Experimental::RField< RNTupleCardinality< SizeT > >::ReadGlobalImpl ( NTupleSize_t  globalIndex,
void *  to 
)
inlinefinalvirtual

Get the number of elements of the collection identified by globalIndex.

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

Definition at line 1520 of file RField.hxx.

◆ ReadInClusterImpl()

template<typename SizeT >
void ROOT::Experimental::RField< RNTupleCardinality< SizeT > >::ReadInClusterImpl ( const RClusterIndex clusterIndex,
void *  to 
)
inlinefinalvirtual

Get the number of elements of the collection identified by clusterIndex.

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

Definition at line 1529 of file RField.hxx.

◆ TypeName()

template<typename SizeT >
static std::string ROOT::Experimental::RField< RNTupleCardinality< SizeT > >::TypeName ( )
inlinestatic

Definition at line 1509 of file RField.hxx.

  • tree/ntuple/v7/inc/ROOT/RField.hxx