JobOptionsSvc Class Reference

#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 extends< BASE, Interfaces >
typedef extends	base_class
	Typedef to this class. More...
typedef extend_interfaces< Interfaces...>	extend_interfaces_base
	Typedef to the base of this class. More...
typedef extends	base_class
	Typedef to this class. More...
typedef extend_interfaces< Interfaces...>	extend_interfaces_base
	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...

Public Member Functions
	JobOptionsSvc (const std::string &name, ISvcLocator *svc)
	~JobOptionsSvc () override=default
	destructor More...
StatusCode	initialize () override
StatusCode	setMyProperties (const std::string &client, IProperty *me) override
	Override default properties of the calling client. More...
StatusCode	addPropertyToCatalogue (const std::string &client, const Property &property) override
	Add a property into the JobOptions catalog. More...
StatusCode	removePropertyFromCatalogue (const std::string &client, const std::string &name) override
	Remove a property from the JobOptions catalog. More...
const std::vector< const Property * > *	getProperties (const std::string &client) const override
	Get the properties associated to a given client. More...
std::vector< std::string >	getClients () const override
	Get the list of clients. More...
StatusCode	readOptions (const std::string &file, const std::string &path="") override
	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
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	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

Detailed Description

Definition at line 20 of file JobOptionsSvc.h.

Member Typedef Documentation

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

Definition at line 22 of file JobOptionsSvc.h.

Constructor & Destructor Documentation

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

Definition at line 26 of file JobOptionsSvc.cpp.

                                                                  :
  base_class(name,svc)
{
  m_pmgr.addRef(); // make sure the refCount doesn't go to zero too soon...
  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          ) ;
}

JobOptionsSvc::~JobOptionsSvc ( )

overridedefault

destructor

Member Function Documentation

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

override

Add a property into the JobOptions catalog.

Definition at line 68 of file JobOptionsSvc.cpp.

{
  std::unique_ptr<Property> p { new StringProperty ( property.name(), "" ) } ;
  if ( !property.load( *p ) ) { return StatusCode::FAILURE ; }
  return m_svc_catalog.addProperty( client , p.release() );
}

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

private

Definition at line 123 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 140 of file JobOptionsSvc.cpp.

                                                               {
  for (const auto&  client : catalog) {
    for (const auto& current : client.second ) {
      addPropertyToCatalogue ( client.first , 
                               StringProperty{ current.NameInClient(), 
                                               current.ValueAsString() } );
    }
  }
}

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

override

Get the list of clients.

Definition at line 118 of file JobOptionsSvc.cpp.

                                                     {
  return m_svc_catalog.getClients();
}

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

override

Get the properties associated to a given client.

Definition at line 85 of file JobOptionsSvc.cpp.

{
  return m_svc_catalog.getProperties(client);
}

StatusCode JobOptionsSvc::getProperty

(

Property *

p

)

const

Definition at line 47 of file JobOptionsSvc.cpp.

{
  return m_pmgr.getProperty( p );
}

StatusCode JobOptionsSvc::initialize ( )

override

Definition at line 52 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 = ""  )

override

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

Definition at line 150 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  )

override

Remove a property from the JobOptions catalog.

Definition at line 78 of file JobOptionsSvc.cpp.

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

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

override

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

Definition at line 90 of file JobOptionsSvc.cpp.

{
  const SvcCatalog::PropertiesT* props =
    m_svc_catalog.getProperties(client);

  if ( !props ){ return StatusCode::SUCCESS; }

  bool fail = false;
  for ( const auto& cur : *props )
  {
    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

)

IProperty implementation (needed for initialisation)

Definition at line 42 of file JobOptionsSvc.cpp.

{
  return m_pmgr.setProperty( p );
}

Member Data Documentation

std::string JobOptionsSvc::m_dir_search_path

private

Definition at line 76 of file JobOptionsSvc.h.

std::string JobOptionsSvc::m_dump

private

Definition at line 77 of file JobOptionsSvc.h.

PropertyMgr JobOptionsSvc::m_pmgr

private

dump the content of Properties catalog to the predefined file

Definition at line 73 of file JobOptionsSvc.h.

std::string JobOptionsSvc::m_source_path

private

Definition at line 74 of file JobOptionsSvc.h.

std::string JobOptionsSvc::m_source_type

private

Definition at line 75 of file JobOptionsSvc.h.

SvcCatalog JobOptionsSvc::m_svc_catalog

private

Definition at line 78 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