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< BASE, Interfaces >
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::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
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::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Member Functions
void	outputTimeline ()

Private Attributes
bool	m_isEnabled
std::string	m_timelineFile
tbb::concurrent_vector< TimelineEvent >	m_events

Additional Inherited Members
Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
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 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...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... 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.

  : base_class( name, svc )
{

  declareProperty("TimelineFile", m_timelineFile = "timeline.csv");
  declareProperty("RecordTimeline", m_isEnabled = false);

}

TimelineSvc::~TimelineSvc ( )

virtual

Definition at line 18 of file TimelineSvc.cpp.

                          {

}

Member Function Documentation

StatusCode TimelineSvc::finalize ( )

virtual

Definition at line 56 of file TimelineSvc.cpp.

                      {

  if (m_events.size() > 0) {
    MsgStream log( msgSvc(), name() );

    log << MSG::INFO << "Outputting timeline with " << m_events.size() << " entries to file " << m_timelineFile << endmsg;

    outputTimeline();

  }

  return StatusCode::SUCCESS;

}

StatusCode TimelineSvc::initialize ( )

virtual

Definition at line 26 of file TimelineSvc.cpp.

                        {

  StatusCode sc = Service::initialize();
  if (!sc.isSuccess()) return sc;

  MsgStream log( msgSvc(), name() );
  log << MSG::DEBUG << "initialize" << endmsg;

  m_events.clear();

  return StatusCode::SUCCESS;

}

bool TimelineSvc::isEnabled ( ) const

inline

Definition at line 22 of file TimelineSvc.h.

{ return m_isEnabled; }

void TimelineSvc::outputTimeline ( )

private

Definition at line 86 of file TimelineSvc.cpp.

                                {

    std::ofstream out(m_timelineFile, std::ofstream::out | std::ofstream::trunc);

    out << "#start end algorithm thread slot event" << std::endl;

    for(const auto & e : m_events){
        out << std::chrono::duration_cast<std::chrono::nanoseconds>(e.start.time_since_epoch()).count() << " "
            << std::chrono::duration_cast<std::chrono::nanoseconds>(e.end.time_since_epoch()).count() << " "
            << e.algorithm << " "
            << e.thread << " "
            << e.slot << " "
            << e.event << std::endl;
    }

    out.close();

}

void TimelineSvc::registerTimelineEvent ( const TimelineEvent &  e )

virtual

Definition at line 75 of file TimelineSvc.cpp.

                                                              {

    m_events.push_back(e);

}

StatusCode TimelineSvc::reinitialize ( )

virtual

Definition at line 43 of file TimelineSvc.cpp.

                          {

  MsgStream log( msgSvc(), name() );
  log << MSG::DEBUG << "reinitialize" << endmsg;

  m_events.clear();

  return StatusCode::SUCCESS;

}

Member Data Documentation

tbb::concurrent_vector<TimelineEvent> TimelineSvc::m_events

private

Definition at line 35 of file TimelineSvc.h.

bool TimelineSvc::m_isEnabled

private

Definition at line 33 of file TimelineSvc.h.

std::string TimelineSvc::m_timelineFile

private

Definition at line 34 of file TimelineSvc.h.

---

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

• GaudiHive/src/TimelineSvc.h
• GaudiHive/src/TimelineSvc.cpp