TimelineSvc Class Reference

#include <src/TimelineSvc.h>

Inheritance diagram for TimelineSvc:
Collaboration diagram for TimelineSvc:

Public Member Functions

virtual StatusCode initialize ()
 
virtual StatusCode reinitialize ()
 
virtual StatusCode finalize ()
 
virtual void registerTimelineEvent (const TimelineEvent &e)
 
bool isEnabled () const
 
 TimelineSvc (const std::string &name, ISvcLocator *svc)
 
virtual ~TimelineSvc ()
 
- Public Member Functions inherited from extends< Service, ITimelineSvc >
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...
 
StatusCode setProperty (const Property &p) override
 
StatusCode setProperty (const std::string &s) override
 
StatusCode setProperty (const std::string &n, const std::string &v) override
 
StatusCode getProperty (Property *p) const override
 
const PropertygetProperty (const std::string &name) const override
 
StatusCode getProperty (const std::string &n, std::string &v) const override
 
const std::vector< Property * > & getProperties () const override
 
bool hasProperty (const std::string &name) const override
 
template<class TYPE >
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value 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 >
PropertydeclareProperty (const std::string &name, T &property, const std::string &doc="none") const
 Declare the named property. More...
 
PropertydeclareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
 Declare remote named properties. More...
 
template<class T >
StatusCode declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
 Declare used Private tool. More...
 
template<class T >
StatusCode declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
 Declare used Public 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 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 Member Functions

void outputTimeline ()
 

Private Attributes

bool m_isEnabled
 
bool m_partial
 
std::string m_timelineFile
 
tbb::concurrent_vector< TimelineEventm_events
 

Additional Inherited Members

- Public Types inherited from extends< Service, ITimelineSvc >
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 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 CommonMessaging< implements< IService, IProperty, IStateful > >
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream. More...
 
- Protected Attributes inherited from Service
IntegerProperty m_outputLevel = MSG::NIL
 Service output level. More...
 
Gaudi::StateMachine::State m_state = Gaudi::StateMachine::OFFLINE
 Service state. More...
 
Gaudi::StateMachine::State m_targetState = Gaudi::StateMachine::OFFLINE
 Service state. More...
 

Detailed Description

Definition at line 12 of file TimelineSvc.h.

Constructor & Destructor Documentation

TimelineSvc::TimelineSvc ( const std::string name,
ISvcLocator svc 
)

Definition at line 7 of file TimelineSvc.cpp.

8  : base_class( name, svc ), m_partial(false)
9 {
10 
11  declareProperty("TimelineFile", m_timelineFile = "timeline.csv");
12  declareProperty("RecordTimeline", m_isEnabled = false);
13  declareProperty("Partial",m_partial = false);
14 
15 }
extends base_class
Typedef to this class.
Definition: extends.h:14
std::string m_timelineFile
Definition: TimelineSvc.h:36
bool m_partial
Definition: TimelineSvc.h:35
Property * declareProperty(const std::string &name, T &property, const std::string &doc="none") const
Declare the named property.
Definition: Service.h:215
bool m_isEnabled
Definition: TimelineSvc.h:34
TimelineSvc::~TimelineSvc ( )
virtual

Definition at line 19 of file TimelineSvc.cpp.

19  {
20 
21 }

Member Function Documentation

StatusCode TimelineSvc::finalize ( )
virtual

Definition at line 63 of file TimelineSvc.cpp.

63  {
64 
65  if (m_events.size() > 0) {
66  MsgStream log( msgSvc(), name() );
67 
68  log << MSG::INFO << "Outputting timeline with " << m_events.size() << " entries to file " << m_timelineFile << endmsg;
69 
71 
72  }
73 
74  return StatusCode::SUCCESS;
75 
76 }
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:319
std::string m_timelineFile
Definition: TimelineSvc.h:36
tbb::concurrent_vector< TimelineEvent > m_events
Definition: TimelineSvc.h:37
SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
void outputTimeline()
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
StatusCode TimelineSvc::initialize ( )
virtual

Definition at line 27 of file TimelineSvc.cpp.

27  {
28 
30  if (!sc.isSuccess()) return sc;
31 
32  if (msgLevel(MSG::DEBUG))
33  debug() << "initialize" << endmsg;
34 
35  m_events.clear();
36 
37  if (m_partial) {
38  std::ofstream out(m_timelineFile+".part", std::ofstream::trunc | std::ofstream::out);
39  out << "#start end algorithm thread slot event" << std::endl;
40  out.close();
41  }
42 
43  return StatusCode::SUCCESS;
44 
45 }
StatusCode initialize() override
Definition: Service.cpp:68
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:76
T endl(T...args)
STL class.
std::string m_timelineFile
Definition: TimelineSvc.h:36
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
bool m_partial
Definition: TimelineSvc.h:35
tbb::concurrent_vector< TimelineEvent > m_events
Definition: TimelineSvc.h:37
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:244
bool TimelineSvc::isEnabled ( ) const
inline

Definition at line 23 of file TimelineSvc.h.

23 { return m_isEnabled; }
bool m_isEnabled
Definition: TimelineSvc.h:34
void TimelineSvc::outputTimeline ( )
private

Definition at line 105 of file TimelineSvc.cpp.

105  {
106 
107  std::ofstream out(m_timelineFile, std::ofstream::out | std::ofstream::trunc);
108 
109  out << "#start end algorithm thread slot event" << std::endl;
110 
111  for(const auto & e : m_events){
112  out << std::chrono::duration_cast<std::chrono::nanoseconds>(e.start.time_since_epoch()).count() << " "
113  << std::chrono::duration_cast<std::chrono::nanoseconds>(e.end.time_since_epoch()).count() << " "
114  << e.algorithm << " "
115  << e.thread << " "
116  << e.slot << " "
117  << e.event << std::endl;
118  }
119 
120  out.close();
121 
122 }
T endl(T...args)
T duration_cast(T...args)
STL class.
std::string m_timelineFile
Definition: TimelineSvc.h:36
tbb::concurrent_vector< TimelineEvent > m_events
Definition: TimelineSvc.h:37
T count(T...args)
void TimelineSvc::registerTimelineEvent ( const TimelineEvent e)
virtual

Definition at line 82 of file TimelineSvc.cpp.

82  {
83 
84  m_events.push_back(e);
85 
86  if (m_partial) {
87  std::ofstream out(m_timelineFile+".part", std::ofstream::app | std::ofstream::out);
88  out << std::chrono::duration_cast<std::chrono::nanoseconds>(e.start.time_since_epoch()).count() << " "
89  << std::chrono::duration_cast<std::chrono::nanoseconds>(e.end.time_since_epoch()).count() << " "
90  << e.algorithm << " "
91  << e.thread << " "
92  << e.slot << " "
93  << e.event << std::endl;
94 
95  out.close();
96  }
97 
98 }
T endl(T...args)
std::string algorithm
Definition: ITimelineSvc.h:23
T duration_cast(T...args)
time_point end
Definition: ITimelineSvc.h:26
STL class.
std::string m_timelineFile
Definition: TimelineSvc.h:36
bool m_partial
Definition: TimelineSvc.h:35
tbb::concurrent_vector< TimelineEvent > m_events
Definition: TimelineSvc.h:37
T count(T...args)
time_point start
Definition: ITimelineSvc.h:25
StatusCode TimelineSvc::reinitialize ( )
virtual

Definition at line 50 of file TimelineSvc.cpp.

50  {
51 
52  MsgStream log( msgSvc(), name() );
53  log << MSG::DEBUG << "reinitialize" << endmsg;
54 
55  m_events.clear();
56 
57  return StatusCode::SUCCESS;
58 
59 }
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:319
tbb::concurrent_vector< TimelineEvent > m_events
Definition: TimelineSvc.h:37
SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244

Member Data Documentation

tbb::concurrent_vector<TimelineEvent> TimelineSvc::m_events
private

Definition at line 37 of file TimelineSvc.h.

bool TimelineSvc::m_isEnabled
private

Definition at line 34 of file TimelineSvc.h.

bool TimelineSvc::m_partial
private

Definition at line 35 of file TimelineSvc.h.

std::string TimelineSvc::m_timelineFile
private

Definition at line 36 of file TimelineSvc.h.


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