Gaudi Framework, version v23r4

Home   Generated: Mon Sep 17 2012
Public Types | Public Member Functions

Gaudi::Utils::GetData< TYPE > Struct Template Reference

Helper structure for implementation of "get"-functions for GaudiCommon<BASE> More...

#include <GetData.h>

Inheritance diagram for Gaudi::Utils::GetData< TYPE >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef TYPE Type
typedef _GetType< Type >
::return_type 
return_type
 the actual return type

Public Member Functions

template<class COMMON >
return_type operator() (const COMMON &common, IDataProviderSvc *service, const std::string &location, const bool checkData=true) const
 the only one essential method

Detailed Description

template<class TYPE>
struct Gaudi::Utils::GetData< TYPE >

Helper structure for implementation of "get"-functions for GaudiCommon<BASE>

Author:
Vanya BELYAEV Ivan.Belyaev@nikhef.nl
Date:
2008-07-22

Definition at line 81 of file GetData.h.


Member Typedef Documentation

template<class TYPE>
typedef _GetType<Type>::return_type Gaudi::Utils::GetData< TYPE >::return_type

the actual return type

Definition at line 87 of file GetData.h.

template<class TYPE>
typedef TYPE Gaudi::Utils::GetData< TYPE >::Type

Definition at line 85 of file GetData.h.


Member Function Documentation

template<class TYPE>
template<class COMMON >
return_type Gaudi::Utils::GetData< TYPE >::operator() ( const COMMON &  common,
IDataProviderSvc service,
const std::string location,
const bool  checkData = true 
) const [inline]

the only one essential method

Parameters:
commonthe actual "worker"
servicepointer to Data Provider Service
locationlocation of objects in TES
checkDatawhether to check if the pointer is valid before returning it
Returns:
the data

Definition at line 100 of file GetData.h.

      {
        // use Data Provider Service
        return_type obj = getFromTS<Type>(service, location);
        if (checkData) { // check the data
          common.Assert(obj, "get():: No valid data at '" + location + "'");
        }
        // debug printout
        if ( common.msgLevel ( MSG::DEBUG ) ) {
          common.debug() << "The object of type '"
                         << System::typeinfoName(typeid(obj))
                         << "' "
                         << (obj ? "has been" : "could not be")
                         << " retrieved from TS at address '"
                         << location << "'" << endmsg ;
        }
        // return located data
        return obj ;
        // ======================================================================
      }

The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Generated at Mon Sep 17 2012 13:49:56 for Gaudi Framework, version v23r4 by Doxygen version 1.7.2 written by Dimitri van Heesch, © 1997-2004