RNTupleContainer::FieldDesc Struct Reference

Definition of a field info structure. More...

Inheritance diagram for RNTupleContainer::FieldDesc:

Collaboration diagram for RNTupleContainer::FieldDesc:

Public Types
enum	Options {   PRIMARY_KEY = 1 << 0, NOT_NULL = 1 << 1, UNIQUE = 1 << 2, CLUSTERED = 1 << 3,   NONCLUSTERED = 1 << 4 }
enum	Type {   UNKNOWN = 0, UCHAR, USHORT, UINT,   ULONG, CHAR, SHORT, INT,   LONG, BOOL, FLOAT, DOUBLE,   STRING, NTCHAR, LONG_STRING, LONG_NTCHAR,   OBJECT_REF, CONTAINED_REF, TOKEN, BLOB,   ANY, POINTER, LONGLONG, ULONGLONG,   NATIVE_TYPES = 1000 }

Public Member Functions
	FieldDesc (const DbColumn &c)
	FieldDesc (FieldDesc const &other)=delete
	FieldDesc (FieldDesc &&other)=default
	~FieldDesc ()=default
FieldDesc &	operator= (FieldDesc const &other)=delete
FieldDesc &	operator= (FieldDesc &&other)=default
const std::string	typeName ()
bool	isValid () const
	Is it a valid (known) data type ? More...
const std::string &	name () const
	Access to column name. More...
const std::string &	typeName () const
	Access to OS independent type name. More...
int	options () const
	Access to options. More...
int	offset () const
	Offset of column from this pointer. More...
int	size () const
	Size of a single object within the column. More...
int	nElement () const
	Number of elements. More...
int	typeID () const
	Integer type identifier. More...
const std::string	toString () const
	Create string representation of the type information object. More...
DbStatus	fromString (const std::string &string_rep)
	Load type information object from string representation. More...

Static Public Member Functions
static const std::string	typeName (int typ)
	Access type name by type identifier from RTTI. More...

Public Attributes
std::string	fieldname
std::optional< ROOT::RNTupleView< void > >	view
std::string	sgkey
TClass *	clazz = nullptr
void *	object = nullptr
std::string	str
size_t	rows_written = 0
std::unique_ptr< RootAuxDynIO::IRootAuxDynReader >	auxdyn_reader
std::unique_ptr< RootAuxDynIO::IRNTupleAuxDynWriter >	auxdyn_writer

Private Attributes
std::string	m_typeName
	OS independent type name. More...
std::string	m_colName
	Column name. More...
int	m_offset
	Offset from object pointer. More...
int	m_nElem
	For fixed size arrays: number of object elements. More...
int	m_opts
	Column options. More...
int	m_size
	Object size. More...
int	m_type
	Storage Type identifier. More...

Detailed Description

Definition of a field info structure.

Definition at line 46 of file RNTupleContainer.h.

Member Enumeration Documentation

Options

enum pool::DbColumn::Options

inherited

Enumerator
PRIMARY_KEY
NOT_NULL
UNIQUE
CLUSTERED
NONCLUSTERED

Definition at line 37 of file DbColumn.h.

                 {PRIMARY_KEY = 1 << 0, 
                  NOT_NULL    = 1 << 1,
                  UNIQUE      = 1 << 2,
                  CLUSTERED   = 1 << 3,
                  NONCLUSTERED= 1 << 4
    };

Type

enum pool::DbColumn::Type

inherited

Enumerator
UNKNOWN
UCHAR
USHORT
UINT
ULONG
CHAR
SHORT
INT
LONG
BOOL
FLOAT
DOUBLE
STRING
NTCHAR
LONG_STRING
LONG_NTCHAR
OBJECT_REF
CONTAINED_REF
TOKEN
BLOB
ANY
POINTER
LONGLONG
ULONGLONG
NATIVE_TYPES

Definition at line 44 of file DbColumn.h.

               {
          UNKNOWN = 0,        
          UCHAR,        USHORT,        UINT,        ULONG,
          CHAR,         SHORT,         INT,         LONG,
          BOOL,         FLOAT,         DOUBLE,
          STRING,       NTCHAR,        LONG_STRING, LONG_NTCHAR,
          OBJECT_REF,   CONTAINED_REF, TOKEN,       BLOB, 
          ANY, POINTER, LONGLONG,      ULONGLONG,
          NATIVE_TYPES = 1000
    };

Constructor & Destructor Documentation

FieldDesc() [1/3]

RNTupleContainer::FieldDesc::FieldDesc ( const DbColumn &  c )

explicit

FieldDesc() [2/3]

RNTupleContainer::FieldDesc::FieldDesc ( FieldDesc const &  other )

delete

FieldDesc() [3/3]

RNTupleContainer::FieldDesc::FieldDesc ( FieldDesc &&  other )

default

~FieldDesc()

RNTupleContainer::FieldDesc::~FieldDesc ( )

default

Member Function Documentation

fromString()

DbStatus pool::DbColumn::fromString ( const std::string &  string_rep )

inherited

Load type information object from string representation.

isValid()

bool pool::DbColumn::isValid ( ) const

inlineinherited

Is it a valid (known) data type ?

Definition at line 98 of file DbColumn.h.

{ return m_typeName.length()>0;}

name()

const std::string& pool::DbColumn::name ( ) const

inlineinherited

Access to column name.

Definition at line 100 of file DbColumn.h.

{ return m_colName;            }

nElement()

int pool::DbColumn::nElement ( ) const

inlineinherited

Number of elements.

Definition at line 110 of file DbColumn.h.

{ return m_nElem;              }

offset()

int pool::DbColumn::offset ( ) const

inlineinherited

Offset of column from this pointer.

Definition at line 106 of file DbColumn.h.

{ return m_offset;             }

operator=() [1/2]

FieldDesc& RNTupleContainer::FieldDesc::operator= ( FieldDesc &&  other )

default

operator=() [2/2]

FieldDesc& RNTupleContainer::FieldDesc::operator= ( FieldDesc const &  other )

delete

options()

int pool::DbColumn::options ( ) const

inlineinherited

Access to options.

Definition at line 104 of file DbColumn.h.

{ return m_opts;               }

size()

int pool::DbColumn::size ( ) const

inlineinherited

Size of a single object within the column.

Definition at line 108 of file DbColumn.h.

{ return m_size;               }

toString()

const std::string pool::DbColumn::toString ( ) const

inherited

Create string representation of the type information object.

typeID()

int pool::DbColumn::typeID ( ) const

inlineinherited

Integer type identifier.

Definition at line 112 of file DbColumn.h.

{ return m_type;               }

typeName() [1/3]

const std::string RNTupleContainer::FieldDesc::typeName

(

)

typeName() [2/3]

const std::string& pool::DbColumn::typeName ( ) const

inlineinherited

Access to OS independent type name.

Definition at line 102 of file DbColumn.h.

{ return m_typeName;           }

typeName() [3/3]

static const std::string pool::DbColumn::typeName ( int  typ )

staticinherited

Access type name by type identifier from RTTI.

Member Data Documentation

auxdyn_reader

std::unique_ptr<RootAuxDynIO::IRootAuxDynReader> RNTupleContainer::FieldDesc::auxdyn_reader

Definition at line 62 of file RNTupleContainer.h.

auxdyn_writer

std::unique_ptr<RootAuxDynIO::IRNTupleAuxDynWriter> RNTupleContainer::FieldDesc::auxdyn_writer

Definition at line 65 of file RNTupleContainer.h.

clazz

TClass* RNTupleContainer::FieldDesc::clazz = nullptr

Definition at line 51 of file RNTupleContainer.h.

fieldname

std::string RNTupleContainer::FieldDesc::fieldname

Definition at line 48 of file RNTupleContainer.h.

m_colName

std::string pool::DbColumn::m_colName

privateinherited

Column name.

Definition at line 59 of file DbColumn.h.

m_nElem

int pool::DbColumn::m_nElem

privateinherited

For fixed size arrays: number of object elements.

Definition at line 63 of file DbColumn.h.

m_offset

int pool::DbColumn::m_offset

privateinherited

Offset from object pointer.

Definition at line 61 of file DbColumn.h.

m_opts

int pool::DbColumn::m_opts

privateinherited

Column options.

Definition at line 65 of file DbColumn.h.

m_size

int pool::DbColumn::m_size

privateinherited

Object size.

Definition at line 67 of file DbColumn.h.

m_type

int pool::DbColumn::m_type

privateinherited

Storage Type identifier.

Definition at line 69 of file DbColumn.h.

m_typeName

std::string pool::DbColumn::m_typeName

privateinherited

OS independent type name.

Definition at line 57 of file DbColumn.h.

object

void* RNTupleContainer::FieldDesc::object = nullptr

Definition at line 52 of file RNTupleContainer.h.

rows_written

size_t RNTupleContainer::FieldDesc::rows_written = 0

Definition at line 59 of file RNTupleContainer.h.

sgkey

std::string RNTupleContainer::FieldDesc::sgkey

Definition at line 50 of file RNTupleContainer.h.

str

std::string RNTupleContainer::FieldDesc::str

Definition at line 55 of file RNTupleContainer.h.

view

std::optional< ROOT::RNTupleView<void> > RNTupleContainer::FieldDesc::view

Definition at line 49 of file RNTupleContainer.h.

---

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

• RNTupleContainer.h