Logo ROOT  
Reference Guide
ROOT::Experimental::RField< ClusterSize_t > Class Reference

Template specializations for concrete C++ types.

Definition at line 889 of file RField.hxx.

Public Member Functions

 RField (RField &&other)=default
 
 RField (std::string_view name)
 
 ~RField () override=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...
 
ROOT::Experimental::Detail::RFieldValue GenerateValue (void *where) final
 Generates a tree value in a given location of size at least GetValueSize(). More...
 
template<typename... ArgsT>
ROOT::Experimental::Detail::RFieldValue GenerateValue (void *where, ArgsT &&... args)
 
void GetCollectionInfo (const RClusterIndex &clusterIndex, RClusterIndex *collectionStart, ClusterSize_t *size)
 
void GetCollectionInfo (NTupleSize_t globalIndex, RClusterIndex *collectionStart, ClusterSize_t *size)
 Special help for offset fields. More...
 
size_t GetValueSize () const final
 The number of bytes taken by a value of the appropriate type. More...
 
ClusterSize_tMap (const RClusterIndex &clusterIndex)
 
ClusterSize_tMap (NTupleSize_t globalIndex)
 
ClusterSize_tMapV (const RClusterIndex &clusterIndex, NTupleSize_t &nItems)
 
ClusterSize_tMapV (NTupleSize_t globalIndex, NTupleSize_t &nItems)
 
RFieldoperator= (RField &&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. 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...
 
const ColumnRepresentation_tGetColumnRepresentative () const
 Returns the fColumnRepresentative pointee or, if unset, the field's default representative. 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
 
std::uint32_t GetOnDiskTypeVersion () const
 Return the C++ type version stored in the field descriptor; only valid after a call to ConnectPageSource() More...
 
RFieldBaseGetParent () const
 
std::string GetQualifiedFieldName () const
 Returns the field name and parent field names separated by dots ("grandparent.parent.child") More...
 
ENTupleStructure GetStructure () const
 
std::vector< RFieldBase * > GetSubFields () const
 
int GetTraits () 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 HasReadCallbacks () const
 
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 SetColumnRepresentative (const ColumnRepresentation_t &representative)
 Fixes a column representative. 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...
 

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

Protected Member Functions

std::unique_ptr< Detail::RFieldBaseCloneImpl (std::string_view newName) const final
 Called by Clone(), which additionally copies the on-disk ID. More...
 
void GenerateColumnsImpl () final
 Creates the backing columns corresponsing to the field type for writing. More...
 
void GenerateColumnsImpl (const RNTupleDescriptor &desc) final
 Creates the backing columns corresponsing to the field type for reading. More...
 
const RColumnRepresentationsGetColumnRepresentations () const final
 Implementations in derived classes should return a static RColumnRepresentations object. More...
 
- 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. More...
 
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...
 
const ColumnRepresentation_tEnsureCompatibleColumnTypes (const RNTupleDescriptor &desc) const
 Returns the on-disk column types found in the provided descriptor for fOnDiskId. 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 const RColumnRepresentationsGetColumnRepresentations () const
 Implementations in derived classes should return a static RColumnRepresentations object. More...
 
virtual void OnConnectPageSource ()
 Called by ConnectPageSource() only once connected; derived classes may override this as appropriate. More...
 
virtual void ReadGlobalImpl (NTupleSize_t globalIndex, RFieldValue *value)
 
virtual void ReadInClusterImpl (const RClusterIndex &clusterIndex, RFieldValue *value)
 
void RemoveReadCallback (size_t idx)
 

Additional Inherited Members

- Public Types inherited from ROOT::Experimental::Detail::RFieldBase
using ColumnRepresentation_t = std::vector< EColumnType >
 
- 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. More...
 
static constexpr int kTraitTriviallyConstructible = 0x01
 No constructor needs to be called, i.e. More...
 
static constexpr int kTraitTriviallyDestructible = 0x02
 The type is cleaned up just by freeing its memory. I.e. DestroyValue() is a no-op. More...
 
static constexpr int kTraitTrivialType = kTraitTriviallyConstructible | kTraitTriviallyDestructible
 Shorthand for types that are both trivially constructible and destructible. More...
 
- Protected Attributes inherited from ROOT::Experimental::Detail::RFieldBase
const ColumnRepresentation_tfColumnRepresentative = nullptr
 Points into the static vector GetColumnRepresentations().GetSerializationTypes() when SetColumnRepresentative is called. More...
 
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...
 
std::uint32_t fOnDiskTypeVersion = kInvalidTypeVersion
 C++ type version cached from the descriptor after a call to ConnectPageSource() More...
 
RFieldBasefParent
 Sub fields point to their mother field. More...
 
RColumnfPrincipalColumn
 Points into fColumns. More...
 
std::vector< ReadCallback_tfReadCallbacks
 List of functions to be called after reading a value. More...
 
std::vector< std::unique_ptr< RFieldBase > > fSubFields
 Collections and classes own sub fields. More...
 
int fTraits = 0
 Properties of the type that allow for optimizations of collections of that type. More...
 

#include <ROOT/RField.hxx>

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

Constructor & Destructor Documentation

◆ RField() [1/2]

Definition at line 901 of file RField.hxx.

◆ RField() [2/2]

◆ ~RField()

Member Function Documentation

◆ AcceptVisitor()

void ROOT::Experimental::RField< ClusterSize_t >::AcceptVisitor ( Detail::RFieldVisitor visitor) const
finalvirtual

◆ CaptureValue()

Detail::RFieldValue ROOT::Experimental::RField< ClusterSize_t >::CaptureValue ( void *  where)
inlinefinalvirtual

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

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

Definition at line 932 of file RField.hxx.

◆ CloneImpl()

std::unique_ptr< Detail::RFieldBase > ROOT::Experimental::RField< ClusterSize_t >::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 891 of file RField.hxx.

◆ GenerateColumnsImpl() [1/2]

void ROOT::Experimental::RField< ClusterSize_t >::GenerateColumnsImpl ( )
finalprotectedvirtual

Creates the backing columns corresponsing to the field type for writing.

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

◆ GenerateColumnsImpl() [2/2]

void ROOT::Experimental::RField< ClusterSize_t >::GenerateColumnsImpl ( const RNTupleDescriptor desc)
finalprotectedvirtual

Creates the backing columns corresponsing to the field type for reading.

The method should to check, using the page source and fOnDiskId, if the column types match and throw if they don't.

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

◆ GenerateValue() [1/2]

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

◆ GenerateValue() [2/2]

template<typename... ArgsT>
ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RField< ClusterSize_t >::GenerateValue ( void *  where,
ArgsT &&...  args 
)
inline

Definition at line 925 of file RField.hxx.

◆ GetCollectionInfo() [1/2]

void ROOT::Experimental::RField< ClusterSize_t >::GetCollectionInfo ( const RClusterIndex clusterIndex,
RClusterIndex collectionStart,
ClusterSize_t size 
)
inline

Definition at line 942 of file RField.hxx.

◆ GetCollectionInfo() [2/2]

void ROOT::Experimental::RField< ClusterSize_t >::GetCollectionInfo ( NTupleSize_t  globalIndex,
RClusterIndex collectionStart,
ClusterSize_t size 
)
inline

Special help for offset fields.

Definition at line 939 of file RField.hxx.

◆ GetColumnRepresentations()

const RColumnRepresentations & ROOT::Experimental::RField< ClusterSize_t >::GetColumnRepresentations ( ) const
finalprotectedvirtual

Implementations in derived classes should return a static RColumnRepresentations object.

The default implementation does not attach any columns to the field.

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

◆ GetValueSize()

size_t ROOT::Experimental::RField< ClusterSize_t >::GetValueSize ( ) const
inlinefinalvirtual

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

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

Definition at line 936 of file RField.hxx.

◆ Map() [1/2]

ClusterSize_t * ROOT::Experimental::RField< ClusterSize_t >::Map ( const RClusterIndex clusterIndex)
inline

Definition at line 913 of file RField.hxx.

◆ Map() [2/2]

Definition at line 910 of file RField.hxx.

◆ MapV() [1/2]

ClusterSize_t * ROOT::Experimental::RField< ClusterSize_t >::MapV ( const RClusterIndex clusterIndex,
NTupleSize_t nItems 
)
inline

Definition at line 919 of file RField.hxx.

◆ MapV() [2/2]

ClusterSize_t * ROOT::Experimental::RField< ClusterSize_t >::MapV ( NTupleSize_t  globalIndex,
NTupleSize_t nItems 
)
inline

Definition at line 916 of file RField.hxx.

◆ operator=()

RField & ROOT::Experimental::RField< ClusterSize_t >::operator= ( RField< ClusterSize_t > &&  other)
default

◆ TypeName()

static std::string ROOT::Experimental::RField< ClusterSize_t >::TypeName ( )
inlinestatic

Definition at line 900 of file RField.hxx.


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