Trivial Algorithm for tutorial purposes. More...

#include </builds/gaudi/Gaudi/GaudiTestSuite/src/Properties/PropertyAlg.h>

Inheritance diagram for PropertyAlg:

[legend]

Collaboration diagram for PropertyAlg:

[legend]

Public Member Functions
	PropertyAlg (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor of this form must be provided.

StatusCode	initialize () override
	Three mandatory member functions of any algorithm.

StatusCode	execute () override

StatusCode	finalize () override

void	readHandler (Gaudi::Details::PropertyBase &)
	Callbacks for properties.

void	updateHandler (Gaudi::Details::PropertyBase &)

Public Member Functions inherited from Algorithm
	LegacyAlgorithmAdapter (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)

Public Member Functions inherited from Gaudi::details::LegacyAlgorithmAdapter
	LegacyAlgorithmAdapter (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)

const EventContext &	getContext () const

bool	isExecuted () const
	Has this algorithm been executed since the last reset?

void	setExecuted (bool state) const
	Set the executed flag to the specified state.

bool	filterPassed () const
	Did this algorithm pass or fail its filter criterion for the last event?

void	setFilterPassed (bool state) const
	Set the filter passed flag to the specified state.

Public Member Functions inherited from Gaudi::Algorithm
	Algorithm (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)
	Constructor.

StatusCode	sysStart () override
	Reinitialization method invoked by the framework.

StatusCode	sysInitialize () override
	Initialization method invoked by the framework.

StatusCode	sysReinitialize () override
	Reinitialization method invoked by the framework.

StatusCode	sysRestart () override
	Restart method invoked by the framework.

StatusCode	sysExecute (const EventContext &ctx) override
	The actions to be performed by the algorithm on an event.

StatusCode	sysStop () override
	System stop.

StatusCode	sysFinalize () override
	System finalization.

const std::string &	name () const override
	The identifying name of the algorithm object.

const Gaudi::StringKey &	nameKey () const override

const std::string &	type () const override
	The type of the algorithm object.

void	setType (std::string type) override

const std::string &	version () const override

unsigned int	index () const override

StatusCode	configure () override
	Dummy implementation of IStateful::configure() method.

StatusCode	terminate () override
	Dummy implementation of IStateful::terminate() method.

StatusCode	initialize () override
	the default (empty) implementation of IStateful::initialize() method

StatusCode	start () override
	the default (empty) implementation of IStateful::start() method

StatusCode	stop () override
	the default (empty) implementation of IStateful::stop() method

StatusCode	finalize () override
	the default (empty) implementation of IStateful::finalize() method

StatusCode	reinitialize () override
	the default (empty) implementation of IStateful::reinitialize() method

StatusCode	restart () override
	the default (empty) implementation of IStateful::restart() method

Gaudi::StateMachine::State	FSMState () const override
	returns the current state of the algorithm

Gaudi::StateMachine::State	targetFSMState () const override
	returns the state the algorithm will be in after the ongoing transition

bool	isEnabled () const override
	Is this algorithm enabled or disabled?

bool	isSequence () const override
	Are we a Sequence?

unsigned int	errorCount () const
	Get the number of failures of the algorithm.

SmartIF< IService >	service (std::string_view name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name")

template<class T>
SmartIF< T >	service (std::string_view name, bool createIf=true, bool quiet=false) const

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

SmartIF< IChronoStatSvc > &	chronoSvc () const
	The standard Chrono & Stat service, Return a pointer to the service if present.

SmartIF< IDataProviderSvc > &	detSvc () const
	The standard detector data service.

SmartIF< IConversionSvc > &	detCnvSvc () const
	The standard detector data persistency conversion service.

SmartIF< IDataProviderSvc > &	eventSvc () const
	The standard event data service.

SmartIF< IDataProviderSvc > &	evtSvc () const
	shortcut for method eventSvc

SmartIF< IConversionSvc > &	eventCnvSvc () const
	The standard event data persistency conversion service.

SmartIF< IHistogramSvc > &	histoSvc () const
	The standard histogram service.

SmartIF< INTupleSvc > &	ntupleSvc () const
	The standard N tuple service.

SmartIF< IRndmGenSvc > &	randSvc () const
	The standard RandomGen service, Return a pointer to the service if present.

SmartIF< IToolSvc > &	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present.

SmartIF< IExceptionSvc > &	exceptionSvc () const
	Get the exception Service.

SmartIF< IAlgContextSvc > &	contextSvc () const
	get Algorithm Context Service

SmartIF< ITimelineSvc > &	timelineSvc () const

SmartIF< ISvcLocator > &	serviceLocator () const override
	The standard service locator.

SmartIF< ISvcLocator > &	svcLoc () const
	shortcut for method serviceLocator

SmartIF< IHiveWhiteBoard > &	whiteboard () const

SmartIF< IAlgExecStateSvc > &	algExecStateSvc () const

bool	registerContext () const
	register for Algorithm Context Service?

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

SmartIF< IMonitorSvc > &	monitorSvc () const
	Access the monitor service.

template<class T>
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information.

void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case)

void	acceptDHVisitor (IDataHandleVisitor *) const override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

bool	isAsynchronous () const

void	setAsynchronous (bool value)

unsigned int	cardinality () const override
	Return the cardinality.

const std::vector< std::string > &	neededResources () const override

AlgExecStateRef	execState (const EventContext &ctx) const override
	get the AlgExecStateRef of current algorithm Actually a small wrapper around it, thus the plain object return type

std::ostream &	toControlFlowExpression (std::ostream &os) const override
	Produce string represention of the control flow expression.

Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
std::vector< Gaudi::DataHandle * >	inputHandles () const override

std::vector< Gaudi::DataHandle * >	outputHandles () const override

virtual const DataObjIDColl &	extraInputDeps () const override

virtual const DataObjIDColl &	extraOutputDeps () const override

void	declare (Gaudi::DataHandle &handle) override

void	renounce (Gaudi::DataHandle &handle) override

bool	renounceInput (const DataObjID &id) override

const DataObjIDColl &	inputDataObjs () const override

const DataObjIDColl &	outputDataObjs () const override

void	addDependency (const DataObjID &id, const Gaudi::DataHandle::Mode &mode) override

Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

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

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

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

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

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

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

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

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

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

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

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

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

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

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

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

Private Attributes
Gaudi::Property< int >	m_int { this, "Int", 100 }
	These data members are used in the execution of this algorithm They are set in the initialization phase by the job options service.

Gaudi::Property< long long >	m_int64 { this, "Int64", 100 }

Gaudi::Property< unsigned long long >	m_uint64 { this, "UInt64", 100 }

Gaudi::Property< double >	m_double { this, "Double", 100. }

Gaudi::Property< std::string >	m_string { this, "String", "hundred" }

Gaudi::Property< bool >	m_bool { this, "Bool", true }

Gaudi::Property< std::vector< int > >	m_intarray { this, "IntArray" }

Gaudi::Property< std::vector< long long > >	m_int64array { this, "Int64Array" }

Gaudi::Property< std::vector< unsigned long long > >	m_uint64array { this, "UInt64Array" }

Gaudi::Property< std::vector< double > >	m_doublearray { this, "DoubleArray" }

Gaudi::Property< std::vector< std::string > >	m_stringarray { this, "StringArray" }

Gaudi::Property< std::vector< bool > >	m_boolarray { this, "BoolArray" }

Gaudi::Property< std::vector< double > >	m_emptyarray { this, "EmptyArray" }

Gaudi::Property< std::vector< double > >	u_doublearrayunits { this, "DoubleArrayWithUnits" }

Gaudi::Property< std::vector< double > >	u_doublearray { this, "DoubleArrayWithoutUnits" }

Gaudi::Property< std::vector< std::pair< int, int > > >	u_intpairarray { this, "IntPairArray" }

Gaudi::Property< std::vector< std::pair< double, double > > >	u_doublepairarray { this, "DoublePairArray" }

Gaudi::Property< std::set< int > >	m_intset { this, "IntSet" }

Gaudi::Property< std::set< std::string > >	m_stringset { this, "StringSet" }

Gaudi::Property< std::unordered_set< float > >	m_floatuset { this, "FloatUnorderedSet" }

Gaudi::Property< std::map< std::string, std::string > >	m_strmap { this, "StringMap" }

Gaudi::CheckedProperty< int >	p_int { this, "PInt", 100, "An integer property" }

Gaudi::PropertyWithReadHandler< double >	p_double { this, "PDouble", 100. }

Gaudi::Property< std::string >	p_string { this, "PString", "hundred" }

Gaudi::Property< bool >	p_bool { this, "PBool", false }

Gaudi::Property< std::vector< int > >	p_intarray { this, "PIntArray" }

Gaudi::Property< std::vector< double > >	p_doublearray { this, "PDoubleArray" }

Gaudi::Property< std::vector< std::string > >	p_stringarray { this, "PStringArray" }

Gaudi::Property< std::vector< bool > >	p_boolarray { this, "PBoolArray" }

Additional Inherited Members
Public Types inherited from Gaudi::Algorithm
typedef Gaudi::PluginService::Factory< IAlgorithm (const std::string &, ISvcLocator )>	Factory

Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Public Attributes inherited from Gaudi::Algorithm
friend	AlgorithmManager

Protected Member Functions inherited from Gaudi::details::LegacyAlgorithmAdapter
bool	isReEntrant () const override

Protected Member Functions inherited from Gaudi::Algorithm
std::vector< IAlgTool * > &	tools ()

bool	isInitialized () const override
	Has the Algorithm already been initialized?

bool	isFinalized () const override
	Has the Algorithm already been finalized?

void	setIndex (const unsigned int &idx) override
	set instantiation index of Alg

bool	isReEntrant () const override

Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
void	initDataHandleHolder ()
	initializes all handles - called by the sysInitialize method of any descendant of this

Protected Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes inherited from Gaudi::Algorithm
std::unique_ptr< IDataHandleVisitor >	m_updateDataHandles
	Hook for for derived classes to provide a custom visitor for data handles.

Protected Attributes inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl	m_inputDataObjs

DataObjIDColl	m_outputDataObjs

Detailed Description

Trivial Algorithm for tutorial purposes.

Author: nobody

Definition at line 28 of file PropertyAlg.h.

Constructor & Destructor Documentation

◆ PropertyAlg()

PropertyAlg::PropertyAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Constructor of this form must be provided.

Definition at line 52 of file PropertyAlg.cpp.

                                                                   : Algorithm( name, ploc ) {
  //------------------------------------------------------------------------------
  // Associate read and update handlers
 
  p_double.declareUpdateHandler( &PropertyAlg::updateHandler, this );
  p_double.declareReadHandler( &PropertyAlg::readHandler, this );
 
  {
    // do not print messages if we are created in genconf
    const std::string cmd = System::cmdLineArgs()[0];
    if ( cmd.find( "genconf" ) != std::string::npos ) return;
  }
 
  info() << "Before Initialization......" << endmsg;
 
  info() << "Int    = " << m_int.value() << endmsg;
  info() << "Int64  = " << m_int64.value() << endmsg;
  info() << "UInt64 = " << m_uint64.value() << endmsg;
  info() << "Double = " << m_double.value() << endmsg;
  info() << "String = " << m_string.value() << endmsg;
  info() << "Bool   = " << m_bool.value() << endmsg;
  info() << "IntArray    = " << m_intarray.value() << endmsg;
  info() << "Int64Array  = " << m_int64array.value() << endmsg;
  info() << "UInt64Array = " << m_uint64array.value() << endmsg;
  info() << "DoubleArray = " << m_doublearray.value() << endmsg;
  info() << "StringArray = " << m_stringarray.value() << endmsg;
  info() << "BoolArray   = " << m_boolarray.value() << endmsg;
  info() << "EmptyArray  = " << m_emptyarray.value() << endmsg;
  info() << "IntPairArray  = " << u_intpairarray.value() << endmsg;
  info() << "DoublePairArray  = " << u_doublepairarray.value() << endmsg;
  info() << "IntSet = " << m_intset.value() << endmsg;
  info() << "StringSet = " << m_stringset.value() << endmsg;
  info() << "FloatUnorderedSet = " << m_floatuset.value() << endmsg;
 
  info() << "PInt    = " << p_int << endmsg;
  std::ostringstream os;
  os << p_double; // avoid read handler from printing _during_ info()!
  info() << "PDouble = " << os.str() << endmsg;
  info() << "PString = " << p_string << endmsg;
  info() << "PBool   = " << p_bool << endmsg;
  info() << "PIntArray    = " << p_intarray << endmsg;
  info() << "PDoubleArray = " << p_doublearray << endmsg;
  info() << "PStringArray = " << p_stringarray << endmsg;
  info() << "PBoolArray   = " << p_boolarray << endmsg;
}

Member Function Documentation

◆ execute()

StatusCode PropertyAlg::execute ( )

overridevirtual

Implements Algorithm.

Definition at line 286 of file PropertyAlg.cpp.

                                {
  //------------------------------------------------------------------------------
  info() << "executing...." << endmsg;
  return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode PropertyAlg::finalize ( )

override

Definition at line 293 of file PropertyAlg.cpp.

                                 {
  //------------------------------------------------------------------------------
  info() << "finalizing...." << endmsg;
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode PropertyAlg::initialize ( )

override

Three mandatory member functions of any algorithm.

Definition at line 99 of file PropertyAlg.cpp.

                                   {
  //------------------------------------------------------------------------------
 
  //
  // Checking the JobOptions interface. Be able to set the properties
  //
  info() << "After Initialization having read the JobOptions file..." << endmsg;
 
  info() << "Int    = " << m_int.value() << endmsg;
  info() << "Int64  = " << m_int64.value() << endmsg;
  info() << "UInt64 = " << m_uint64.value() << endmsg;
  info() << "Double = " << m_double.value() << endmsg;
  info() << "String = " << m_string.value() << endmsg;
  info() << "Bool   = " << m_bool.value() << endmsg;
  info() << "IntArray    = " << m_intarray.value() << endmsg;
  info() << "Int64Array  = " << m_int64array.value() << endmsg;
  info() << "UInt64Array = " << m_uint64array.value() << endmsg;
  info() << "DoubleArray = " << m_doublearray.value() << endmsg;
  info() << "StringArray = " << m_stringarray.value() << endmsg;
  info() << "BoolArray   = " << m_boolarray.value() << endmsg;
  info() << "EmptyArray  = " << m_emptyarray.value() << endmsg;
  info() << "IntPairArray  = " << u_intpairarray.value() << endmsg;
  info() << "DoublePairArray  = " << u_doublepairarray.value() << endmsg;
  info() << "IntSet = " << m_intset.value() << endmsg;
  info() << "StringSet = " << m_stringset.value() << endmsg;
  info() << "FloatUnorderedSet = " << m_floatuset.value() << endmsg;
  info() << "StringMap = " << m_strmap << endmsg;
 
  info() << "PInt    = " << p_int << endmsg;
  std::ostringstream os;
  os << p_double; // avoid read handler from printing _during_ info()!
  info() << "PDouble = " << os.str() << endmsg;
  info() << "PString = " << p_string << endmsg;
  info() << "PBool   = " << p_bool << endmsg;
  info() << "PIntArray    = " << p_intarray << endmsg;
  info() << "PDoubleArray = " << p_doublearray << endmsg;
  info() << "PStringArray = " << p_stringarray << endmsg;
  info() << "PBoolArray   = " << p_boolarray << endmsg;
  //
  // Checking units
  //
  auto& doublearrayunits = u_doublearrayunits.value();
  auto& doublearray      = u_doublearray.value();
  for ( unsigned int i = 0; i < doublearrayunits.size(); i++ ) {
 
    if ( !essentiallyEqual( doublearrayunits[i], doublearray[i] ) ) {
      error() << format( "DoubleArrayWithUnits[%d] = %g and should be %g", i, doublearrayunits[i], doublearray[i] )
              << endmsg;
    } else {
      info() << format( "DoubleArrayWithUnits[%d] = %g", i, doublearrayunits[i] ) << endmsg;
    }
  }
 
  //
  // Checking the Property Verifier
  //
  info() << "===============Checking Property Verifier ===============" << endmsg;
 
  info() << "Playing with PropertyVerifiers..." << endmsg;
 
  p_int.verifier().setBounds( 0, 200 );
  p_int = 155;
  // info() << "PInt= " << p_int << " [should be 155, bounds are " <<
  //                     p_int.verifier().lower() << ", " <<
  //                     p_int.verifier().upper() << " ]" << endmsg;
  info() << format( "PInt= %d [should be 155, bounds are %d, %d]", (int)p_int, (int)p_int.verifier().lower(),
                    (int)p_int.verifier().upper() )
         << endmsg;
  try {
    p_int = 255;
  } catch ( ... ) { info() << "Got an exception when setting a value outside bounds" << endmsg; }
  info() << "PInt= " << p_int << " [should be 155]" << endmsg;
 
  //
  //  Checking the Property CallBacks
  //
  info() << "===============Checking Property CallBaks ===============" << endmsg;
 
  double d;
  info() << "Accessing PDouble ... " << endmsg;
  d = p_double;
 
  info() << "Value obtained is: " << d << endmsg;
 
  info() << "Updating PDouble ... " << endmsg;
  p_double = 999.;
 
  //
  //  Checking Accessing Properties by string
  //
 
  info() << "==========Checking Accesing Properties by string=========" << endmsg;
 
  auto appmgr = serviceLocator()->as<IProperty>();
  // StatusCode sc = serviceLocator()->service("ApplicationMgr", appmgr);
  if ( !appmgr ) {
    error() << "Unable to locate the ApplicationMgr" << endmsg;
  } else {
    std::string value( "empty" );
    appmgr->getProperty( "ExtSvc", value ).ignore();
    info() << " Got property ApplicationMgr.ExtSvc = " << value << ";" << endmsg;
 
    appmgr->setPropertyRepr( "ExtSvc", "[\"EvtDataSvc/EventDataSvc\", \"DetDataSvc/DetectorDataSvc\"]" ).ignore();
    info() << " Set property ApplicationMgr.ExtSvc = "
           << " [\"EvtDataSvc/EventDataSvc\", \"DetDataSvc/DetectorDataSvc\"]"
           << ";" << endmsg;
    appmgr->getProperty( "ExtSvc", value ).ignore();
    info() << " Got property ApplicationMgr.ExtSvc = " << value << ";" << endmsg;
 
    appmgr->setPropertyRepr( "ExtSvc", "[ 'EventDataSvc', 'DetectorDataSvc']" ).ignore();
    info() << " Set property ApplicationMgr.ExtSvc = "
           << " [ 'EventDataSvc', 'DetectorDataSvc']"
           << ";" << endmsg;
    appmgr->getProperty( "ExtSvc", value ).ignore();
    info() << " Got property ApplicationMgr.ExtSvc = " << value << ";" << endmsg;
  }
  // Testing setting bool
  std::vector<std::tuple<std::string, bool>> cases = {
      std::make_tuple( "true", true ),   std::make_tuple( "false", false ), std::make_tuple( "True", true ),
      std::make_tuple( "False", false ), std::make_tuple( "TRUE", true ),   std::make_tuple( "FALSE", false ),
      std::make_tuple( "T", true ),  // not expected to work
      std::make_tuple( "F", false ), // not expected to work
      std::make_tuple( "10", true ), // not expected to work
  };
  StatusCode sc = StatusCode::SUCCESS;
  for ( auto& c : cases ) {
    p_bool = m_bool = !std::get<1>( c );
    try {
      sc = setPropertyRepr( "PBool", std::get<0>( c ) );
    } catch ( ... ) { sc = StatusCode::FAILURE; }
    if ( !sc || ( p_bool != std::get<1>( c ) ) ) {
      error() << "PBool can not be set to " << std::get<0>( c ) << endmsg;
    }
    try {
      sc = setPropertyRepr( "Bool", std::get<0>( c ) );
    } catch ( ... ) { sc = StatusCode::FAILURE; }
    if ( !sc || ( m_bool != std::get<1>( c ) ) ) { error() << "Bool can not be set to " << std::get<0>( c ) << endmsg; }
  }
 
  // Testing the control of the output level directly from MessageSvc
  MsgStream newlog( msgSvc(), "MsgTest" );
  newlog << MSG::VERBOSE << "This should be printed if threshold is VERBOSE" << endmsg;
  newlog << MSG::DEBUG << "This should be printed if threshold is DEBUG" << endmsg;
  newlog << MSG::INFO << "This should be printed if threshold is INFO" << endmsg;
  newlog << MSG::WARNING << "This should be printed if threshold is WARNING" << endmsg;
  newlog << MSG::ERROR << "This should be printed if threshold is ERROR" << endmsg;
  newlog << MSG::FATAL << "This should be printed if threshold is FATAL" << endmsg;
  newlog << MSG::ALWAYS << "This should be printed ALWAYS" << endmsg;
 
  // Testing access to the JobOptions catalogue
  auto& opts = serviceLocator()->getOptsSvc();
 
  // Dump of the catalogue
  info() << "=================================================" << endmsg;
  using GaudiUtils::details::ostream_joiner;
  auto opt_items = opts.items(); // this copy is just to hide differences between gcc and clang outputs
  ostream_joiner( info() << "Dump of the property catalogue:\n", opt_items, '\n',
                  []( MsgStream& os, const auto& item ) -> MsgStream& {
                    return os << std::get<0>( item ) << ": " << std::get<1>( item );
                  } )
      << endmsg;
  info() << "=================================================" << endmsg;
 
  // Change an option of my own....
  opts.set( name() + '.' + "PInt", "154" );
  info() << "PInt= " << p_int << " [should be 154]" << endmsg;
 
  auto orig_policy =
      Gaudi::Details::Property::setParsingErrorPolicy( Gaudi::Details::Property::ParsingErrorPolicy::Exception );
  try {
    info() << "Try to assign invalid value to DoubleArray" << endmsg;
    opts.set( name() + '.' + "DoubleArray", "{\"12.12\", \"13.13\"}" );
  } catch ( const GaudiException& exc ) { error() << "got exception: " << exc.what() << endmsg; }
 
  try {
    info() << "Try to assign invalid value to StringMap" << endmsg;
    opts.set( name() + '.' + "StringMap", "{\"one\", {\"une\", \"eins\"}}" );
  } catch ( const GaudiException& exc ) { error() << "got exception: " << exc.what() << endmsg; }
 
  Gaudi::Details::Property::setParsingErrorPolicy( orig_policy );
 
  info() << "DoubleArray = " << m_doublearray.value() << endmsg;
  info() << "=================================================" << endmsg;
  return StatusCode::SUCCESS;
}

◆ readHandler()

void PropertyAlg::readHandler ( Gaudi::Details::PropertyBase & p )

Callbacks for properties.

Definition at line 32 of file PropertyAlg.cpp.

                                                           {
  // do not print messages if we are created in genconf
  const std::string cmd = System::cmdLineArgs()[0];
  if ( cmd.find( "genconf" ) != std::string::npos ) return;
 
  info() << "Read handler called for property: " << p << endmsg;
}

◆ updateHandler()

void PropertyAlg::updateHandler ( Gaudi::Details::PropertyBase & p )

Definition at line 42 of file PropertyAlg.cpp.

                                                             {
  // avoid the readHandler (which writes to the _same_ MsgStream!) from writing
  // something in the middle of the printout of this message...
  std::ostringstream os;
  os << p;
  info() << "Update handler called for property: " << os.str() << endmsg;
}

Member Data Documentation

◆ m_bool

Gaudi::Property<bool> PropertyAlg::m_bool { this, "Bool", true }

private

Definition at line 50 of file PropertyAlg.h.

50{ this, "Bool", true };

◆ m_boolarray

Gaudi::Property<std::vector<bool> > PropertyAlg::m_boolarray { this, "BoolArray" }

private

Definition at line 57 of file PropertyAlg.h.

57{ this, "BoolArray" };

◆ m_double

Gaudi::Property<double> PropertyAlg::m_double { this, "Double", 100. }

private

Definition at line 48 of file PropertyAlg.h.

48{ this, "Double", 100. };

◆ m_doublearray

Gaudi::Property<std::vector<double> > PropertyAlg::m_doublearray { this, "DoubleArray" }

private

Definition at line 55 of file PropertyAlg.h.

55{ this, "DoubleArray" };

◆ m_emptyarray

Gaudi::Property<std::vector<double> > PropertyAlg::m_emptyarray { this, "EmptyArray" }

private

Definition at line 58 of file PropertyAlg.h.

58{ this, "EmptyArray" };

◆ m_floatuset

Gaudi::Property<std::unordered_set<float> > PropertyAlg::m_floatuset { this, "FloatUnorderedSet" }

private

Definition at line 67 of file PropertyAlg.h.

67{ this, "FloatUnorderedSet" };

◆ m_int

Gaudi::Property<int> PropertyAlg::m_int { this, "Int", 100 }

private

These data members are used in the execution of this algorithm They are set in the initialization phase by the job options service.

Definition at line 45 of file PropertyAlg.h.

45{ this, "Int", 100 };

◆ m_int64

Gaudi::Property<long long> PropertyAlg::m_int64 { this, "Int64", 100 }

private

Definition at line 46 of file PropertyAlg.h.

46{ this, "Int64", 100 };

◆ m_int64array

Gaudi::Property<std::vector<long long> > PropertyAlg::m_int64array { this, "Int64Array" }

private

Definition at line 53 of file PropertyAlg.h.

53{ this, "Int64Array" };

◆ m_intarray

Gaudi::Property<std::vector<int> > PropertyAlg::m_intarray { this, "IntArray" }

private

Definition at line 52 of file PropertyAlg.h.

52{ this, "IntArray" };

◆ m_intset

Gaudi::Property<std::set<int> > PropertyAlg::m_intset { this, "IntSet" }

private

Definition at line 65 of file PropertyAlg.h.

65{ this, "IntSet" };

◆ m_string

Gaudi::Property<std::string> PropertyAlg::m_string { this, "String", "hundred" }

private

Definition at line 49 of file PropertyAlg.h.

49{ this, "String", "hundred" };

◆ m_stringarray

Gaudi::Property<std::vector<std::string> > PropertyAlg::m_stringarray { this, "StringArray" }

private

Definition at line 56 of file PropertyAlg.h.

56{ this, "StringArray" };

◆ m_stringset

Gaudi::Property<std::set<std::string> > PropertyAlg::m_stringset { this, "StringSet" }

private

Definition at line 66 of file PropertyAlg.h.

66{ this, "StringSet" };

◆ m_strmap

Gaudi::Property<std::map<std::string, std::string> > PropertyAlg::m_strmap { this, "StringMap" }

private

Definition at line 69 of file PropertyAlg.h.

69{ this, "StringMap" };

◆ m_uint64

Gaudi::Property<unsigned long long> PropertyAlg::m_uint64 { this, "UInt64", 100 }

private

Definition at line 47 of file PropertyAlg.h.

47{ this, "UInt64", 100 };

◆ m_uint64array

Gaudi::Property<std::vector<unsigned long long> > PropertyAlg::m_uint64array { this, "UInt64Array" }

private

Definition at line 54 of file PropertyAlg.h.

54{ this, "UInt64Array" };

◆ p_bool

Gaudi::Property<bool> PropertyAlg::p_bool { this, "PBool", false }

private

Definition at line 75 of file PropertyAlg.h.

75{ this, "PBool", false };

◆ p_boolarray

Gaudi::Property<std::vector<bool> > PropertyAlg::p_boolarray { this, "PBoolArray" }

private

Definition at line 80 of file PropertyAlg.h.

80{ this, "PBoolArray" };

◆ p_double

Gaudi::PropertyWithReadHandler<double> PropertyAlg::p_double { this, "PDouble", 100. }

private

Definition at line 72 of file PropertyAlg.h.

72{ this, "PDouble", 100. };

◆ p_doublearray

Gaudi::Property<std::vector<double> > PropertyAlg::p_doublearray { this, "PDoubleArray" }

private

Definition at line 78 of file PropertyAlg.h.

78{ this, "PDoubleArray" };

◆ p_int

Gaudi::CheckedProperty<int> PropertyAlg::p_int { this, "PInt", 100, "An integer property" }

private

Definition at line 71 of file PropertyAlg.h.

71{ this, "PInt", 100, "An integer property" };

◆ p_intarray

Gaudi::Property<std::vector<int> > PropertyAlg::p_intarray { this, "PIntArray" }

private

Definition at line 77 of file PropertyAlg.h.

77{ this, "PIntArray" };

◆ p_string

Gaudi::Property<std::string> PropertyAlg::p_string { this, "PString", "hundred" }

private

Definition at line 74 of file PropertyAlg.h.

74{ this, "PString", "hundred" };

◆ p_stringarray

Gaudi::Property<std::vector<std::string> > PropertyAlg::p_stringarray { this, "PStringArray" }

private

Definition at line 79 of file PropertyAlg.h.

79{ this, "PStringArray" };

◆ u_doublearray

Gaudi::Property<std::vector<double> > PropertyAlg::u_doublearray { this, "DoubleArrayWithoutUnits" }

private

Definition at line 60 of file PropertyAlg.h.

60{ this, "DoubleArrayWithoutUnits" };

◆ u_doublearrayunits

Gaudi::Property<std::vector<double> > PropertyAlg::u_doublearrayunits { this, "DoubleArrayWithUnits" }

private

Definition at line 59 of file PropertyAlg.h.

59{ this, "DoubleArrayWithUnits" };

◆ u_doublepairarray

Gaudi::Property<std::vector<std::pair<double, double> > > PropertyAlg::u_doublepairarray { this, "DoublePairArray" }

private

Definition at line 63 of file PropertyAlg.h.

63{ this, "DoublePairArray" };

◆ u_intpairarray

Gaudi::Property<std::vector<std::pair<int, int> > > PropertyAlg::u_intpairarray { this, "IntPairArray" }

private

Definition at line 62 of file PropertyAlg.h.

62{ this, "IntPairArray" };

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

GaudiTestSuite/src/Properties/PropertyAlg.h
GaudiTestSuite/src/Properties/PropertyAlg.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PropertyAlg()

Member Function Documentation

◆ execute()

◆ finalize()

◆ initialize()

◆ readHandler()

◆ updateHandler()

Member Data Documentation

◆ m_bool

◆ m_boolarray

◆ m_double

◆ m_doublearray

◆ m_emptyarray

◆ m_floatuset

◆ m_int

◆ m_int64

◆ m_int64array

◆ m_intarray

◆ m_intset

◆ m_string

◆ m_stringarray

◆ m_stringset

◆ m_strmap

◆ m_uint64

◆ m_uint64array

◆ p_bool

◆ p_boolarray

◆ p_double

◆ p_doublearray

◆ p_int

◆ p_intarray

◆ p_string

◆ p_stringarray

◆ u_doublearray

◆ u_doublearrayunits

◆ u_doublepairarray

◆ u_intpairarray