ATLAS Offline Software
Loading...
Searching...
No Matches
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 ?
const std::string & name () const
 Access to column name.
const std::string & typeName () const
 Access to OS independent type name.
int options () const
 Access to options.
int offset () const
 Offset of column from this pointer.
int size () const
 Size of a single object within the column.
int nElement () const
 Number of elements.
int typeID () const
 Integer type identifier.
const std::string toString () const
 Create string representation of the type information object.
StatusCode fromString (const std::string &string_rep)
 Load type information object from string representation.

Static Public Member Functions

static const std::string typeName (int typ)
 Access type name by type identifier from RTTI.

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.
std::string m_colName
 Column name.
int m_offset
 Offset from object pointer.
int m_nElem
 For fixed size arrays: number of object elements.
int m_opts
 Column options.
int m_size
 Object size.
int m_type
 Storage Type identifier.

Detailed Description

Definition of a field info structure.

Definition at line 42 of file RNTupleContainer.h.

Member Enumeration Documentation

◆ Options

enum DbColumn::Options
inherited
Enumerator
PRIMARY_KEY 
NOT_NULL 
UNIQUE 
CLUSTERED 
NONCLUSTERED 

Definition at line 22 of file DbColumn.h.

22 {PRIMARY_KEY = 1 << 0,
23 NOT_NULL = 1 << 1,
24 UNIQUE = 1 << 2,
25 CLUSTERED = 1 << 3,
26 NONCLUSTERED= 1 << 4
27 };
@ NOT_NULL
Definition DbColumn.h:23
@ CLUSTERED
Definition DbColumn.h:25
@ NONCLUSTERED
Definition DbColumn.h:26
@ PRIMARY_KEY
Definition DbColumn.h:22

◆ Type

enum 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 29 of file DbColumn.h.

29 {
30 UNKNOWN = 0,
32 CHAR, SHORT, INT, LONG,
37 NATIVE_TYPES = 1000
38 };
@ LONG_NTCHAR
Definition DbColumn.h:34
@ UNKNOWN
Definition DbColumn.h:30
@ LONGLONG
Definition DbColumn.h:36
@ CONTAINED_REF
Definition DbColumn.h:35
@ OBJECT_REF
Definition DbColumn.h:35
@ POINTER
Definition DbColumn.h:36
@ NATIVE_TYPES
Definition DbColumn.h:37
@ LONG_STRING
Definition DbColumn.h:34
@ ULONGLONG
Definition DbColumn.h:36

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()

StatusCode DbColumn::fromString ( const std::string & string_rep)
inherited

Load type information object from string representation.

◆ isValid()

bool DbColumn::isValid ( ) const
inlineinherited

Is it a valid (known) data type ?

Definition at line 83 of file DbColumn.h.

83{ return m_typeName.length()>0;}
std::string m_typeName
OS independent type name.
Definition DbColumn.h:42

◆ name()

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

Access to column name.

Definition at line 85 of file DbColumn.h.

85{ return m_colName; }
std::string m_colName
Column name.
Definition DbColumn.h:44

◆ nElement()

int DbColumn::nElement ( ) const
inlineinherited

Number of elements.

Definition at line 95 of file DbColumn.h.

95{ return m_nElem; }
int m_nElem
For fixed size arrays: number of object elements.
Definition DbColumn.h:48

◆ offset()

int DbColumn::offset ( ) const
inlineinherited

Offset of column from this pointer.

Definition at line 91 of file DbColumn.h.

91{ return m_offset; }
int m_offset
Offset from object pointer.
Definition DbColumn.h:46

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ options()

int DbColumn::options ( ) const
inlineinherited

Access to options.

Definition at line 89 of file DbColumn.h.

89{ return m_opts; }
int m_opts
Column options.
Definition DbColumn.h:50

◆ size()

int DbColumn::size ( ) const
inlineinherited

Size of a single object within the column.

Definition at line 93 of file DbColumn.h.

93{ return m_size; }
int m_size
Object size.
Definition DbColumn.h:52

◆ toString()

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

Create string representation of the type information object.

◆ typeID()

int DbColumn::typeID ( ) const
inlineinherited

Integer type identifier.

Definition at line 97 of file DbColumn.h.

97{ return m_type; }
int m_type
Storage Type identifier.
Definition DbColumn.h:54

◆ typeName() [1/3]

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

Access to OS independent type name.

Definition at line 87 of file DbColumn.h.

87{ return m_typeName; }

◆ typeName() [2/3]

const std::string DbColumn::typeName ( int typ)
staticinherited

Access type name by type identifier from RTTI.

◆ typeName() [3/3]

const std::string RNTupleContainer::FieldDesc::typeName ( )

Member Data Documentation

◆ auxdyn_reader

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

Definition at line 58 of file RNTupleContainer.h.

◆ auxdyn_writer

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

Definition at line 61 of file RNTupleContainer.h.

◆ clazz

TClass* RNTupleContainer::FieldDesc::clazz = nullptr

Definition at line 47 of file RNTupleContainer.h.

◆ fieldname

std::string RNTupleContainer::FieldDesc::fieldname

Definition at line 44 of file RNTupleContainer.h.

◆ m_colName

std::string DbColumn::m_colName
privateinherited

Column name.

Definition at line 44 of file DbColumn.h.

◆ m_nElem

int DbColumn::m_nElem
privateinherited

For fixed size arrays: number of object elements.

Definition at line 48 of file DbColumn.h.

◆ m_offset

int DbColumn::m_offset
privateinherited

Offset from object pointer.

Definition at line 46 of file DbColumn.h.

◆ m_opts

int DbColumn::m_opts
privateinherited

Column options.

Definition at line 50 of file DbColumn.h.

◆ m_size

int DbColumn::m_size
privateinherited

Object size.

Definition at line 52 of file DbColumn.h.

◆ m_type

int DbColumn::m_type
privateinherited

Storage Type identifier.

Definition at line 54 of file DbColumn.h.

◆ m_typeName

std::string DbColumn::m_typeName
privateinherited

OS independent type name.

Definition at line 42 of file DbColumn.h.

◆ object

void* RNTupleContainer::FieldDesc::object = nullptr

Definition at line 48 of file RNTupleContainer.h.

◆ rows_written

size_t RNTupleContainer::FieldDesc::rows_written = 0

Definition at line 55 of file RNTupleContainer.h.

◆ sgkey

std::string RNTupleContainer::FieldDesc::sgkey

Definition at line 46 of file RNTupleContainer.h.

◆ str

std::string RNTupleContainer::FieldDesc::str

Definition at line 51 of file RNTupleContainer.h.

◆ view

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

Definition at line 45 of file RNTupleContainer.h.


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