ATLAS Offline Software
Toggle main menu visibility
Loading...
Searching...
No Matches
Database
APR
StorageSvc
StorageSvc
DbColumn.h
Go to the documentation of this file.
1
/*
2
Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
3
*/
4
#ifndef STORAGESVC_DBCOLUMN_H
5
#define STORAGESVC_DBCOLUMN_H 1
6
7
// Framework include files
8
#include "GaudiKernel/StatusCode.h"
9
// STL include files
10
#include <typeinfo>
11
#include <string>
12
20
class
DbColumn
{
21
public
:
22
enum
Options
{
PRIMARY_KEY
= 1 << 0,
23
NOT_NULL
= 1 << 1,
24
UNIQUE
= 1 << 2,
25
CLUSTERED
= 1 << 3,
26
NONCLUSTERED
= 1 << 4
27
};
28
// Accepted Data type definitions
29
enum
Type
{
30
UNKNOWN
= 0,
31
UCHAR
,
USHORT
,
UINT
,
ULONG
,
32
CHAR
,
SHORT
,
INT
,
LONG
,
33
BOOL
,
FLOAT
,
DOUBLE
,
34
STRING
,
NTCHAR
,
LONG_STRING
,
LONG_NTCHAR
,
35
OBJECT_REF
,
CONTAINED_REF
,
TOKEN
,
BLOB
,
36
ANY
,
POINTER
,
LONGLONG
,
ULONGLONG
,
37
NATIVE_TYPES
= 1000
38
};
39
private
:
40
friend
class
DbTypeInfo
;
42
std::string
m_typeName
;
44
std::string
m_colName
;
46
int
m_offset
;
48
int
m_nElem
;
50
int
m_opts
;
52
int
m_size
;
54
int
m_type
;
57
DbColumn
()
58
:
m_offset
(0),
59
m_nElem
(0),
60
m_opts
(0),
61
m_size
(0),
62
m_type
(0)
63
{}
64
public
:
66
DbColumn
(
const
DbColumn
&) =
default
;
67
DbColumn
&
operator=
(
const
DbColumn
&) =
default
;
69
DbColumn
(
const
std::string& column_name,
70
int
object_type,
71
int
object_offset,
72
int
object_size,
73
int
number_of_elements=1,
74
int
opt=0);
76
DbColumn
(
const
std::string& nam,
77
const
std::string& clazz,
78
int
object_type,
79
int
object_offset);
81
virtual
~DbColumn
() { }
83
bool
isValid
()
const
{
return
m_typeName
.length()>0;}
85
const
std::string&
name
()
const
{
return
m_colName
; }
87
const
std::string&
typeName
()
const
{
return
m_typeName
; }
89
int
options
()
const
{
return
m_opts
; }
91
int
offset
()
const
{
return
m_offset
; }
93
int
size
()
const
{
return
m_size
; }
95
int
nElement
()
const
{
return
m_nElem
; }
97
int
typeID
()
const
{
return
m_type
; }
99
const
std::string
toString
()
const
;
101
StatusCode
fromString
(
const
std::string& string_rep);
103
static
const
std::string
typeName
(
int
typ);
104
};
105
106
#endif
DbColumn::~DbColumn
virtual ~DbColumn()
Standard destructor.
Definition
DbColumn.h:81
DbColumn::m_offset
int m_offset
Offset from object pointer.
Definition
DbColumn.h:46
DbColumn::DbColumn
DbColumn(const std::string &column_name, int object_type, int object_offset, int object_size, int number_of_elements=1, int opt=0)
Initializing constructor for fixed size arrays.
DbColumn::nElement
int nElement() const
Number of elements.
Definition
DbColumn.h:95
DbColumn::Options
Options
Definition
DbColumn.h:22
DbColumn::NOT_NULL
@ NOT_NULL
Definition
DbColumn.h:23
DbColumn::UNIQUE
@ UNIQUE
Definition
DbColumn.h:24
DbColumn::CLUSTERED
@ CLUSTERED
Definition
DbColumn.h:25
DbColumn::NONCLUSTERED
@ NONCLUSTERED
Definition
DbColumn.h:26
DbColumn::PRIMARY_KEY
@ PRIMARY_KEY
Definition
DbColumn.h:22
DbColumn::m_nElem
int m_nElem
For fixed size arrays: number of object elements.
Definition
DbColumn.h:48
DbColumn::typeName
const std::string & typeName() const
Access to OS independent type name.
Definition
DbColumn.h:87
DbColumn::toString
const std::string toString() const
Create string representation of the type information object.
DbColumn::Type
Type
Definition
DbColumn.h:29
DbColumn::NTCHAR
@ NTCHAR
Definition
DbColumn.h:34
DbColumn::LONG_NTCHAR
@ LONG_NTCHAR
Definition
DbColumn.h:34
DbColumn::UINT
@ UINT
Definition
DbColumn.h:31
DbColumn::UNKNOWN
@ UNKNOWN
Definition
DbColumn.h:30
DbColumn::LONG
@ LONG
Definition
DbColumn.h:32
DbColumn::UCHAR
@ UCHAR
Definition
DbColumn.h:31
DbColumn::TOKEN
@ TOKEN
Definition
DbColumn.h:35
DbColumn::LONGLONG
@ LONGLONG
Definition
DbColumn.h:36
DbColumn::USHORT
@ USHORT
Definition
DbColumn.h:31
DbColumn::INT
@ INT
Definition
DbColumn.h:32
DbColumn::CONTAINED_REF
@ CONTAINED_REF
Definition
DbColumn.h:35
DbColumn::BOOL
@ BOOL
Definition
DbColumn.h:33
DbColumn::CHAR
@ CHAR
Definition
DbColumn.h:32
DbColumn::OBJECT_REF
@ OBJECT_REF
Definition
DbColumn.h:35
DbColumn::FLOAT
@ FLOAT
Definition
DbColumn.h:33
DbColumn::POINTER
@ POINTER
Definition
DbColumn.h:36
DbColumn::NATIVE_TYPES
@ NATIVE_TYPES
Definition
DbColumn.h:37
DbColumn::STRING
@ STRING
Definition
DbColumn.h:34
DbColumn::BLOB
@ BLOB
Definition
DbColumn.h:35
DbColumn::ULONG
@ ULONG
Definition
DbColumn.h:31
DbColumn::ANY
@ ANY
Definition
DbColumn.h:36
DbColumn::DOUBLE
@ DOUBLE
Definition
DbColumn.h:33
DbColumn::LONG_STRING
@ LONG_STRING
Definition
DbColumn.h:34
DbColumn::SHORT
@ SHORT
Definition
DbColumn.h:32
DbColumn::ULONGLONG
@ ULONGLONG
Definition
DbColumn.h:36
DbColumn::options
int options() const
Access to options.
Definition
DbColumn.h:89
DbColumn::m_type
int m_type
Storage Type identifier.
Definition
DbColumn.h:54
DbColumn::m_colName
std::string m_colName
Column name.
Definition
DbColumn.h:44
DbColumn::fromString
StatusCode fromString(const std::string &string_rep)
Load type information object from string representation.
DbColumn::m_typeName
std::string m_typeName
OS independent type name.
Definition
DbColumn.h:42
DbColumn::DbColumn
DbColumn()
Cache class information (if available) Do not allow unwanted instantiations by users.
Definition
DbColumn.h:57
DbColumn::m_opts
int m_opts
Column options.
Definition
DbColumn.h:50
DbColumn::m_size
int m_size
Object size.
Definition
DbColumn.h:52
DbColumn::name
const std::string & name() const
Access to column name.
Definition
DbColumn.h:85
DbColumn::isValid
bool isValid() const
Is it a valid (known) data type ?
Definition
DbColumn.h:83
DbColumn::DbColumn
DbColumn(const DbColumn &)=default
Default copy constructor.
DbColumn::typeID
int typeID() const
Integer type identifier.
Definition
DbColumn.h:97
DbColumn::DbTypeInfo
friend class DbTypeInfo
Definition
DbColumn.h:40
DbColumn::typeName
static const std::string typeName(int typ)
Access type name by type identifier from RTTI.
DbColumn::offset
int offset() const
Offset of column from this pointer.
Definition
DbColumn.h:91
DbColumn::operator=
DbColumn & operator=(const DbColumn &)=default
DbColumn::size
int size() const
Size of a single object within the column.
Definition
DbColumn.h:93
DbColumn::DbColumn
DbColumn(const std::string &nam, const std::string &clazz, int object_type, int object_offset)
Initializing constructor for composite columns.
Generated on
for ATLAS Offline Software by
1.17.0