The Gaudi Framework  v29r0 (ff2e7097)
Gaudi::MetaDataSvc Class Reference

#include <src/MetaDataSvc/MetaDataSvc.h>

Inheritance diagram for Gaudi::MetaDataSvc:
Collaboration diagram for Gaudi::MetaDataSvc:

Public Member Functions

 ~MetaDataSvc () override=default
 
StatusCode start () override
 
bool isEnabled () const
 
StatusCode collectData ()
 
MetaDatagetMetaData () override
 
std::map< std::string, std::stringgetMetaDataMap () override
 
- Public Member Functions inherited from extends< Service, IMetaDataSvc >
void * i_cast (const InterfaceID &tid) const override
 Implementation of IInterface::i_cast. More...
 
StatusCode queryInterface (const InterfaceID &ti, void **pp) override
 Implementation of IInterface::queryInterface. More...
 
std::vector< std::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
 ~extends () override=default
 Virtual destructor. More...
 
- Public Member Functions inherited from Service
const std::stringname () const override
 Retrieve name of the service. More...
 
StatusCode configure () override
 
StatusCode initialize () override
 
StatusCode start () override
 
StatusCode stop () override
 
StatusCode finalize () override
 
StatusCode terminate () override
 
Gaudi::StateMachine::State FSMState () const override
 
Gaudi::StateMachine::State targetFSMState () const override
 
StatusCode reinitialize () override
 
StatusCode restart () override
 
StatusCode sysInitialize () override
 Initialize Service. More...
 
StatusCode sysStart () override
 Initialize Service. More...
 
StatusCode sysStop () override
 Initialize Service. More...
 
StatusCode sysFinalize () override
 Finalize Service. More...
 
StatusCode sysReinitialize () override
 Re-initialize the Service. More...
 
StatusCode sysRestart () override
 Re-initialize the Service. More...
 
 Service (std::string name, ISvcLocator *svcloc)
 Standard Constructor. More...
 
SmartIF< ISvcLocator > & serviceLocator () const override
 Retrieve pointer to service locator. More...
 
StatusCode setProperties ()
 Method for setting declared properties to the values specified for the job. More...
 
template<class T >
StatusCode service (const std::string &name, const T *&psvc, bool createIf=true) const
 Access a service by name, creating it if it doesn't already exist. More...
 
template<class T >
StatusCode service (const std::string &name, T *&psvc, bool createIf=true) const
 
template<typename IFace = IService>
SmartIF< IFace > service (const std::string &name, bool createIf=true) const
 
template<class T >
StatusCode service (const std::string &svcType, const std::string &svcName, T *&psvc) const
 Access a service by name and type, creating it if it doesn't already exist. More...
 
template<class T >
StatusCode declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
 Declare used tool. More...
 
SmartIF< IAuditorSvc > & auditorSvc () const
 The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
 
- Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
 PropertyHolder ()=default
 
 ~PropertyHolder () override=default
 
Gaudi::Details::PropertyBasedeclareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
 Helper to wrap a regular data member and use it as a regular property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, TYPE &value, const std::string &doc="none") const
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
 Declare a PropertyBase instance setting name and documentation. More...
 
Gaudi::Details::PropertyBasedeclareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
 Declare a remote property. More...
 
StatusCode setProperty (const Gaudi::Details::PropertyBase &p) override
 set the property form another property More...
 
StatusCode setProperty (const std::string &s) override
 set the property from the formatted string More...
 
StatusCode setProperty (const std::string &n, const std::string &v) override
 set the property from name and the value More...
 
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
StatusCode getProperty (Gaudi::Details::PropertyBase *p) const override
 get the property More...
 
const Gaudi::Details::PropertyBasegetProperty (const std::string &name) const override
 get the property by name More...
 
StatusCode getProperty (const std::string &n, std::string &v) const override
 convert the property to the string More...
 
const std::vector< Gaudi::Details::PropertyBase * > & getProperties () const override
 get all properties More...
 
bool hasProperty (const std::string &name) const override
 Return true if we have a property with the given name. More...
 
 PropertyHolder (const PropertyHolder &)=delete
 
PropertyHolderoperator= (const PropertyHolder &)=delete
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, GaudiHandleBase &ref, const std::string &doc="none")
 Specializations for various GaudiHandles. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, GaudiHandleArrayBase &ref, const std::string &doc="none")
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, DataObjectHandleBase &ref, const std::string &doc="none")
 
- Public Member Functions inherited from CommonMessagingBase
virtual ~CommonMessagingBase ()=default
 Virtual destructor. More...
 
SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MSG::Level msgLevel () const
 get the output level from the embedded MsgStream More...
 
MSG::Level outputLevel () const __attribute__((deprecated))
 Backward compatibility function for getting the output level. More...
 
bool msgLevel (MSG::Level lvl) const
 get the output level from the embedded MsgStream More...
 
- Public Member Functions inherited from extend_interfaces< Interfaces... >
 ~extend_interfaces () override=default
 Virtual destructor. More...
 

Private Attributes

Gaudi::Property< bool > m_isEnabled {this, "Enabled", true}
 
std::map< std::string, std::stringm_metadata
 

Additional Inherited Members

- Public Types inherited from extends< Service, IMetaDataSvc >
using base_class = extends
 Typedef to this class. More...
 
using extend_interfaces_base = extend_interfaces< Interfaces... >
 Typedef to the base of this class. More...
 
- Public Types inherited from Service
typedef Gaudi::PluginService::Factory< IService *, const std::string &, ISvcLocator * > Factory
 
- Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
 Typedef used to refer to this class from derived classes, as in. More...
 
- Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using base_class = CommonMessaging
 
- Public Types inherited from extend_interfaces< Interfaces... >
using ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
 take union of the ext_iids of all Interfaces... More...
 
- Protected Member Functions inherited from Service
 ~Service () override
 Standard Destructor. More...
 
int outputLevel () const
 get the Service's output level More...
 
- Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBaseproperty (const std::string &name) const
 
- Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream. More...
 
- Protected Attributes inherited from Service
Gaudi::StateMachine::State m_state = Gaudi::StateMachine::OFFLINE
 Service state. More...
 
Gaudi::StateMachine::State m_targetState = Gaudi::StateMachine::OFFLINE
 Service state. More...
 
Gaudi::Property< int > m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}
 
Gaudi::Property< bool > m_auditInit {this, "AuditServices", false, "[[deprecated]] unused"}
 
Gaudi::Property< bool > m_auditorInitialize {this, "AuditInitialize", false, "trigger auditor on initialize()"}
 
Gaudi::Property< bool > m_auditorStart {this, "AuditStart", false, "trigger auditor on start()"}
 
Gaudi::Property< bool > m_auditorStop {this, "AuditStop", false, "trigger auditor on stop()"}
 
Gaudi::Property< bool > m_auditorFinalize {this, "AuditFinalize", false, "trigger auditor on finalize()"}
 
Gaudi::Property< bool > m_auditorReinitialize {this, "AuditReinitialize", false, "trigger auditor on reinitialize()"}
 
Gaudi::Property< bool > m_auditorRestart {this, "AuditRestart", false, "trigger auditor on restart()"}
 
SmartIF< IAuditorSvcm_pAuditorSvc
 Auditor Service. More...
 

Detailed Description

Definition at line 15 of file MetaDataSvc.h.

Constructor & Destructor Documentation

Gaudi::MetaDataSvc::~MetaDataSvc ( )
overridedefault

Member Function Documentation

StatusCode MetaDataSvc::collectData ( )

Definition at line 60 of file MetaDataSvc.cpp.

61 {
62  std::string temp;
63  bool first{false};
64 
65  auto appMgr = service<IProperty>( "ApplicationMgr" );
66  if ( appMgr.isValid() ) {
68  for ( int i = 0; i < (signed)properties.size(); i++ ) {
69  temp = "ApplicationMgr." + properties[i]->name();
70  m_metadata[temp] = properties[i]->toString();
71  }
72  }
73  auto mSvc = service<IProperty>( "MessageSvc" );
74  if ( mSvc.isValid() ) {
75  const std::vector<Gaudi::Details::PropertyBase*> properties2 = mSvc->getProperties();
76  for ( int i = 0; i < (signed)properties2.size(); i++ ) {
77  temp = "MessageSvc." + properties2[i]->name();
78  m_metadata[temp] = properties2[i]->toString();
79  }
80  }
81 
82  auto nSvc = service<IProperty>( "NTupleSvc" );
83  if ( nSvc.isValid() ) {
84  const std::vector<Gaudi::Details::PropertyBase*> properties5 = nSvc->getProperties();
85  for ( int i = 0; i < (signed)properties5.size(); i++ ) {
86  temp = "NTupleSvc." + properties5[i]->name();
87  m_metadata[temp] = properties5[i]->toString();
88  }
89  }
90 
91  /*
92  * TOOLS
93  * */
94  SmartIF<IToolSvc> tSvc( serviceLocator()->service( "ToolSvc" ) );
95  if ( tSvc.isValid() ) {
96  std::vector<std::string> TSvcs = tSvc->getInstances( "" );
97  temp = "";
98  for ( int i = 0; i < (signed)TSvcs.size(); i++ ) {
99  temp += TSvcs[i];
100  if ( i != (signed)TSvcs.size() - 1 ) temp += ", ";
101  }
102  m_metadata["ToolSvc"] = temp;
103  }
104 
105  /*
106  * SERVICES
107  * */
108  auto Svcs = serviceLocator()->getServices();
109  temp = "";
110  first = true;
111  for ( auto svc : Svcs ) {
112  if ( !first )
113  temp += ", ";
114  else
115  first = false;
116  temp += svc->name();
117  }
118  m_metadata["ISvcLocator.Services"] = temp;
119 
120  /*
121  * ALGORITHMS
122  * */
124  auto allAlgs = algMan->getAlgorithms();
125  temp = "";
126  first = true;
127  for ( auto alg : allAlgs ) {
128  if ( !first )
129  temp += ", ";
130  else
131  first = false;
132  temp += alg->name();
133  }
134  m_metadata["IAlgManager.Algorithms"] = temp;
135 
136  /*
137  * JOB OPTIONS SERVICE
138  * */
139  auto joSvc = service<IProperty>( "JobOptionsSvc" );
140  if ( !joSvc.isValid() ) {
141  return StatusCode::FAILURE;
142  }
143  const std::vector<Gaudi::Details::PropertyBase*> properties7 = joSvc->getProperties();
144  for ( int i = 0; i < (signed)properties7.size(); i++ ) {
145  temp = "JobOptionsSvc." + properties7[i]->name();
146  m_metadata[temp] = properties7[i]->toString();
147  }
148 
149  if ( msgLevel( MSG::DEBUG ) ) {
150  std::stringstream ss_metadata;
151  for ( auto item : m_metadata ) {
152  ss_metadata << item.first << ':' << item.second << '\n';
153  }
154  debug() << "Metadata collected:\n" << ss_metadata.str() << endmsg;
155  }
156 
157  return StatusCode::SUCCESS;
158 }
STL class.
T str(T...args)
T size(T...args)
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
appMgr
Definition: IOTest.py:94
virtual const std::list< IService * > & getServices() const =0
Get a reference to a service and create it if it does not exists.
StatusCode service(const std::string &name, const T *&psvc, bool createIf=true) const
Access a service by name, creating it if it doesn&#39;t already exist.
Definition: Service.h:85
MSG::Level msgLevel() const
get the output level from the embedded MsgStream
SmartIF< ISvcLocator > & serviceLocator() const override
Retrieve pointer to service locator.
Definition: Service.cpp:292
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
std::map< std::string, std::string > m_metadata
Definition: MetaDataSvc.h:33
MetaData * MetaDataSvc::getMetaData ( )
override

Definition at line 58 of file MetaDataSvc.cpp.

58 { return new MetaData( m_metadata ); }
std::map< std::string, std::string > m_metadata
Definition: MetaDataSvc.h:33
std::map< std::string, std::string > MetaDataSvc::getMetaDataMap ( )
override

Definition at line 59 of file MetaDataSvc.cpp.

59 { return m_metadata; }
std::map< std::string, std::string > m_metadata
Definition: MetaDataSvc.h:33
bool Gaudi::MetaDataSvc::isEnabled ( ) const
inline

Definition at line 23 of file MetaDataSvc.h.

23 { return m_isEnabled; }
Gaudi::Property< bool > m_isEnabled
Definition: MetaDataSvc.h:31
StatusCode MetaDataSvc::start ( )
override

Definition at line 53 of file MetaDataSvc.cpp.

54 {
55  if ( msgLevel( MSG::DEBUG ) ) debug() << "started" << endmsg;
56  return collectData();
57 }
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
MSG::Level msgLevel() const
get the output level from the embedded MsgStream
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
StatusCode collectData()
Definition: MetaDataSvc.cpp:60

Member Data Documentation

Gaudi::Property<bool> Gaudi::MetaDataSvc::m_isEnabled {this, "Enabled", true}
private

Definition at line 31 of file MetaDataSvc.h.

std::map<std::string, std::string> Gaudi::MetaDataSvc::m_metadata
private

Definition at line 33 of file MetaDataSvc.h.


The documentation for this class was generated from the following files: