#include <src/JobOptionsSvc/JobOptionsSvc.h>

Inheritance diagram for JobOptionsSvc:

Collaboration diagram for JobOptionsSvc:

Public Types
typedef std::vector< const Property * >	PropertiesT

Public Types inherited from extends2< Service, IProperty, IJobOptionsSvc >
typedef extends2	base_class
	Typedef to this class. More...

typedef extend_interfaces2 < IProperty, IJobOptionsSvc >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

Public Types inherited from Service
typedef Gaudi::PluginService::Factory2 < IService , const std::string &, ISvcLocator >	Factory

Public Types inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
typedef CommonMessaging	base_class

Public Types inherited from implements3< IService, IProperty, IStateful >
typedef implements3	base_class
	Typedef to this class. More...

typedef extend_interfaces3 < IService, IProperty, IStateful >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

Public Types inherited from extend_interfaces3< IService, IProperty, IStateful >
typedef mpl::fold< typename IService::iid::iids::type, typename mpl::fold< typename IProperty::iid::iids::type, typename IStateful::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...

Public Types inherited from IInterface
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...

typedef Gaudi::InterfaceId < IInterface, 0, 0 >	iid
	Interface ID. More...

typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...

Public Types inherited from extend_interfaces2< IProperty, IJobOptionsSvc >
typedef mpl::fold< typename IProperty::iid::iids::type, typename IJobOptionsSvc::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...

Public Member Functions
	JobOptionsSvc (const std::string &name, ISvcLocator *svc)

virtual	~JobOptionsSvc ()
	destructor More...

virtual StatusCode	initialize ()
	Initialization (from CONFIGURED to INITIALIZED). More...

virtual StatusCode	finalize ()
	Service finalization method. More...

virtual StatusCode	setMyProperties (const std::string &client, IProperty *me)
	Override default properties of the calling client. More...

virtual StatusCode	addPropertyToCatalogue (const std::string &client, const Property &property)
	Add a property into the JobOptions catalog. More...

virtual StatusCode	removePropertyFromCatalogue (const std::string &client, const std::string &name)
	Remove a property from the JobOptions catalog. More...

virtual const std::vector < const Property * > *	getProperties (const std::string &client) const
	Get the properties associated to a given client. More...

virtual std::vector< std::string >	getClients () const
	Get the list of clients. More...

virtual StatusCode	readOptions (const std::string &file, const std::string &path="")
	look for file 'file' into search path 'path' and read it to update existing JobOptionsCatalogue More...

StatusCode	setProperty (const Property &p)
	IProperty implementation (needed for initialisation) More...

StatusCode	getProperty (Property *p) const
	Get the property by property. More...

Public Member Functions inherited from extends2< Service, IProperty, IJobOptionsSvc >
	extends2 (A1 a1, A2 a2, A3 a3)
	Templated constructor with 3 arguments. More...

	extends2 (A1 a1, A2 a2)
	Templated constructor with 2 arguments. More...

	extends2 (A1 a1)
	Templated constructor with 1 argument. More...

	extends2 ()
	Default constructor. More...

virtual void *	i_cast (const InterfaceID &tid) const
	Implementation of IInterface::i_cast. More...

virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)
	Implementation of IInterface::queryInterface. More...

virtual std::vector< std::string >	getInterfaceNames () const
	Implementation of IInterface::getInterfaceNames. More...

virtual	~extends2 ()
	Virtual destructor. More...

Public Member Functions inherited from Service
virtual unsigned long	release ()
	Release Interface instance. More...

virtual const std::string &	name () const
	Retrieve name of the service. More...

virtual StatusCode	configure ()
	Configuration (from OFFLINE to CONFIGURED). More...

virtual StatusCode	start ()
	Start (from INITIALIZED to RUNNING). More...

virtual StatusCode	stop ()
	Stop (from RUNNING to INITIALIZED). More...

virtual StatusCode	terminate ()
	Initialization (from CONFIGURED to OFFLINE). More...

virtual Gaudi::StateMachine::State	FSMState () const
	Get the current state. More...

virtual Gaudi::StateMachine::State	targetFSMState () const
	When we are in the middle of a transition, get the state where the transition is leading us. More...

virtual StatusCode	reinitialize ()
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...

virtual StatusCode	restart ()
	Initialization (from RUNNING to RUNNING, via INITIALIZED). More...

virtual StatusCode	sysInitialize ()
	Initialize Service. More...

virtual StatusCode	sysStart ()
	Initialize Service. More...

virtual StatusCode	sysStop ()
	Initialize Service. More...

virtual StatusCode	sysFinalize ()
	Finalize Service. More...

virtual StatusCode	sysReinitialize ()
	Re-initialize the Service. More...

virtual StatusCode	sysRestart ()
	Re-initialize the Service. More...

virtual StatusCode	setProperty (const std::string &s)
	Set the property by string. More...

virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Set the property by std::string. More...

virtual const Property &	getProperty (const std::string &name) const
	Get the property by name. More...

virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Get the property by std::string. More...

virtual const std::vector < Property * > &	getProperties () const
	Get list of properties. More...

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

	Service (const std::string &name, ISvcLocator *svcloc)
	Standard Constructor. More...

SmartIF< ISvcLocator > &	serviceLocator () const
	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<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 >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
	CommonMessaging (const A1 &a1, const A2 &a2, const A3 &a3)
	Templated constructor with 3 arguments. More...

	CommonMessaging (const A1 &a1, const A2 &a2)
	Templated constructor with 2 arguments. More...

	CommonMessaging (const A1 &a1)
	Templated constructor with 1 argument. More...

	CommonMessaging ()
	Default constructor. More...

virtual	~CommonMessaging ()
	Virtual destructor. More...

SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Public Member Functions inherited from extend_interfaces3< IService, IProperty, IStateful >
virtual	~extend_interfaces3 ()
	Virtual destructor. More...

Public Member Functions inherited from IService
	DeclareInterfaceID (IService, 3, 0)
	InterfaceID. More...

virtual	~IService ()
	virtual destructor More...

Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. More...

virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes). More...

Public Member Functions inherited from IInterface
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...

virtual unsigned long	refCount () const =0
	Current reference count. More...

virtual	~IInterface ()
	Virtual destructor. More...

Public Member Functions inherited from IProperty
	DeclareInterfaceID (IProperty, 2, 0)
	InterfaceID. More...

Public Member Functions inherited from IStateful
	DeclareInterfaceID (IStateful, 1, 0)
	InterfaceID. More...

virtual	~IStateful ()

Public Member Functions inherited from extend_interfaces2< IProperty, IJobOptionsSvc >
virtual	~extend_interfaces2 ()
	Virtual destructor. More...

Public Member Functions inherited from IJobOptionsSvc
	DeclareInterfaceID (IJobOptionsSvc, 4, 0)
	InterfaceID. More...

Private Member Functions
void	fillServiceCatalog (const Gaudi::Parsers::Catalog &catalog)

void	dump (const std::string &file, const Gaudi::Parsers::Catalog &catalog) const

Private Attributes
PropertyMgr	m_pmgr
	dump the content of Properties catalog to the predefined file More...

std::string	m_source_path

std::string	m_source_type

std::string	m_dir_search_path

std::string	m_dump

SvcCatalog	m_svc_catalog

Additional Inherited Members
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Protected Member Functions inherited from Service
virtual	~Service ()
	Standard Destructor. More...

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel
	Service output level. More...

Gaudi::StateMachine::State	m_state
	Service state. More...

Gaudi::StateMachine::State	m_targetState
	Service state. More...

Protected Attributes inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
SmartIF< IMessageSvc >	m_msgsvc
	Pointer to the message service;. More...

std::auto_ptr< MsgStream >	m_msgStream
	The predefined message stream. More...

bool	m_streamWithService
	Flag to create a new MsgStream if it was created without the message service. More...

Detailed Description

Definition at line 21 of file JobOptionsSvc.h.

Member Typedef Documentation

typedef std::vector<const Property*> JobOptionsSvc::PropertiesT

Definition at line 23 of file JobOptionsSvc.h.

Constructor & Destructor Documentation

JobOptionsSvc::JobOptionsSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Definition at line 30 of file JobOptionsSvc.cpp.

                                                                   :
 base_class(name,svc),
 m_pmgr()
 , m_source_path()
 , m_source_type()
 , m_dir_search_path()
 , m_dump()
 {
   std::string tmp ;
   tmp = System::getEnv ( "JOBOPTSEARCHPATH" ) ;
   if ( !tmp.empty() && ("UNKNOWN" != tmp) ) { m_dir_search_path = tmp ; }
   tmp = System::getEnv ( "JOBOPTSDUMPFILE"  ) ;
   if ( !tmp.empty() && ("UNKNOWN" != tmp) ) { m_dump = tmp ; }
 
   m_pmgr.declareProperty( "TYPE"       , m_source_type   ) ;
   m_pmgr.declareProperty( "PATH"       , m_source_path   ) ;
   m_pmgr.declareProperty( "SEARCHPATH" , m_dir_search_path ) ;
   m_pmgr.declareProperty( "DUMPFILE"   , m_dump          ) ;
 }

virtual JobOptionsSvc::~JobOptionsSvc ( )

inlinevirtual

destructor

Definition at line 31 of file JobOptionsSvc.h.

31 {};

Member Function Documentation

StatusCode JobOptionsSvc::addPropertyToCatalogue	(	const std::string &	client,
		const Property &	property
	)

virtual

Add a property into the JobOptions catalog.

Implements IJobOptionsSvc.

Definition at line 83 of file JobOptionsSvc.cpp.

 {
   Property* p = new StringProperty ( property.name(), "" ) ;
   if ( !property.load( *p ) ) { delete p ; return StatusCode::FAILURE ; }
   return m_svc_catalog.addProperty( client , p );
 }

void JobOptionsSvc::dump	(	const std::string &	file,
		const Gaudi::Parsers::Catalog &	catalog
	)		const

private

Definition at line 139 of file JobOptionsSvc.cpp.

                                     {
   MsgStream log ( msgSvc() , name() ) ;
   std::ofstream out
     ( file.c_str() , std::ios_base::out | std::ios_base::trunc ) ;
   // perform the actual dumping
   if ( !out ) {
     log << MSG::ERROR << "Unable to open dump-file \""+file+"\"" << endmsg ;
     return ;                                                   // RETURN
   }
   else {
     log << MSG::INFO << "Properties are dumped into \""+file+"\"" << endmsg ;
   }
   // perform the actual dump:
   out << catalog;
 }

void JobOptionsSvc::fillServiceCatalog ( const Gaudi::Parsers::Catalog & catalog )

private

Definition at line 156 of file JobOptionsSvc.cpp.

                                                                {
   BOOST_FOREACH(const gp::Catalog::value_type& client, catalog) {
     for (gp::Catalog::CatalogSet::mapped_type::const_iterator current
           = client.second.begin(); current != client.second.end();
                                                                   ++current) {
       StringProperty tmp (current->NameInClient(), current->ValueAsString()) ;
       addPropertyToCatalogue ( client.first , tmp ) ;
     }
   }
 }

StatusCode JobOptionsSvc::finalize ( )

virtual

Service finalization method.

Reimplemented from Service.

Definition at line 76 of file JobOptionsSvc.cpp.

 {
   // finalize the base class
   return Service::finalize();
 }

std::vector< std::string > JobOptionsSvc::getClients ( ) const

virtual

Get the list of clients.

Implements IJobOptionsSvc.

Definition at line 134 of file JobOptionsSvc.cpp.

                                                      {
   return m_svc_catalog.getClients();
 }

const JobOptionsSvc::PropertiesT * JobOptionsSvc::getProperties ( const std::string & client ) const

virtual

Get the properties associated to a given client.

Implements IJobOptionsSvc.

Definition at line 100 of file JobOptionsSvc.cpp.

 {
   return m_svc_catalog.getProperties(client);
 }

StatusCode JobOptionsSvc::getProperty ( Property * p ) const

virtual

Get the property by property.

Reimplemented from Service.

Definition at line 55 of file JobOptionsSvc.cpp.

 {
 
   return m_pmgr.getProperty( p );
 }

StatusCode JobOptionsSvc::initialize ( )

virtual

Initialization (from CONFIGURED to INITIALIZED).

Reimplemented from Service.

Definition at line 61 of file JobOptionsSvc.cpp.

 {
   // Call base class initializer
   StatusCode sc = Service::initialize();
   if( !sc.isSuccess() ) return sc;
   // Read the job options if needed
   if ( this->m_source_type == "NONE" ) {
     sc =  StatusCode::SUCCESS;
   }
   else {
     sc = this->readOptions( m_source_path , m_dir_search_path);
   }
   return sc;
 }

StatusCode JobOptionsSvc::readOptions	(	const std::string &	file,
		const std::string &	path = `""`
	)

virtual

look for file 'file' into search path 'path' and read it to update existing JobOptionsCatalogue

Parameters

file	file name
path	search path

Returns: status code

Implements IJobOptionsSvc.

Definition at line 167 of file JobOptionsSvc.cpp.

                               {
     std::string search_path = path;
     if ( search_path.empty() && !m_dir_search_path.empty() )
     { search_path =  m_dir_search_path ; }
     //
     MsgStream my_log( this->msgSvc(), this->name() );
     if (UNLIKELY(outputLevel() <= MSG::DEBUG))
       my_log << MSG::DEBUG                             // debug
              << "Reading options from the file "
              << "'" << file << "'" << endmsg;
     gp::Messages messages(my_log);
     gp::Catalog catalog;
     gp::Units units;
     gp::PragmaOptions pragma;
     gp::Node ast;
     StatusCode sc = gp::ReadOptions(file, path, &messages, &catalog, &units,
         &pragma, &ast);
 
     // --------------------------------------------------------------------------
     if ( sc.isSuccess() )
     {
       if (pragma.IsPrintOptions()) {
         my_log << MSG::INFO << "Print options" << std::endl << catalog
             << endmsg;
       }
       if (pragma.IsPrintTree()) {
         my_log << MSG::INFO << "Print tree:" << std::endl << ast.ToString()
             << endmsg;
       }
       if (pragma.HasDumpFile()) {
         dump(pragma.dumpFile(), catalog);
       }
       my_log << MSG::INFO
              << "Job options successfully read in from " << file << endmsg;
       fillServiceCatalog(catalog);
     }
     else
     {
       my_log << MSG::FATAL << "Job options errors."<< endmsg;
     }
     // ----------------------------------------------------------------------------
     return sc;
 }

StatusCode JobOptionsSvc::removePropertyFromCatalogue	(	const std::string &	client,
		const std::string &	name
	)

virtual

Remove a property from the JobOptions catalog.

Implements IJobOptionsSvc.

Definition at line 93 of file JobOptionsSvc.cpp.

 {
   return m_svc_catalog.removeProperty(client,name);
 }

StatusCode JobOptionsSvc::setMyProperties	(	const std::string &	client,
		IProperty *	me
	)

virtual

Override default properties of the calling client.

Parameters

client	Name of the client algorithm or service
me	Address of the interface IProperty of the client

Implements IJobOptionsSvc.

Definition at line 105 of file JobOptionsSvc.cpp.

 {
   const SvcCatalog::PropertiesT* props =
     m_svc_catalog.getProperties(client);
 
   if ( NULL == props ){ return StatusCode::SUCCESS; }
 
   bool fail = false;
   for ( std::vector<const Property*>::const_iterator cur = props->begin();
     cur != props->end(); cur++)
   {
     StatusCode sc = myInt->setProperty (**cur ) ;
     if ( sc.isFailure() )
     {
       MsgStream my_log( this->msgSvc(), this->name() );
       my_log
         << MSG::ERROR
         << "Unable to set the property '" << (*cur)->name() << "'"
         <<                        " of '" << client         << "'. "
         << "Check option and algorithm names, type and bounds."
         << endmsg;
       fail = true;
     }
   }
   return fail ? StatusCode::FAILURE : StatusCode::SUCCESS ;
 }

StatusCode JobOptionsSvc::setProperty ( const Property & p )

virtual

IProperty implementation (needed for initialisation)

Reimplemented from Service.

Definition at line 50 of file JobOptionsSvc.cpp.

 {
   return m_pmgr.setProperty( p );
 }

Member Data Documentation

std::string JobOptionsSvc::m_dir_search_path

private

Definition at line 79 of file JobOptionsSvc.h.

std::string JobOptionsSvc::m_dump

private

Definition at line 80 of file JobOptionsSvc.h.

PropertyMgr JobOptionsSvc::m_pmgr

private

dump the content of Properties catalog to the predefined file

Definition at line 76 of file JobOptionsSvc.h.

std::string JobOptionsSvc::m_source_path

private

Definition at line 77 of file JobOptionsSvc.h.

std::string JobOptionsSvc::m_source_type

private

Definition at line 78 of file JobOptionsSvc.h.

SvcCatalog JobOptionsSvc::m_svc_catalog

private

Definition at line 81 of file JobOptionsSvc.h.

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

GaudiCoreSvc/src/JobOptionsSvc/JobOptionsSvc.h
GaudiCoreSvc/src/JobOptionsSvc/JobOptionsSvc.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation