A container of information describing a monitoring object. More...

#include <ManagedMonitorToolBase.h>

Collaboration diagram for ManagedMonitorToolBase::MonGroup:

Public Types
typedef std::map< std::string, TH1 * >	HistMap_t
	A mapping of histogram name to histogram object. More...

Public Member Functions
	MonGroup (ManagedMonitorToolBase *tool, const std::string &system, Interval_t interval)

	MonGroup (ManagedMonitorToolBase *tool, const std::string &system, Interval_t interval, MgmtAttr_t histo_mgmt)

	MonGroup (ManagedMonitorToolBase *tool, const std::string &system, Interval_t interval, MgmtAttr_t histo_mgmt, const std::string &chain)

	MonGroup (ManagedMonitorToolBase *tool, const std::string &system, Interval_t interval, MgmtAttr_t histo_mgmt, const std::string &chain, const std::string &merge)

StatusCode	regHist (TH1 *h)
	Registers a TH1 (including TH2, TH3, and TProfile) to be included in the output stream using logical parameters that describe the histogram. More...

StatusCode	getHist (TH1 *&h, const std::string &hName)
	Returns a TH1 via the pointer passed as the first argument. More...

StatusCode	getHist (TH2 *&h, const std::string &hName)
	Returns a TH2 via the pointer passed as the first argument. More...

StatusCode	regEfficiency (TEfficiency *e)
	Registers a TEfficiency to be included in the output stream. More...

StatusCode	regGraph (TGraph *g)
	Registers a TGraph to be included in the output stream using logical parameters that describe the histogram. More...

StatusCode	regTree (TTree *t)
	Registers a TTree to be included in the output stream using logical parameters that describe the histogram. More...

StatusCode	writeAndDelete (TH1 *h)
	Write and delete a histogram. More...

StatusCode	deregHist (TH1 *h)
	De-registers a TH1 from the THistSvc, but does NOT delete the object. More...

StatusCode	deregGraph (TGraph *g)
	De-registers a TGraph from the THistSvc, but does NOT delete the object. More...

StatusCode	deregObject (const std::string &objName)
	De-registers a TObject from the THistSvc, but does NOT delete the object. More...

StatusCode	deregAll ()
	De-registers all TH1 objects from the THistSvc, but does NOT delete the objects. More...

const std::string &	system () const

Interval_t	interval () const

MgmtAttr_t	histo_mgmt () const

const std::string &	chain () const

const std::string &	merge () const

HistMap_t &	map ()
	A map containing all histograms registered with this MonGroup. More...

	MonGroup (const MonGroup &o)

MonGroup &	operator= (const MonGroup &o)

Static Public Member Functions
static unsigned	ncopies ()

Private Member Functions
	MonGroup ()

Static Private Member Functions
static void	badusage ()

Private Attributes
ManagedMonitorToolBase *	m_tool

std::string	m_system

Interval_t	m_interval

MgmtAttr_t	m_histo_mgmt

std::string	m_chain

std::string	m_merge

HistMap_t	m_map

Detailed Description

A container of information describing a monitoring object.

Definition at line 137 of file ManagedMonitorToolBase.h.

Member Typedef Documentation

◆ HistMap_t

typedef std::map<std::string,TH1*> ManagedMonitorToolBase::MonGroup::HistMap_t

A mapping of histogram name to histogram object.

Definition at line 255 of file ManagedMonitorToolBase.h.

Constructor & Destructor Documentation

◆ MonGroup() [1/6]

ManagedMonitorToolBase::MonGroup::MonGroup	(	ManagedMonitorToolBase *	tool,
		const std::string &	system,
		Interval_t	interval
	)

inline

Definition at line 140 of file ManagedMonitorToolBase.h.

142 : m_tool(tool), m_system(system), m_interval(interval), m_histo_mgmt(ATTRIB_MANAGED), m_chain(""), m_merge("") { }

◆ MonGroup() [2/6]

ManagedMonitorToolBase::MonGroup::MonGroup	(	ManagedMonitorToolBase *	tool,
		const std::string &	system,
		Interval_t	interval,
		MgmtAttr_t	histo_mgmt
	)

inline

Definition at line 144 of file ManagedMonitorToolBase.h.

146 : m_tool(tool), m_system(system), m_interval(interval), m_histo_mgmt(histo_mgmt), m_chain(""), m_merge("") { }

◆ MonGroup() [3/6]

ManagedMonitorToolBase::MonGroup::MonGroup	(	ManagedMonitorToolBase *	tool,
		const std::string &	system,
		Interval_t	interval,
		MgmtAttr_t	histo_mgmt,
		const std::string &	chain
	)

inline

Definition at line 148 of file ManagedMonitorToolBase.h.

150 : m_tool(tool), m_system(system), m_interval(interval), m_histo_mgmt(histo_mgmt), m_chain(chain), m_merge("") { }

◆ MonGroup() [4/6]

ManagedMonitorToolBase::MonGroup::MonGroup	(	ManagedMonitorToolBase *	tool,
		const std::string &	system,
		Interval_t	interval,
		MgmtAttr_t	histo_mgmt,
		const std::string &	chain,
		const std::string &	merge
	)

inline

Definition at line 152 of file ManagedMonitorToolBase.h.

155 : m_tool(tool), m_system(system), m_interval(interval), m_histo_mgmt(histo_mgmt), m_chain(chain), m_merge(merge) { }

◆ MonGroup() [5/6]

ManagedMonitorToolBase::MonGroup::MonGroup ( const MonGroup & o )

inline

Definition at line 265 of file ManagedMonitorToolBase.h.

                 : m_tool(o.m_tool),
                   m_system(o.m_system),
                   //m_level(o.m_level),
                   m_interval(o.m_interval),
                   m_histo_mgmt(o.m_histo_mgmt),
                   m_chain(o.m_chain),
                   m_merge(o.m_merge),
                   m_map(o.m_map)
                   { 
                       badusage(); 
                   }

◆ MonGroup() [6/6]

ManagedMonitorToolBase::MonGroup::MonGroup ( )

inlineprivate

Definition at line 295 of file ManagedMonitorToolBase.h.

295 { }

Member Function Documentation

◆ badusage()

void ManagedMonitorToolBase::MonGroup::badusage ( )

staticprivate

Definition at line 185 of file ManagedMonitorToolBase.cxx.

185 { ++s_mmtb_mongroup_ncopies; }

◆ chain()

const std::string& ManagedMonitorToolBase::MonGroup::chain ( ) const

inline

Definition at line 248 of file ManagedMonitorToolBase.h.

248 { return m_chain; }

◆ deregAll()

StatusCode ManagedMonitorToolBase::MonGroup::deregAll ( )

De-registers all TH1 objects from the THistSvc, but does NOT delete the objects.

Definition at line 312 of file ManagedMonitorToolBase.cxx.

 {
    if( m_tool != 0 ) {
       bool isSuccess(true);
       StatusCode sc;
  
       typedef HistMap_t::const_iterator MapIter_t;
       MapIter_t mapEnd = m_map.end();
       for( MapIter_t i = m_map.begin(); i != mapEnd; ++i ) {
          sc = m_tool->deregHist( i->second );
          if( !sc.isSuccess() )
             isSuccess = false;
       }
  
       m_map.clear();
  
       if( isSuccess )
          return StatusCode::SUCCESS;
    }
  
    return StatusCode::FAILURE;
 }

◆ deregGraph()

StatusCode ManagedMonitorToolBase::MonGroup::deregGraph ( TGraph * g )

De-registers a TGraph from the THistSvc, but does NOT delete the object.

Definition at line 288 of file ManagedMonitorToolBase.cxx.

 {
    if( m_tool != 0 ) {
       return m_tool->deregGraph( g );
    }
  
    return StatusCode::FAILURE;
 }

◆ deregHist()

StatusCode ManagedMonitorToolBase::MonGroup::deregHist ( TH1 * h )

De-registers a TH1 from the THistSvc, but does NOT delete the object.

Definition at line 274 of file ManagedMonitorToolBase.cxx.

 {
    if( m_tool != 0 ) {
       std::string hName( h->GetName() );
       m_map.erase( hName );
       return m_tool->deregHist( h );
    }
  
    return StatusCode::FAILURE;
 }

◆ deregObject()

StatusCode ManagedMonitorToolBase::MonGroup::deregObject ( const std::string & objName )

De-registers a TObject from the THistSvc, but does NOT delete the object.

Definition at line 300 of file ManagedMonitorToolBase.cxx.

 {
    if( m_tool != 0 ) {
       return m_tool->deregObject( objName, *this );
    }
  
    return StatusCode::FAILURE;
 }

◆ getHist() [1/2]

StatusCode ManagedMonitorToolBase::MonGroup::getHist	(	TH1 *&	h,
		const std::string &	hName
	)

Returns a TH1 via the pointer passed as the first argument.

The histogram name, without the leading path or stream name, must be given as the second argument.

Definition at line 204 of file ManagedMonitorToolBase.cxx.

 {
    if( m_tool != 0 ) {
       return m_tool->getHist( h, hName, *this );
    }
  
    return StatusCode::FAILURE;
 }

◆ getHist() [2/2]

StatusCode ManagedMonitorToolBase::MonGroup::getHist	(	TH2 *&	h,
		const std::string &	hName
	)

Returns a TH2 via the pointer passed as the first argument.

The histogram name, without the leading path or stream name, must be given as the second argument.

Definition at line 216 of file ManagedMonitorToolBase.cxx.

 {
    if( m_tool != 0 ) {
       return m_tool->getHist( h, hName, *this );
    }
  
    return StatusCode::FAILURE;
 }

◆ histo_mgmt()

MgmtAttr_t ManagedMonitorToolBase::MonGroup::histo_mgmt ( ) const

inline

Definition at line 247 of file ManagedMonitorToolBase.h.

247 { return m_histo_mgmt; }

◆ interval()

Interval_t ManagedMonitorToolBase::MonGroup::interval ( ) const

inline

Definition at line 246 of file ManagedMonitorToolBase.h.

246 { return m_interval; }

◆ map()

HistMap_t& ManagedMonitorToolBase::MonGroup::map ( )

inline

A map containing all histograms registered with this MonGroup.

Definition at line 262 of file ManagedMonitorToolBase.h.

262 { return m_map; }

◆ merge()

const std::string& ManagedMonitorToolBase::MonGroup::merge ( ) const

inline

Definition at line 249 of file ManagedMonitorToolBase.h.

249 { return m_merge; }

◆ ncopies()

unsigned ManagedMonitorToolBase::MonGroup::ncopies ( )

static

Definition at line 184 of file ManagedMonitorToolBase.cxx.

184 { return s_mmtb_mongroup_ncopies; }

◆ operator=()

MonGroup& ManagedMonitorToolBase::MonGroup::operator= ( const MonGroup & o )

inline

Definition at line 278 of file ManagedMonitorToolBase.h.

                 {
               if (&o != this) {
                 m_tool = o.m_tool;
                 m_system = o.m_system;
                 //m_level = o.m_level;
                 m_interval = o.m_interval;
                 m_histo_mgmt = o.m_histo_mgmt;
                 m_chain = o.m_chain;
                 m_merge = o.m_merge;
                 m_map = o.m_map;
               }
               badusage();
           return *this;
         }

◆ regEfficiency()

StatusCode ManagedMonitorToolBase::MonGroup::regEfficiency ( TEfficiency * e )

Registers a TEfficiency to be included in the output stream.

Definition at line 227 of file ManagedMonitorToolBase.cxx.

                                                                          {
     if( m_tool != 0 ) {
         return m_tool->regEfficiency( e, *this );
     }
     return StatusCode::FAILURE;
 }

◆ regGraph()

StatusCode ManagedMonitorToolBase::MonGroup::regGraph ( TGraph * g )

Registers a TGraph to be included in the output stream using logical parameters that describe the histogram.

The optional 'dqmAlgorithm' parameter may be used to specify an algorithm to automatically check the histogram after it has been filled.

Definition at line 236 of file ManagedMonitorToolBase.cxx.

 {
    if( m_tool != 0 ) {
       return m_tool->regGraph( g, *this );
    }
  
    return StatusCode::FAILURE;
 }

◆ regHist()

StatusCode ManagedMonitorToolBase::MonGroup::regHist ( TH1 * h )

Registers a TH1 (including TH2, TH3, and TProfile) to be included in the output stream using logical parameters that describe the histogram.

The optional 'dqmAlgorithm' parameter may be used to specify an algorithm to automatically check the histogram after it has been filled.

Definition at line 191 of file ManagedMonitorToolBase.cxx.

 {
    if( m_tool != 0 ) {
       std::string hName( h->GetName() );
       m_map.emplace( hName, h );
       return m_tool->regHist( h, *this );
    }
  
    return StatusCode::FAILURE;
 }

◆ regTree()

StatusCode ManagedMonitorToolBase::MonGroup::regTree ( TTree * t )

Registers a TTree to be included in the output stream using logical parameters that describe the histogram.

Definition at line 248 of file ManagedMonitorToolBase.cxx.

 {
    if( m_tool != 0 ) {
       return m_tool->regTree( t, *this );
    }
  
    return StatusCode::FAILURE;
 }

◆ system()

const std::string& ManagedMonitorToolBase::MonGroup::system ( ) const

inline

Definition at line 244 of file ManagedMonitorToolBase.h.

244 { return m_system; }

◆ writeAndDelete()

StatusCode ManagedMonitorToolBase::MonGroup::writeAndDelete ( TH1 * h )

Write and delete a histogram.

Definition at line 260 of file ManagedMonitorToolBase.cxx.

 {
    if( m_tool != 0 ) {
       std::string hName( h->GetName() );
       m_map.erase( hName );
       return m_tool->writeAndDelete( h, *this );
    }
  
    return StatusCode::FAILURE;
 }  

Member Data Documentation

◆ m_chain

std::string ManagedMonitorToolBase::MonGroup::m_chain

private

Definition at line 301 of file ManagedMonitorToolBase.h.

◆ m_histo_mgmt

MgmtAttr_t ManagedMonitorToolBase::MonGroup::m_histo_mgmt

private

Definition at line 300 of file ManagedMonitorToolBase.h.

◆ m_interval

Interval_t ManagedMonitorToolBase::MonGroup::m_interval

private

Definition at line 299 of file ManagedMonitorToolBase.h.

◆ m_map

HistMap_t ManagedMonitorToolBase::MonGroup::m_map

private

Definition at line 303 of file ManagedMonitorToolBase.h.

◆ m_merge

std::string ManagedMonitorToolBase::MonGroup::m_merge

private

Definition at line 302 of file ManagedMonitorToolBase.h.

◆ m_system

std::string ManagedMonitorToolBase::MonGroup::m_system

private

Definition at line 297 of file ManagedMonitorToolBase.h.

◆ m_tool

ManagedMonitorToolBase* ManagedMonitorToolBase::MonGroup::m_tool

private

Definition at line 296 of file ManagedMonitorToolBase.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ HistMap_t

Constructor & Destructor Documentation

◆ MonGroup() [1/6]

◆ MonGroup() [2/6]

◆ MonGroup() [3/6]

◆ MonGroup() [4/6]

◆ MonGroup() [5/6]

◆ MonGroup() [6/6]

Member Function Documentation

◆ badusage()

◆ chain()

◆ deregAll()

◆ deregGraph()

◆ deregHist()

◆ deregObject()

◆ getHist() [1/2]

◆ getHist() [2/2]

◆ histo_mgmt()

◆ interval()

◆ map()

◆ merge()

◆ ncopies()

◆ operator=()

◆ regEfficiency()

◆ regGraph()

◆ regHist()

◆ regTree()

◆ system()

◆ writeAndDelete()

Member Data Documentation

◆ m_chain

◆ m_histo_mgmt

◆ m_interval

◆ m_map

◆ m_merge

◆ m_system

◆ m_tool