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

The field for a class representing a collection of elements via TVirtualCollectionProxy.

Objects of such type behave as collections that can be accessed through the corresponding member functions in TVirtualCollectionProxy. For STL collections, these proxies are provided. Custom classes need to implement the corresponding member functions in TVirtualCollectionProxy. At a bare minimum, the user is required to provide an implementation for the following functions in TVirtualCollectionProxy: HasPointers(), GetProperties(), GetValueClass(), GetType(), PushProxy(), PopProxy(), GetFunctionCreateIterators(), GetFunctionNext(), and GetFunctionDeleteTwoIterators().

The collection proxy for a given class can be set via TClass::CopyCollectionProxy().

Definition at line 899 of file RField.hxx.

Classes

class  RCollectionIterableOnce
 Allows for iterating over the elements of a proxied collection. More...
 
class  RProxiedCollectionDeleter
 

Public Member Functions

 RProxiedCollectionField (RProxiedCollectionField &&other)=default
 
 RProxiedCollectionField (std::string_view fieldName, std::string_view typeName)
 
 ~RProxiedCollectionField () override=default
 
void AcceptVisitor (Detail::RFieldVisitor &visitor) const override
 
size_t GetAlignment () const override
 As a rule of thumb, the alignment is equal to the size of the type.
 
void GetCollectionInfo (NTupleSize_t globalIndex, RClusterIndex *collectionStart, ClusterSize_t *size) const
 
void GetCollectionInfo (RClusterIndex clusterIndex, RClusterIndex *collectionStart, ClusterSize_t *size) const
 
size_t GetValueSize () const override
 The number of bytes taken by a value of the appropriate type.
 
RProxiedCollectionFieldoperator= (RProxiedCollectionField &&other)=default
 
std::vector< RValueSplitValue (const RValue &value) const override
 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<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 RFieldBase::RCreateObjectDeleter< void >::deleter > CreateObject () const
 
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 ()
 
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.
 
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 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
 
std::string GetTypeAlias () 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 SetColumnRepresentative (const ColumnRepresentation_t &representative)
 Fixes a column representative.
 
void SetDescription (std::string_view description)
 
void SetOnDiskId (DescriptorId_t id)
 

Protected Member Functions

 RProxiedCollectionField (std::string_view fieldName, std::string_view typeName, std::unique_ptr< RFieldBase > itemField)
 Constructor used when the value type of the collection is known in advance, e.g. in RSetField.
 
 RProxiedCollectionField (std::string_view fieldName, std::string_view typeName, TClass *classp)
 Constructor used when the value type of the collection is not known in advance, i.e.
 
std::size_t AppendImpl (const void *from) override
 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 CommitClusterImpl () final
 
void ConstructValue (void *where) const override
 Constructs value in a given location of size at least GetValueSize(). Called by the base class' CreateValue().
 
void GenerateColumnsImpl () final
 Implementations in derived classes should create the backing columns corresponsing to the field type for writing.
 
void GenerateColumnsImpl (const RNTupleDescriptor &desc) final
 Implementations in derived classes should create the backing columns corresponsing to the field type for reading.
 
const RColumnRepresentationsGetColumnRepresentations () const final
 Implementations in derived classes should return a static RColumnRepresentations object.
 
std::unique_ptr< RDeleterGetDeleter () const override
 
void ReadGlobalImpl (NTupleSize_t globalIndex, void *to) override
 
- 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.
 
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 (NTupleSize_t globalIndex, void *to)
 Populate a single value with data from the field.
 
void Read (RClusterIndex clusterIndex, void *to)
 
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.
 
virtual void ReadInClusterImpl (RClusterIndex clusterIndex, void *to)
 
void RemoveReadCallback (size_t idx)
 

Protected Attributes

Int_t fCollectionType
 
RCollectionIterableOnce::RIteratorFuncs fIFuncsRead
 Two sets of functions to operate on iterators, to be used depending on the access type.
 
RCollectionIterableOnce::RIteratorFuncs fIFuncsWrite
 
std::size_t fItemSize
 
ClusterSize_t fNWritten
 
Int_t fProperties
 
std::shared_ptr< TVirtualCollectionProxyfProxy
 The collection proxy is needed by the deleters and thus defined as a shared pointer.
 
- Protected Attributes inherited from ROOT::Experimental::RFieldBase
const ColumnRepresentation_tfColumnRepresentative = nullptr
 Points into the static vector GetColumnRepresentations().GetSerializationTypes() when SetColumnRepresentative is called.
 
std::vector< std::unique_ptr< Internal::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.
 
Internal::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.
 

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 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.hxx>

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

Constructor & Destructor Documentation

◆ RProxiedCollectionField() [1/4]

ROOT::Experimental::RProxiedCollectionField::RProxiedCollectionField ( std::string_view  fieldName,
std::string_view  typeName,
TClass classp 
)
protected

Constructor used when the value type of the collection is not known in advance, i.e.

in the case of custom collections.

Definition at line 2096 of file RField.cxx.

◆ RProxiedCollectionField() [2/4]

ROOT::Experimental::RProxiedCollectionField::RProxiedCollectionField ( std::string_view  fieldName,
std::string_view  typeName,
std::unique_ptr< RFieldBase itemField 
)
protected

Constructor used when the value type of the collection is known in advance, e.g. in RSetField.

Definition at line 2119 of file RField.cxx.

◆ RProxiedCollectionField() [3/4]

ROOT::Experimental::RProxiedCollectionField::RProxiedCollectionField ( std::string_view  fieldName,
std::string_view  typeName 
)

Definition at line 2128 of file RField.cxx.

◆ RProxiedCollectionField() [4/4]

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

◆ ~RProxiedCollectionField()

ROOT::Experimental::RProxiedCollectionField::~RProxiedCollectionField ( )
overridedefault

Member Function Documentation

◆ AcceptVisitor()

void ROOT::Experimental::RProxiedCollectionField::AcceptVisitor ( Detail::RFieldVisitor visitor) const
overridevirtual

Reimplemented from ROOT::Experimental::RFieldBase.

Definition at line 2272 of file RField.cxx.

◆ AppendImpl()

std::size_t ROOT::Experimental::RProxiedCollectionField::AppendImpl ( const void *  from)
overrideprotectedvirtual

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 2177 of file RField.cxx.

◆ CloneImpl()

std::unique_ptr< ROOT::Experimental::RFieldBase > ROOT::Experimental::RProxiedCollectionField::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::RSetField.

Definition at line 2170 of file RField.cxx.

◆ CommitClusterImpl()

void ROOT::Experimental::RProxiedCollectionField::CommitClusterImpl ( )
inlinefinalprotectedvirtual

Reimplemented from ROOT::Experimental::RFieldBase.

Definition at line 1018 of file RField.hxx.

◆ ConstructValue()

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

Definition at line 2232 of file RField.cxx.

◆ GenerateColumnsImpl() [1/2]

void ROOT::Experimental::RProxiedCollectionField::GenerateColumnsImpl ( )
finalprotectedvirtual

Implementations in derived classes should create the backing columns corresponsing to the field type for writing.

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

Reimplemented from ROOT::Experimental::RFieldBase.

Definition at line 2221 of file RField.cxx.

◆ GenerateColumnsImpl() [2/2]

void ROOT::Experimental::RProxiedCollectionField::GenerateColumnsImpl ( const RNTupleDescriptor )
finalprotectedvirtual

Implementations in derived classes should create the backing columns corresponsing to the field type for reading.

The default implementation does not attach any columns to the field. The method should check, using the page source and fOnDiskId, if the column types match and throw if they don't.

Reimplemented from ROOT::Experimental::RFieldBase.

Definition at line 2226 of file RField.cxx.

◆ GetAlignment()

size_t ROOT::Experimental::RProxiedCollectionField::GetAlignment ( ) const
inlineoverridevirtual

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.

Reimplemented in ROOT::Experimental::RSetField.

Definition at line 1028 of file RField.hxx.

◆ GetCollectionInfo() [1/2]

void ROOT::Experimental::RProxiedCollectionField::GetCollectionInfo ( NTupleSize_t  globalIndex,
RClusterIndex collectionStart,
ClusterSize_t size 
) const
inline

Definition at line 1030 of file RField.hxx.

◆ GetCollectionInfo() [2/2]

void ROOT::Experimental::RProxiedCollectionField::GetCollectionInfo ( RClusterIndex  clusterIndex,
RClusterIndex collectionStart,
ClusterSize_t size 
) const
inline

Definition at line 1034 of file RField.hxx.

◆ GetColumnRepresentations()

const ROOT::Experimental::RFieldBase::RColumnRepresentations & ROOT::Experimental::RProxiedCollectionField::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::RFieldBase.

Definition at line 2213 of file RField.cxx.

◆ GetDeleter()

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

Reimplemented from ROOT::Experimental::RFieldBase.

Definition at line 2238 of file RField.cxx.

◆ GetValueSize()

size_t ROOT::Experimental::RProxiedCollectionField::GetValueSize ( ) const
inlineoverridevirtual

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

Implements ROOT::Experimental::RFieldBase.

Definition at line 1027 of file RField.hxx.

◆ operator=()

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

◆ ReadGlobalImpl()

void ROOT::Experimental::RProxiedCollectionField::ReadGlobalImpl ( NTupleSize_t  globalIndex,
void *  to 
)
overrideprotectedvirtual

Reimplemented from ROOT::Experimental::RFieldBase.

Definition at line 2193 of file RField.cxx.

◆ SplitValue()

std::vector< ROOT::Experimental::RFieldBase::RValue > ROOT::Experimental::RProxiedCollectionField::SplitValue ( const RValue value) const
overridevirtual

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 2260 of file RField.cxx.

Member Data Documentation

◆ fCollectionType

Int_t ROOT::Experimental::RProxiedCollectionField::fCollectionType
protected

Definition at line 991 of file RField.hxx.

◆ fIFuncsRead

RCollectionIterableOnce::RIteratorFuncs ROOT::Experimental::RProxiedCollectionField::fIFuncsRead
protected

Two sets of functions to operate on iterators, to be used depending on the access type.

The direction preserves the meaning from TVirtualCollectionProxy, i.e. read from disk / write to disk, respectively

Definition at line 994 of file RField.hxx.

◆ fIFuncsWrite

RCollectionIterableOnce::RIteratorFuncs ROOT::Experimental::RProxiedCollectionField::fIFuncsWrite
protected

Definition at line 995 of file RField.hxx.

◆ fItemSize

std::size_t ROOT::Experimental::RProxiedCollectionField::fItemSize
protected

Definition at line 996 of file RField.hxx.

◆ fNWritten

ClusterSize_t ROOT::Experimental::RProxiedCollectionField::fNWritten
protected

Definition at line 997 of file RField.hxx.

◆ fProperties

Int_t ROOT::Experimental::RProxiedCollectionField::fProperties
protected

Definition at line 990 of file RField.hxx.

◆ fProxy

std::shared_ptr<TVirtualCollectionProxy> ROOT::Experimental::RProxiedCollectionField::fProxy
protected

The collection proxy is needed by the deleters and thus defined as a shared pointer.

Definition at line 989 of file RField.hxx.

Libraries for ROOT::Experimental::RProxiedCollectionField:

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