An artificial field that transforms an RNTuple column that contains the offset of collections into collection sizes.
It is only used for reading, e.g. as projected field or as an artificial field that provides the "number of" RDF columns for collections (e.g. R_rdf_sizeof_jets
for a collection named jets
). It is used in the templated RField<RNTupleCardinality<SizeT>> form, which represents the collection sizes either as 32bit unsigned int (std::uint32_t) or as 64bit unsigned int (std::uint64_t).
Definition at line 1422 of file RField.hxx.
|
| 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 RColumnRepresentations & | GetColumnRepresentations () const final |
| Implementations in derived classes should return a static RColumnRepresentations object.
|
|
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 std::unique_ptr< RFieldBase > | CloneImpl (std::string_view newName) const =0 |
| Called by Clone(), which additionally copies the on-disk ID.
|
|
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_t & | EnsureCompatibleColumnTypes (const RNTupleDescriptor &desc) const |
| Returns the on-disk column types found in the provided descriptor for fOnDiskId.
|
|
virtual void | GenerateValue (void *where) const =0 |
| Constructs value in a given location of size at least GetValueSize(). Called by the base class' GenerateValue().
|
|
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.
|
|
virtual std::size_t | ReadBulkImpl (const RBulkSpec &bulkSpec) |
| General implementation of bulk read.
|
|
virtual void | ReadGlobalImpl (NTupleSize_t globalIndex, void *to) |
|
virtual void | ReadInClusterImpl (const RClusterIndex &clusterIndex, void *to) |
|
void | RemoveReadCallback (size_t idx) |
|
|
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 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 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 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 RColumn * | GetPrincipalColumnOf (const RFieldBase &other) |
| Fields may need direct access to the principal column of their sub fields, e.g. in RRVecField::ReadBulk.
|
|
const ColumnRepresentation_t * | fColumnRepresentative = 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()
|
|
RFieldBase * | fParent |
| Sub fields point to their mother field.
|
|
RColumn * | fPrincipalColumn |
| Points into fColumns.
|
|
std::vector< ReadCallback_t > | fReadCallbacks |
| 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.
|
|