The Gaudi Framework  master (da3d77e1)
DataStoreItem Class Reference

#include <GaudiKernel/DataStoreItem.h>

Collaboration diagram for DataStoreItem:

Public Member Functions

 DataStoreItem (std::string path, int depth=1)
 Standard Constructor. More...
 
 DataStoreItem (const DataStoreItem &item)
 Copy constructor. More...
 
virtual ~DataStoreItem ()=default
 Standard Destructor. More...
 
bool operator== (const DataStoreItem &cmp) const
 Equality operator. More...
 
bool operator!= (const DataStoreItem &cmp) const
 Inequality operator. More...
 
DataStoreItemoperator= (const DataStoreItem &cmp)
 Equivalence operator. More...
 
void analyse ()
 Interprete the load path for special options. More...
 
const std::stringpath () const
 Accessor: Retrieve load path. More...
 
int depth () const
 Accessor: Retrieve load depth. More...
 

Protected Attributes

std::string m_path
 Path of item to be loaded. More...
 
int m_depth
 Depth to be auto-loaded from the requested path onwards. More...
 

Detailed Description

Description of the DataStoreItem class. DataStoreItems describe in an abstract way an item in the data store. Items can be supplied to the services in order to e.g. trigger preloading or writing.

Author
M.Frank
Version
1.0

Definition at line 27 of file DataStoreItem.h.

Constructor & Destructor Documentation

◆ DataStoreItem() [1/2]

DataStoreItem::DataStoreItem ( std::string  path,
int  depth = 1 
)
inline

Standard Constructor.

Definition at line 36 of file DataStoreItem.h.

36 : m_path( std::move( path ) ), m_depth( depth ) { analyse(); }

◆ DataStoreItem() [2/2]

DataStoreItem::DataStoreItem ( const DataStoreItem item)
inline

Copy constructor.

Definition at line 38 of file DataStoreItem.h.

38 : m_path( item.m_path ), m_depth( item.m_depth ) { analyse(); }

◆ ~DataStoreItem()

virtual DataStoreItem::~DataStoreItem ( )
virtualdefault

Standard Destructor.

Member Function Documentation

◆ analyse()

void DataStoreItem::analyse ( )
inline

Interprete the load path for special options.

Definition at line 54 of file DataStoreItem.h.

54  {
55  if ( m_path.empty() ) return;
56  const size_t len = m_path.length() - 1;
57  if ( m_path[len] == '*' ) {
58  m_depth = 99999999;
59  ( len > 0 && m_path[len - 1] == '/' ) ? m_path.erase( len - 1, 2 ) : m_path.erase( len, 1 );
60  } else if ( m_path[len] == '+' ) {
61  ( len > 0 && m_path[len - 1] == '/' ) ? m_path.erase( len - 1, 2 ) : m_path.erase( len, 1 );
62  m_depth = 2;
63  }
64  }

◆ depth()

int DataStoreItem::depth ( ) const
inline

Accessor: Retrieve load depth.

Definition at line 68 of file DataStoreItem.h.

68 { return m_depth; }

◆ operator!=()

bool DataStoreItem::operator!= ( const DataStoreItem cmp) const
inline

Inequality operator.

Definition at line 45 of file DataStoreItem.h.

45 { return !( m_path == cmp.path() && m_depth == cmp.depth() ); }

◆ operator=()

DataStoreItem& DataStoreItem::operator= ( const DataStoreItem cmp)
inline

Equivalence operator.

Definition at line 47 of file DataStoreItem.h.

47  {
48  m_path = cmp.path();
49  m_depth = cmp.depth();
50  analyse();
51  return *this;
52  }

◆ operator==()

bool DataStoreItem::operator== ( const DataStoreItem cmp) const
inline

Equality operator.

Definition at line 43 of file DataStoreItem.h.

43 { return m_path == cmp.path() && m_depth == cmp.depth(); }

◆ path()

const std::string& DataStoreItem::path ( ) const
inline

Accessor: Retrieve load path.

Definition at line 66 of file DataStoreItem.h.

66 { return m_path; }

Member Data Documentation

◆ m_depth

int DataStoreItem::m_depth
protected

Depth to be auto-loaded from the requested path onwards.

Definition at line 32 of file DataStoreItem.h.

◆ m_path

std::string DataStoreItem::m_path
protected

Path of item to be loaded.

Definition at line 30 of file DataStoreItem.h.


The documentation for this class was generated from the following file:
std::move
T move(T... args)
std::string::length
T length(T... args)
DataStoreItem::depth
int depth() const
Accessor: Retrieve load depth.
Definition: DataStoreItem.h:68
DataStoreItem::m_depth
int m_depth
Depth to be auto-loaded from the requested path onwards.
Definition: DataStoreItem.h:32
DataStoreItem::m_path
std::string m_path
Path of item to be loaded.
Definition: DataStoreItem.h:30
std::string::erase
T erase(T... args)
std::string::empty
T empty(T... args)
DataStoreItem::path
const std::string & path() const
Accessor: Retrieve load path.
Definition: DataStoreItem.h:66
DataStoreItem::analyse
void analyse()
Interprete the load path for special options.
Definition: DataStoreItem.h:54