DbColumn.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
//====================================================================
//  DbColumn class definitions
//--------------------------------------------------------------------
//
//  Package    : StorageSvc  (The POOL project)
//  @author      M.Frank
//====================================================================
#ifndef POOL_DBCOLUMN_H
#define POOL_DBCOLUMN_H 1
 
// Framework include files
#include "GaudiKernel/StatusCode.h"
// STL include files
#include <typeinfo>
#include <string>
 
/*
 *  POOL namespace declaration
 */
namespace pool  {

  class DbColumn    {
  public:
    enum Options {PRIMARY_KEY = 1 << 0, 
                  NOT_NULL    = 1 << 1,
                  UNIQUE      = 1 << 2,
                  CLUSTERED   = 1 << 3,
                  NONCLUSTERED= 1 << 4
    };
    // Accepted Data type definitions
    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
    };
  private:
    friend class DbTypeInfo;
    std::string           m_typeName;
    std::string           m_colName;
    int                   m_offset;
    int                   m_nElem;
    int                   m_opts;
    int                   m_size;
    int                   m_type;
    DbColumn()
      : m_offset(0),
        m_nElem(0),
        m_opts(0),
        m_size(0),
        m_type(0)
    {}
  public:
    DbColumn(const DbColumn&) = default;
    DbColumn& operator=(const DbColumn&) = default;
    DbColumn(  const std::string& column_name, 
               int   object_type,
               int   object_offset,
               int   object_size,
               int   number_of_elements=1,
               int   opt=0);
    DbColumn(  const std::string& nam,
               const std::string& clazz,
               int   object_type,
               int   object_offset);
    virtual ~DbColumn()                 {                              }
    bool isValid()    const             { return m_typeName.length()>0;}
    const std::string& name() const     { return m_colName;            }
    const std::string& typeName() const { return m_typeName;           }
    int options()   const               { return m_opts;               }
    int offset()    const               { return m_offset;             }
    int size()      const               { return m_size;               }
    int nElement()  const               { return m_nElem;              }
    int typeID()    const               { return m_type;               }
    const std::string toString() const;
    StatusCode fromString(const std::string& string_rep);
    static const std::string typeName(int typ);
  };
}       // End namespace pool
#endif  // POOL_DBCOLUMN_H