#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/JobHistory.h>

Inheritance diagram for JobHistory:

Collaboration diagram for JobHistory:

Public Types
typedef std::vector< std::pair< std::string, std::unique_ptr< Gaudi::Property< std::string > > > >	PropertyPairList
Public Types inherited from IVersHistoryObj
typedef std::vector< Gaudi::Details::PropertyBase * >	PropertyList

Public Member Functions
	JobHistory ()
	JobHistory (const std::string &rel, const std::string &os, const std::string &host, const std::string &dir, const std::string &osver, const std::string &mach, const std::string &cmtconfig, const time_t &time)
virtual	~JobHistory ()
const CLID &	clID () const override
	Retrieve reference to class definition structure.
void	addProperty (const std::string &key, const std::string &value)
const std::string &	release_version () const
const std::string &	os () const
const std::string &	hostname () const
const std::string &	os_version () const
const std::string &	machine () const
const std::string &	dir () const
const std::string &	cmtconfig () const
const std::vector< std::string > &	environment () const
const PropertyList &	properties () const override
const PropertyPairList &	propertyPairs () const
time_t	start_time () const
std::ostream &	dump (std::ostream &, bool isXML, int indent) const override
const std::string &	name () const override
const std::string &	version () const override
const std::string &	type () const override
Public Member Functions inherited from HistoryObj
virtual	~HistoryObj ()=default
Public Member Functions inherited from DataObject
	DataObject ()
	Standard Constructor.
	DataObject (const DataObject &rhs)
	Copy Constructor.
DataObject &	operator= (const DataObject &rhs)
	Assignment Operator.
	DataObject (DataObject &&rhs)
	Move Constructor.
DataObject &	operator= (DataObject &&rhs)
	Move Assignment Operator.
virtual	~DataObject ()
	Standard Destructor.
virtual unsigned long	addRef ()
	Add reference to object.
virtual unsigned long	release ()
	release reference to object
const std::string &	name () const
	Retreive DataObject name. It is the name when registered in the store.
virtual StatusCode	update ()
	Provide empty placeholder for internal object reconfiguration callback.
void	setRegistry (IRegistry *pRegistry)
	Set pointer to Registry.
IRegistry *	registry () const
	Get pointer to Registry.
LinkManager *	linkMgr ()
	Retrieve Link manager.
const LinkManager *	linkMgr () const
unsigned char	version () const
	Retrieve version number of this object representation.
void	setVersion (unsigned char vsn)
	Set version number of this object representation.
unsigned long	refCount () const
	Return the refcount.
virtual std::ostream &	fillStream (std::ostream &s) const
	Fill the output stream (ASCII).
Public Member Functions inherited from IVersHistoryObj
virtual	~IVersHistoryObj ()=default

Static Public Member Functions
static const CLID &	classID ()
Static Public Member Functions inherited from HistoryObj
static const CLID &	classID ()
static std::string	convert_string (const std::string &)
Static Public Member Functions inherited from DataObject
static const CLID &	classID ()
	Retrieve reference to class definition structure (static access).

Private Attributes
std::string	m_release_version
std::string	m_dir
std::string	m_cmtconfig
std::string	m_osname
std::string	m_hostname
std::string	m_os_version
std::string	m_machine
std::vector< std::string >	m_environ
PropertyList	m_props
PropertyPairList	m_ppl
std::vector< std::string >	m_CVSid
time_t	m_start_time

Friends
std::ostream &	operator<< (std::ostream &lhs, const JobHistory &rhs)

Additional Inherited Members
Protected Member Functions inherited from HistoryObj
virtual void	indent (std::ostream &, int) const

Detailed Description

JobHistory class definition.

Author: : Charles Leggett

Definition at line 32 of file JobHistory.h.

Member Typedef Documentation

◆ PropertyPairList

typedef std::vector<std::pair<std::string, std::unique_ptr<Gaudi::Property<std::string> > > > JobHistory::PropertyPairList

Definition at line 35 of file JobHistory.h.

Constructor & Destructor Documentation

◆ JobHistory() [1/2]

JobHistory::JobHistory ( )

Definition at line 20 of file JobHistory.cpp.

                       : m_start_time( 0 ) {
 
  time( &m_start_time );
 
  std::string rel;
 
  if ( ( rel = System::getEnv( "ATLAS_BASE_RELEASE" ) ) != "UNKNOWN" ) {
    m_release_version = rel;
  } else if ( ( rel = System::getEnv( "GAUDIROOT" ) ) != "UNKNOWN" ) {
    m_release_version = rel;
  } else {
    m_release_version = "UNKNOWN";
  }
  m_dir       = System::getEnv( "PWD" );
  m_cmtconfig = System::getEnv( "CMTCONFIG" );
 
  m_osname     = System::osName();
  m_hostname   = System::hostName();
  m_os_version = System::osVersion();
  m_machine    = System::machineType();
 
  m_environ = System::getEnv();
}

◆ JobHistory() [2/2]

JobHistory::JobHistory	(	const std::string &	rel,
		const std::string &	os,
		const std::string &	host,
		const std::string &	dir,
		const std::string &	osver,
		const std::string &	mach,
		const std::string &	cmtconfig,
		const time_t &	time )

Definition at line 44 of file JobHistory.cpp.

    : m_release_version( rel )
    , m_dir( dir )
    , m_cmtconfig( cmtconfig )
    , m_osname( os )
    , m_hostname( host )
    , m_os_version( osver )
    , m_machine( mach )
    , m_start_time( time ) {}

◆ ~JobHistory()

JobHistory::~JobHistory ( )

virtualdefault

Member Function Documentation

◆ addProperty()

void JobHistory::addProperty	(	const std::string &	key,
		const std::string &	value )

\fixme strip optional quotes around the string

Definition at line 64 of file JobHistory.cpp.

                                                                           {
  std::string prop_value = value;
  if ( !prop_value.empty() && prop_value[0] == '"' && prop_value[prop_value.size() - 1] == '"' )
    prop_value = prop_value.substr( 1, prop_value.size() - 2 );
 
  std::string client, prop_name;
  auto        pos = key.rfind( '.' );
  if ( pos == std::string::npos ) {
    prop_name = key;
  } else {
    client    = key.substr( 0, pos );
    prop_name = key.substr( pos + 1 );
  }
 
  m_ppl.emplace_back( client, std::make_unique<Gaudi::Property<std::string>>( prop_name, prop_value ) );
}

◆ classID()

const CLID & JobHistory::classID ( )

static

Definition at line 58 of file JobHistory.cpp.

                                {
 
  static const CLID CLID_JobHistory = 247994533;
  return CLID_JobHistory;
}

◆ clID()

const CLID & JobHistory::clID ( ) const

inlineoverridevirtual

Retrieve reference to class definition structure.

Retrieve Pointer to class definition structure.

Reimplemented from HistoryObj.

Definition at line 65 of file JobHistory.h.

65{ return classID(); }

JobHistory::classID

static const CLID & classID()

Definition JobHistory.cpp:58

◆ cmtconfig()

const std::string & JobHistory::cmtconfig ( ) const

inline

Definition at line 78 of file JobHistory.h.

78{ return m_cmtconfig; }

◆ dir()

const std::string & JobHistory::dir ( ) const

inline

Definition at line 77 of file JobHistory.h.

77{ return m_dir; }

◆ dump()

std::ostream & JobHistory::dump	(	std::ostream &	ost,
		bool	isXML,
		int	indent ) const

overridevirtual

Implements HistoryObj.

Definition at line 82 of file JobHistory.cpp.

                                                                             {
 
  if ( !isXML ) {
    ost << "Release: " << release_version() << endl;
    ost << "OS:      " << os() << endl;
    ost << "OS ver:  " << os_version() << endl;
    ost << "Host:    " << hostname() << endl;
    ost << "Machine: " << machine() << endl;
    ost << "Run dir: " << dir() << endl;
    ost << "CMTCONFIG: " << cmtconfig() << endl;
    ost << "Job start time: " << start_time() << endl << endl;
    ost << "Properties: [" << endl;
    ;
    for ( const auto& ipprop : propertyPairs() ) {
      const auto& client = ipprop.first;
      const auto& prop   = ipprop.second;
      ost << client << ":  ";
      prop->fillStream( ost );
      ost << endl;
    }
    ost << "]" << endl;
    for ( const auto& itr : environment() ) ost << itr << endl;
  } else {
  }
 
  return ost;
}

◆ environment()

const std::vector< std::string > & JobHistory::environment ( ) const

inline

Definition at line 79 of file JobHistory.h.

79{ return m_environ; }

◆ hostname()

const std::string & JobHistory::hostname ( ) const

inline

Definition at line 74 of file JobHistory.h.

74{ return m_hostname; }

◆ machine()

const std::string & JobHistory::machine ( ) const

inline

Definition at line 76 of file JobHistory.h.

76{ return m_machine; }

◆ name()

const std::string & JobHistory::name ( ) const

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 86 of file JobHistory.h.

86{ return m_machine; }

◆ os()

const std::string & JobHistory::os ( ) const

inline

Definition at line 73 of file JobHistory.h.

73{ return m_osname; }

◆ os_version()

const std::string & JobHistory::os_version ( ) const

inline

Definition at line 75 of file JobHistory.h.

75{ return m_os_version; }

◆ properties()

const PropertyList & JobHistory::properties ( ) const

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 80 of file JobHistory.h.

80{ return m_props; }

JobHistory::m_props

PropertyList m_props

Definition JobHistory.h:49

◆ propertyPairs()

const PropertyPairList & JobHistory::propertyPairs ( ) const

inline

Definition at line 81 of file JobHistory.h.

81{ return m_ppl; }

◆ release_version()

const std::string & JobHistory::release_version ( ) const

inline

Definition at line 72 of file JobHistory.h.

72{ return m_release_version; }

◆ start_time()

time_t JobHistory::start_time ( ) const

inline

Definition at line 82 of file JobHistory.h.

82{ return m_start_time; }

◆ type()

const std::string & JobHistory::type ( ) const

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 88 of file JobHistory.h.

88{ return m_osname; }

◆ version()

const std::string & JobHistory::version ( ) const

inlineoverridevirtual

Implements IVersHistoryObj.

Definition at line 87 of file JobHistory.h.

87{ return m_release_version; }

◆ operator<<

std::ostream & operator<<	(	std::ostream &	lhs,
		const JobHistory &	rhs )

friend

Definition at line 91 of file JobHistory.h.

91{ return rhs.dump( lhs, false, 0 ); }

JobHistory::dump

std::ostream & dump(std::ostream &, bool isXML, int indent) const override

Definition JobHistory.cpp:82

Member Data Documentation

◆ m_cmtconfig

std::string JobHistory::m_cmtconfig

private

Definition at line 40 of file JobHistory.h.

◆ m_CVSid

std::vector<std::string> JobHistory::m_CVSid

private

Definition at line 52 of file JobHistory.h.

◆ m_dir

std::string JobHistory::m_dir

private

Definition at line 39 of file JobHistory.h.

◆ m_environ

std::vector<std::string> JobHistory::m_environ

private

Definition at line 47 of file JobHistory.h.

◆ m_hostname

std::string JobHistory::m_hostname

private

Definition at line 43 of file JobHistory.h.

◆ m_machine

std::string JobHistory::m_machine

private

Definition at line 45 of file JobHistory.h.

◆ m_os_version

std::string JobHistory::m_os_version

private

Definition at line 44 of file JobHistory.h.

◆ m_osname

std::string JobHistory::m_osname

private

Definition at line 42 of file JobHistory.h.

◆ m_ppl

PropertyPairList JobHistory::m_ppl

private

Definition at line 50 of file JobHistory.h.

◆ m_props

PropertyList JobHistory::m_props

private

Definition at line 49 of file JobHistory.h.

◆ m_release_version

std::string JobHistory::m_release_version

private

Definition at line 38 of file JobHistory.h.

◆ m_start_time

time_t JobHistory::m_start_time

private

Definition at line 53 of file JobHistory.h.

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

GaudiKernel/include/GaudiKernel/JobHistory.h
GaudiKernel/src/Lib/JobHistory.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PropertyPairList

Constructor & Destructor Documentation

◆ JobHistory() [1/2]

◆ JobHistory() [2/2]

◆ ~JobHistory()

Member Function Documentation

◆ addProperty()

◆ classID()

◆ clID()

◆ cmtconfig()

◆ dir()

◆ dump()

◆ environment()

◆ hostname()

◆ machine()

◆ name()

◆ os()

◆ os_version()

◆ properties()

◆ propertyPairs()

◆ release_version()

◆ start_time()

◆ type()

◆ version()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ m_cmtconfig

◆ m_CVSid

◆ m_dir

◆ m_environ

◆ m_hostname

◆ m_machine

◆ m_os_version

◆ m_osname

◆ m_ppl

◆ m_props

◆ m_release_version

◆ m_start_time