Extension of OutputStream to copy the content of the main input file. More...

#include </builds/gaudi/Gaudi/GaudiCommonSvc/src/PersistencySvc/InputCopyStream.h>

Inheritance diagram for InputCopyStream:

[legend]

Collaboration diagram for InputCopyStream:

[legend]

Public Member Functions
	InputCopyStream (const std::string &name, ISvcLocator *pSvcLocator)
	Standard algorithm Constructor. More...

StatusCode	initialize () override
	Initialize the instance. More...

StatusCode	finalize () override
	Finalize the instance. More...

StatusCode	collectObjects () override
	Collect all objects to be written to the output stream. More...

Public Member Functions inherited from OutputStream
StatusCode	start () override
	Start OutputStream. More...

StatusCode	initialize () override
	Initialize OutputStream. More...

StatusCode	finalize () override
	Terminate OutputStream. More...

StatusCode	execute () override
	Working entry point. More...

virtual StatusCode	connectConversionSvc ()

virtual bool	collect (IRegistry *dir, int level)
	Store agent's classback. More...

void	clearSelection ()
	Clear list of selected objects. More...

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? More...

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

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

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

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

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

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

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

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

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

StatusCode	sysStop () override
	System stop. More...

StatusCode	sysFinalize () override
	System finalization. More...

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

const Gaudi::StringKey &	nameKey () const override

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

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. More...

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

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

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

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

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

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

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

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

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

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

bool	isSequence () const override
	Are we a Sequence? More...

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

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") More...

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. More...

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

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

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

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

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

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

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

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

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

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

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

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

SmartIF< ITimelineSvc > &	timelineSvc () const

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

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

SmartIF< IHiveWhiteBoard > &	whiteboard () const

SmartIF< IAlgExecStateSvc > &	algExecStateSvc () const

bool	registerContext () const
	register for Algorithm Context Service? More...

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. More...

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

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) More...

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. More...

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 More...

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

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. 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...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
	PropertyHolder ()=default

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

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. More...

	requires (!Gaudi::Details::is_gaudi_property_v< TYPE >) Gaudi
	Helper to wrap a regular data member and use it as a regular property. More...

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

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

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

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

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

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

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

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

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

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

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

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

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

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

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

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) More...

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

Protected Member Functions
bool	hasInput () const override
	Overridden from the base class (InputCopyStream has always input). More...

Protected Member Functions inherited from OutputStream
Gaudi::Algorithm *	decodeAlgorithm (const std::string &theName)
	Decode a single algorithm name. More...

void	decodeAlgorithms (Gaudi::Property< std::vector< std::string >> &theNames, std::vector< Gaudi::Algorithm * > &theAlgs)
	Decode specified list of Algorithms. More...

bool	isEventAccepted () const
	Test whether this event should be output. More...

DataStoreItem *	findItem (const std::string &path)
	Find single item identified by its path (exact match) More...

virtual StatusCode	writeObjects ()
	Select the different objects and write them to file. More...

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? More...

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

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

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 More...

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

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

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

Private Attributes
IDataStoreLeaves *	m_leavesTool = nullptr
	Pointer to the (public) tool used to retrieve the objects in a file. More...

Gaudi::Property< std::vector< std::string > >	m_tesVetoList { this, "TESVetoList", {}, "names of TES locations to Veto" }

Additional Inherited Members
Public Types inherited from OutputStream
typedef std::vector< DataStoreItem * >	Items

typedef std::vector< std::string >	ItemNames

typedef std::map< Gaudi::Algorithm *, Items >	AlgDependentItems

typedef std::map< std::string, ItemNames >	AlgDependentItemNames

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 = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...

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

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

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...

Public Attributes inherited from Gaudi::Algorithm
friend	AlgorithmManager

Protected Attributes inherited from OutputStream
Gaudi::Property< ItemNames >	m_itemNames { this, "ItemList", {}, "vector of item names to be saved to this stream" }

Gaudi::Property< ItemNames >	m_optItemNames

Gaudi::Property< AlgDependentItemNames >	m_algDependentItemList

Gaudi::Property< bool >	m_doPreLoad

Gaudi::Property< bool >	m_doPreLoadOpt

Gaudi::Property< std::string >	m_output { this, "Output", {}, "name of the output file specification" }

Gaudi::Property< std::string >	m_outputName { this, "OutputFile", {}, "name of the output file" }

Gaudi::Property< std::string >	m_storeName

Gaudi::Property< std::string >	m_persName

Gaudi::Property< std::vector< std::string > >	m_acceptNames

Gaudi::Property< std::vector< std::string > >	m_requireNames

Gaudi::Property< std::vector< std::string > >	m_vetoNames

Gaudi::Property< bool >	m_verifyItems

bool	m_fireIncidents = true
	should I fire incidents for writing opening/closing etc? in the baseclass, always fire the incidents by default in e.g. More...

SmartIF< IIncidentSvc >	m_incidentSvc
	Reference to the incident service. More...

std::string	m_outputType = "UPDATE"
	Output type: NEW(NEW,CREATE,WRITE,RECREATE), UPDATE) More...

SmartIF< IDataProviderSvc >	m_pDataProvider
	Keep reference to the data provider service. More...

SmartIF< IDataManagerSvc >	m_pDataManager
	Keep reference to the data manager service. More...

SmartIF< IConversionSvc >	m_pConversionSvc
	Keep reference to the data conversion service. More...

DataStoreItem *	m_currentItem
	Keep track of the current item. More...

Items	m_itemList
	Vector of items to be saved to this stream. More...

Items	m_optItemList
	Vector of optional items to be saved to this stream. More...

AlgDependentItems	m_algDependentItems
	Items to be saved for specific algorithms. More...

IDataSelector	m_objects
	Collection of objects being selected. More...

int	m_events
	Number of events written to this output stream. More...

std::vector< Gaudi::Algorithm * >	m_acceptAlgs
	Vector of Algorithms that this stream accepts. More...

std::vector< Gaudi::Algorithm * >	m_requireAlgs
	Vector of Algorithms that this stream requires. More...

std::vector< Gaudi::Algorithm * >	m_vetoAlgs
	Vector of Algorithms that this stream is vetoed by. More...

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. More...

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

DataObjIDColl	m_outputDataObjs

Detailed Description

Extension of OutputStream to copy the content of the main input file.

On top of the standard behavior of OutputStream, this class takes also all the entries that come from the same file as the root entry in the data service.

Author: : M. Frank; : P. Koppenburg; : M. Clemencic

Definition at line 28 of file InputCopyStream.h.

Constructor & Destructor Documentation

◆ InputCopyStream()

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

Standard algorithm Constructor.

Definition at line 26 of file InputCopyStream.cpp.

     : OutputStream( name, pSvcLocator ) {
   m_doPreLoad    = false;
   m_doPreLoadOpt = false;
 }

Member Function Documentation

◆ collectObjects()

StatusCode InputCopyStream::collectObjects ( )

overridevirtual

Collect all objects to be written to the output stream.

Reimplemented from OutputStream.

Definition at line 49 of file InputCopyStream.cpp.

                                            {
   // Get the objects in the same file as the root node
   try {
     // Get all the leaves on the input stream
     const IDataStoreLeaves::LeavesList& leaves = m_leavesTool->leaves();
  
     // Do we need to veto anything ?
     if ( !m_tesVetoList.empty() ) {
       // Veto out locations
       IDataStoreLeaves::LeavesList filteredLeaves;
       filteredLeaves.reserve( leaves.size() );
       std::copy_if( leaves.begin(), leaves.end(), std::back_inserter( filteredLeaves ),
                     [&]( IDataStoreLeaves::LeavesList::const_reference i ) {
                       return i && i->registry() &&
                              std::find( m_tesVetoList.begin(), m_tesVetoList.end(), i->registry()->identifier() ) ==
                                  m_tesVetoList.end();
                     } );
       // save the veto'ed list
       m_objects.assign( filteredLeaves.begin(), filteredLeaves.end() );
  
     } else {
       // no veto'ing, so save everything
       m_objects.assign( leaves.begin(), leaves.end() );
     }
   } catch ( const GaudiException& e ) {
     error() << e.message() << endmsg;
     return StatusCode::FAILURE;
   }
  
   // Collect the other objects from the transient store (mandatory and optional)
   return OutputStream::collectObjects();
 }

◆ finalize()

StatusCode InputCopyStream::finalize ( )

override

Finalize the instance.

Definition at line 42 of file InputCopyStream.cpp.

                                      {
   toolSvc()->releaseTool( m_leavesTool ).ignore();
   m_leavesTool = nullptr;
   return OutputStream::finalize();
 }

◆ hasInput()

bool InputCopyStream::hasInput ( ) const

inlineoverrideprotectedvirtual

Overridden from the base class (InputCopyStream has always input).

Reimplemented from OutputStream.

Definition at line 51 of file InputCopyStream.h.

51 { return true; }

◆ initialize()

StatusCode InputCopyStream::initialize ( )

override

Initialize the instance.

Definition at line 33 of file InputCopyStream.cpp.

                                        {
   StatusCode sc = OutputStream::initialize();
   if ( sc.isFailure() ) return sc;
  
   sc = toolSvc()->retrieveTool( "DataSvcFileEntriesTool", "InputCopyStreamTool", m_leavesTool );
   return sc;
 }

Member Data Documentation

◆ m_leavesTool

IDataStoreLeaves* InputCopyStream::m_leavesTool = nullptr

private

Pointer to the (public) tool used to retrieve the objects in a file.

Definition at line 45 of file InputCopyStream.h.

◆ m_tesVetoList

Gaudi::Property<std::vector<std::string> > InputCopyStream::m_tesVetoList { this, "TESVetoList", {}, "names of TES locations to Veto" }

private

Definition at line 47 of file InputCopyStream.h.

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

GaudiCommonSvc/src/PersistencySvc/InputCopyStream.h
GaudiCommonSvc/src/PersistencySvc/InputCopyStream.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members