In This Package:

Sequencer Class Reference

ClassName: Sequencer. More...

#include <Sequencer.h>

Inheritance diagram for Sequencer:

[legend]Collaboration diagram for Sequencer:[legend]List of all members.

Public Types
	SUCCESS
	NO_INTERFACE
	VERSMISMATCH
	LAST_ERROR
enum	Status
Public Member Functions
	Sequencer (const std::string &name, ISvcLocator *svcloc)
	Constructor(s).
virtual	~Sequencer ()
	Destructor.
virtual StatusCode	initialize ()
	Initialization of a sequencer.
virtual StatusCode	reinitialize ()
	Sequencer Reinitialization.
virtual StatusCode	start ()
	Sequencer finalization.
virtual StatusCode	execute ()
	The actions to be performed by the sequencer on an event.
virtual StatusCode	stop ()
	Sequencer finalization.
virtual StatusCode	finalize ()
	Sequencer finalization.
virtual StatusCode	beginRun ()
	Sequencer beginRun.
virtual StatusCode	endRun ()
	Sequencer endRun.
void	resetExecuted ()
	Reset the Sequencer executed state for the current event.
virtual bool	branchFilterPassed () const
	Was the branch filter passed for the last event?
virtual StatusCode	setBranchFilterPassed (bool state)
	Set the branch filter passed flag for the last event.
virtual bool	isStopOverride () const
	Has the StopOverride mode been set?
StatusCode	append (Algorithm *pAlgorithm)
	Append an algorithm to the sequencer.
StatusCode	appendToBranch (Algorithm *pAlgorithm)
	Append an algorithm to the sequencer branch.
StatusCode	createAndAppend (const std::string &type, const std::string &name, Algorithm *&pAlgorithm)
	Create a algorithm and append it to the sequencer.
StatusCode	createAndAppendToBranch (const std::string &type, const std::string &name, Algorithm *&pAlgorithm)
	Create a algorithm and append it to the sequencer branch.
StatusCode	remove (Algorithm *pAlgorithm)
	Remove the specified algorithm from the sequencer.
StatusCode	remove (const std::string &name)
StatusCode	removeFromBranch (Algorithm *pAlgorithm)
StatusCode	removeFromBranch (const std::string &name)
std::vector< Algorithm * > *	branchAlgorithms () const
	List of branch algorithms.
StatusCode	decodeMemberNames ()
	Decode Member Name list.
void	membershipHandler (Property &theProp)
	"Members" property handler
StatusCode	decodeBranchMemberNames ()
	Decode branch member naem list.
void	branchMembershipHandler (Property &theProp)
	"BranchMembers" propertry handler
virtual StatusCode	sysStart ()
virtual StatusCode	sysInitialize ()
virtual StatusCode	sysReinitialize ()
virtual StatusCode	sysRestart ()
virtual StatusCode	sysExecute ()
virtual StatusCode	sysStop ()
virtual StatusCode	sysFinalize ()
virtual StatusCode	sysBeginRun ()
virtual StatusCode	sysEndRun ()
virtual const std::string &	name () const
virtual const std::string &	version () const
virtual StatusCode	configure ()
virtual StatusCode	terminate ()
virtual StatusCode	restart ()
virtual bool	isExecuted () const
virtual void	setExecuted (bool state)
virtual Gaudi::StateMachine::State	FSMState () const
virtual Gaudi::StateMachine::State	targetFSMState () const
virtual bool	isEnabled () const
virtual bool	filterPassed () const
virtual void	setFilterPassed (bool state)
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
void	setOutputLevel (int level)
IAuditorSvc *	auditorSvc () const
IChronoStatSvc *	chronoSvc () const
IChronoStatSvc *	chronoStatService () const
IDataProviderSvc *	detSvc () const
IDataProviderSvc *	detDataService () const
IConversionSvc *	detCnvSvc () const
IConversionSvc *	detDataCnvService () const
IDataProviderSvc *	eventSvc () const
IDataProviderSvc *	evtSvc () const
IDataProviderSvc *	eventDataService () const
IConversionSvc *	eventCnvSvc () const
IConversionSvc *	eventDataCnvService () const
IHistogramSvc *	histoSvc () const
IHistogramSvc *	histogramDataService () const
IMessageSvc *	msgSvc () const
IMessageSvc *	messageService () const
INTupleSvc *	ntupleSvc () const
INTupleSvc *	ntupleService () const
IRndmGenSvc *	randSvc () const
IToolSvc *	toolSvc () const
IExceptionSvc *	exceptionSvc () const
ISvcLocator *	serviceLocator () const
ISvcLocator *	svcLoc () const
StatusCode	createSubAlgorithm (const std::string &type, const std::string &name, Algorithm *&pSubAlg)
std::vector< Algorithm * > *	subAlgorithms () const
virtual StatusCode	setProperty (const Property &p)
virtual StatusCode	setProperty (const std::string &s)
virtual StatusCode	setProperty (const std::string &n, const std::string &v)
StatusCode	setProperty (const std::string &name, const TYPE &value)
virtual StatusCode	getProperty (Property *p) const
virtual const Property &	getProperty (const std::string &name) const
virtual StatusCode	getProperty (const std::string &n, std::string &v) const
virtual const std::vector< Property * > &	getProperties () const
StatusCode	setProperties ()
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
IMonitorSvc *	monitorSvc () const
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
unsigned long	addRef ()
unsigned long	release ()
StatusCode	queryInterface (const InterfaceID &riid, void **)
Static Public Member Functions
static const InterfaceID &	interfaceID ()
static const InterfaceID &	interfaceID ()
static const InterfaceID &	interfaceID ()
Public Attributes
	SUCCESS
	NO_INTERFACE
	VERSMISMATCH
	LAST_ERROR
Protected Member Functions
StatusCode	append (Algorithm *pAlgorithm, std::vector< Algorithm * > *theAlgs)
	Append an algorithm to the sequencer.
StatusCode	createAndAppend (const std::string &type, const std::string &name, Algorithm *&pAlgorithm, std::vector< Algorithm * > *theAlgs)
	Create a algorithm and append it to the sequencer.
StatusCode	decodeNames (StringArrayProperty &theNames, std::vector< Algorithm * > *theAlgs, std::vector< bool > &theLogic)
	Decode algorithm names, creating or appending algorithms as appropriate.
StatusCode	execute (std::vector< Algorithm * > *theAlgs, std::vector< bool > &theLogic, Algorithm *&lastAlgorithm, unsigned int first=0)
	Execute the members in the specified list.
StatusCode	executeMember (Algorithm *theAlgorithm)
	Execute member algorithm.
StatusCode	remove (const std::string &algname, std::vector< Algorithm * > *theAlgs)
	Remove the specified algorithm from the sequencer.
bool	isInitialized () const
bool	isFinalized () const
int	outputLevel () const
IntegerProperty &	outputLevelProperty ()
void	initOutputLevel (Property &prop)
Private Member Functions
	Sequencer (const Sequencer &a)
	Private Copy constructor: NO COPY ALLOWED.
Sequencer &	operator= (const Sequencer &rhs)
	Private asignment operator: NO ASSIGNMENT ALLOWED.
Private Attributes
StringArrayProperty	m_names
std::vector< bool >	m_isInverted
StringArrayProperty	m_branchNames
std::vector< Algorithm * > *	m_branchAlgs
std::vector< bool >	m_isBranchInverted
BooleanProperty	m_stopOverride
bool	m_branchFilterPassed

---

Detailed Description

ClassName: Sequencer.

Description: A Sequencer is essentially a list of Algorithms and is responsible for their management. Note that Sequences may themselves contain other Sequences. The default execute( ) implementation loops over the members of the sequence, calling their execute( ) methods. However, this can be modified if a member is disabled, has already been executed, or a member indicates that it's filter fails. The the former two cases the execution of the member is bypassed. In the latter case, the loop is terminated and the Sequencer assumes the same filtered state as the last member.

Definition at line 24 of file Sequencer.h.

---

Constructor & Destructor Documentation

Sequencer::Sequencer	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Constructor(s).

Definition at line 21 of file Sequencer.cpp.

: Algorithm( name, pSvcLocator ),
  m_branchFilterPassed( false )
{
  
  // Create vector of branch algorithms
  m_branchAlgs = new std::vector<Algorithm*>();
  
  // Declare Sequencer properties with their defaults
  declareProperty( "Members", m_names );
  declareProperty( "BranchMembers", m_branchNames );
  declareProperty( "StopOverride", m_stopOverride=false );
  
  // Associate action handlers with the "Members" and "BranchMembers" properties
  m_names.declareUpdateHandler      ( &Sequencer::membershipHandler      , this );
  m_branchNames.declareUpdateHandler( &Sequencer::branchMembershipHandler, this );
  
}

Sequencer::~Sequencer

(

)

[virtual]

Destructor.

Definition at line 43 of file Sequencer.cpp.

{
  delete m_branchAlgs;
}

Sequencer::Sequencer

(

const Sequencer &

a

)

[private]

Private Copy constructor: NO COPY ALLOWED.

---

Member Function Documentation

StatusCode Sequencer::initialize

(

)

[virtual]

Initialization of a sequencer.

Typically things like histogram creation, setting up of data structures etc, should be done here. If a sequence has properties specified in the job options file, they will be set to the requested values BEFORE the initialize() method is invoked.

Reimplemented from Algorithm.

Definition at line 49 of file Sequencer.cpp.

{
  StatusCode result = StatusCode::SUCCESS;
  MsgStream log( msgSvc( ), name( ) );

  std::vector<Algorithm*>* theAlgs;
  std::vector<Algorithm*>::iterator it;
  std::vector<Algorithm*>::iterator itend;
  
  result = decodeMemberNames();
  if( result.isFailure() ) {
    log << MSG::ERROR << "Unable to configure one or more sequencer members " << endreq;
    return result;
  }
  result = decodeBranchMemberNames();
  if( result.isFailure() ) {
    log << MSG::ERROR << "Unable to configure one or more branch members " << endreq;
    return result;
  }
  
  // Loop over all sub-algorithms
  theAlgs = subAlgorithms( );
  itend   = theAlgs->end( );
  for (it = theAlgs->begin(); it != itend; it++) {
    Algorithm* theAlgorithm = (*it);
    result = theAlgorithm->sysInitialize( );
    if( result.isFailure() ) {
      log << MSG::ERROR << "Unable to initialize Algorithm " << theAlgorithm->name() << endreq;
      return result;
    }
  }

  // Loop over all branches
  theAlgs = branchAlgorithms( );
  itend   = theAlgs->end( );
  for (it = theAlgs->begin(); it != itend; it++) {
    Algorithm* theAlgorithm = (*it);
    result = theAlgorithm->sysInitialize( );
    if( result.isFailure() ) {
      log << MSG::ERROR << "Unable to initialize Algorithm " << theAlgorithm->name() << endreq;
      return result;
    }
  }
  
  return result;
}

StatusCode Sequencer::reinitialize

(

)

[virtual]

Sequencer Reinitialization.

Reimplemented from Algorithm.

Definition at line 97 of file Sequencer.cpp.

{
  // Bypass the loop if this sequencer is disabled
  if ( isEnabled( ) ) {

    // Loop over all members calling their reinitialize functions
    // if they are not disabled.
    std::vector<Algorithm*>* theAlgms = subAlgorithms( );
    std::vector<Algorithm*>::iterator it;
    std::vector<Algorithm*>::iterator itend = theAlgms->end( );
    for (it = theAlgms->begin(); it != itend; it++) {
      Algorithm* theAlgorithm = (*it);
      if ( ! theAlgorithm->isEnabled( ) ) {
        theAlgorithm->reinitialize( ).ignore();
      }
    }
    // Loop over all branch members calling their reinitialize functions
    // if they are not disabled.
    theAlgms = branchAlgorithms( );
    itend    = theAlgms->end( );
    for (it = theAlgms->begin(); it != itend; it++) {
      Algorithm* theAlgorithm = (*it);
      if ( ! theAlgorithm->isEnabled( ) ) {
        theAlgorithm->reinitialize( ).ignore();
      }
    }
    
  }
  return StatusCode::SUCCESS;
}

StatusCode Sequencer::start

(

)

[virtual]

Sequencer finalization.

Reimplemented from Algorithm.

Definition at line 198 of file Sequencer.cpp.

{
  StatusCode result = StatusCode::SUCCESS;
  MsgStream log( msgSvc( ), name( ) );

  std::vector<Algorithm*>* theAlgs;
  std::vector<Algorithm*>::iterator it;
  std::vector<Algorithm*>::iterator itend;
  
  // Loop over all sub-algorithms
  theAlgs = subAlgorithms( );
  itend   = theAlgs->end( );
  for (it = theAlgs->begin(); it != itend; it++) {
    Algorithm* theAlgorithm = (*it);
    result = theAlgorithm->sysStart( );
    if( result.isFailure() ) {
      log << MSG::ERROR << "Unable to start Algorithm " << theAlgorithm->name() << endreq;
      return result;
    }
  }

  // Loop over all branches
  theAlgs = branchAlgorithms( );
  itend   = theAlgs->end( );
  for (it = theAlgs->begin(); it != itend; it++) {
    Algorithm* theAlgorithm = (*it);
    result = theAlgorithm->sysStart( );
    if( result.isFailure() ) {
      log << MSG::ERROR << "Unable to start Algorithm " << theAlgorithm->name() << endreq;
      return result;
    }
  }
  
  return result;
}

StatusCode Sequencer::execute

(

)

[virtual]

The actions to be performed by the sequencer on an event.

This method is invoked once per event.

Implements Algorithm.

Definition at line 129 of file Sequencer.cpp.

{
  StatusCode result = StatusCode::SUCCESS;
  MsgStream log( msgSvc( ), name( ) );
  
  log << MSG::DEBUG << name( ) << " Sequencer::execute( )" << endreq;
  
  // Bypass the loop if this sequencer is disabled or has already been executed
  if ( isEnabled( ) && ! isExecuted( ) ) {
    Algorithm* lastAlgorithm;
    result = execute( subAlgorithms( ), m_isInverted, lastAlgorithm );
    if ( result.isSuccess( ) ) {
      bool passed = filterPassed( );
      if ( ! passed && ! isStopOverride( ) ) {
        
        // Filter failed and stop override not set. Execute the
        // branch if there is one associated with the filter
        // algorithm that failed. Note that the first member on
        // the branch is the failing algorithm and so should
        // be skipped.
        std::vector<Algorithm*>* theAlgs = branchAlgorithms( );
        if ( theAlgs->size( ) > 0 ) {
          Algorithm* branchAlgorithm = (*theAlgs)[0];
          if ( lastAlgorithm == branchAlgorithm ) {
            
            // Branch specified - Loop over branch members
            result = execute( branchAlgorithms( ),
                              m_isBranchInverted,
                              lastAlgorithm, 1 );
            if ( result.isSuccess( ) ) {
              
              // The final filter passed state will be set true if either
              // of the main or branches passed, otherwise false.
              
              // Save the branch  filter passed state.
              setBranchFilterPassed( filterPassed( ) ).ignore();
            }
          }
        }
      }
    }
    
    // Prevent multiple executions of this sequencer for the current event
    setExecuted( true );
  }
  return result;
}

StatusCode Sequencer::stop

(

)

[virtual]

Sequencer finalization.

Reimplemented from Algorithm.

Definition at line 235 of file Sequencer.cpp.

{
  // Loop over all branch members calling their finalize functions
  // if they are not disabled.
  std::vector<Algorithm*>* theAlgs;
  std::vector<Algorithm*>::iterator it;
  std::vector<Algorithm*>::iterator itend;
  
  theAlgs = subAlgorithms( );
  itend   = theAlgs->end( );
  for (it = theAlgs->begin(); it != itend; it++) {
    Algorithm* theAlgorithm = (*it);
    if (theAlgorithm->sysStop( ).isFailure()) {
      MsgStream log( msgSvc( ), name( ) );
      log << MSG::ERROR << "Unable to stop Algorithm " 
          << theAlgorithm->name() << endreq;
    }
  }
  
  theAlgs = branchAlgorithms( );
  itend   = theAlgs->end( );
  for (it = theAlgs->begin(); it != itend; it++) {
    Algorithm* theAlgorithm = (*it);
    if (theAlgorithm->sysStop( ).isFailure()) {
      MsgStream log( msgSvc( ), name( ) );
      log << MSG::ERROR << "Unable to stop Algorithm " 
          << theAlgorithm->name() << endreq;
    }
  }
  return StatusCode::SUCCESS;
}

StatusCode Sequencer::finalize

(

)

[virtual]

Sequencer finalization.

Reimplemented from Algorithm.

Definition at line 178 of file Sequencer.cpp.

{
  // Loop over all branch members calling their finalize functions
  // if they are not disabled. Note that the Algoriithm::sysFinalize
  // function already does this for the main members.
  std::vector<Algorithm*>* theAlgs = branchAlgorithms( );
  std::vector<Algorithm*>::iterator it;
  std::vector<Algorithm*>::iterator itend = theAlgs->end( );
  for (it = theAlgs->begin(); it != itend; it++) {
    Algorithm* theAlgorithm = (*it);
    if (theAlgorithm->sysFinalize( ).isFailure()) {
      MsgStream log( msgSvc( ), name( ) );
      log << MSG::ERROR << "Unable to finalize Algorithm " 
          << theAlgorithm->name() << endreq;
    }
  }
  return StatusCode::SUCCESS;
}

StatusCode Sequencer::beginRun

(

)

[virtual]

Sequencer beginRun.

Reimplemented from Algorithm.

Definition at line 268 of file Sequencer.cpp.

{
  StatusCode result = StatusCode::SUCCESS;
  MsgStream log( msgSvc( ), name( ) );
  
  // Bypass the loop if this sequencer is disabled
  if ( isEnabled( ) ) {
    
    // Loop over all members calling their sysInitialize functions
    // if they are not disabled. Note that the Algoriithm::sysInitialize
    // function protects this from affecting Algorithms that have already
    // been initialized.
    std::vector<Algorithm*>* theAlgs = subAlgorithms( );
    std::vector<Algorithm*>::iterator it;
    std::vector<Algorithm*>::iterator itend = theAlgs->end( );
    for (it = theAlgs->begin(); it != itend; it++) {
      Algorithm* theAlgorithm = (*it);
      result = theAlgorithm->sysInitialize( );
      if( result.isFailure() ) {
        log << MSG::ERROR << "Unable to initialize Algorithm " << theAlgorithm->name() << endreq;
        break;
      }
      result = theAlgorithm->sysStart( );
      if( result.isFailure() ) {
        log << MSG::ERROR << "Unable to start Algorithm " << theAlgorithm->name() << endreq;
        break;
      }
    }
    
    // Loop over all members calling their beginRun functions
    // if they are not disabled.
    for (it = theAlgs->begin(); it != itend; it++) {
      Algorithm* theAlgorithm = (*it);
      if ( ! theAlgorithm->isEnabled( ) ) {
        theAlgorithm->beginRun( ).ignore();
      }
    }
    
    // Loop over all branch members calling their sysInitialize functions
    // if they are not disabled. Note that the Algoriithm::sysInitialize
    // function protects this from affecting Algorithms that have already
    // been initialized.
    theAlgs = branchAlgorithms( );
    itend   = theAlgs->end( );
    for (it = theAlgs->begin(); it != itend; it++) {
      Algorithm* theAlgorithm = (*it);
      result = theAlgorithm->sysInitialize( );
      if( result.isFailure() ) {
        log << MSG::ERROR << "Unable to initialize Algorithm " << theAlgorithm->name() << endreq;
        break;
      }
      result = theAlgorithm->sysStart( );
      if( result.isFailure() ) {
        log << MSG::ERROR << "Unable to start Algorithm " << theAlgorithm->name() << endreq;
        break;
      }
    }
    
    // Loop over all branch members calling their beginRun functions
    // if they are not disabled.
    for (it = theAlgs->begin(); it != itend; it++) {
      Algorithm* theAlgorithm = (*it);
      if ( ! theAlgorithm->isEnabled( ) ) {
        theAlgorithm->beginRun( ).ignore();
      }
    }
  }
  return StatusCode::SUCCESS;
}

StatusCode Sequencer::endRun

(

)

[virtual]

Sequencer endRun.

Reimplemented from Algorithm.

Definition at line 339 of file Sequencer.cpp.

{
  // Bypass the loop if this sequencer is disabled
  if ( isEnabled( ) ) {
    
    // Loop over all members calling their endRun functions
    // if they are not disabled.
    std::vector<Algorithm*>* theAlgms = subAlgorithms( );
    std::vector<Algorithm*>::iterator it;
    std::vector<Algorithm*>::iterator itend = theAlgms->end( );
    for (it = theAlgms->begin(); it != itend; it++) {
      Algorithm* theAlgorithm = (*it);
      if ( ! theAlgorithm->isEnabled( ) ) {
        theAlgorithm->endRun( ).ignore();
      }
    }
    // Loop over all branch members calling their endRun functions
    // if they are not disabled.
    theAlgms = branchAlgorithms( );
    itend    = theAlgms->end( );
    for (it = theAlgms->begin(); it != itend; it++) {
      Algorithm* theAlgorithm = (*it);
      if ( ! theAlgorithm->isEnabled( ) ) {
        theAlgorithm->endRun( ).ignore();
      }
    }
  }
  return StatusCode::SUCCESS;
}

void Sequencer::resetExecuted

(

)

[virtual]

Reset the Sequencer executed state for the current event.

Reimplemented from Algorithm.

Definition at line 370 of file Sequencer.cpp.

{
  Algorithm::resetExecuted( );
  
  // Loop over all members calling their resetExecuted functions
  // if they are not disabled.
  std::vector<Algorithm*>* subAlgms = subAlgorithms( );
  std::vector<Algorithm*>::iterator it;
  std::vector<Algorithm*>::iterator itend = subAlgms->end( );
  for (it = subAlgms->begin(); it != itend; it++) {
    Algorithm* theAlgorithm = (*it);
    theAlgorithm->resetExecuted( );
  }
  
  // Loop over all branch members calling their resetExecuted functions
  // if they are not disabled.
  subAlgms = branchAlgorithms( );
  itend    = subAlgms->end( );
  for (it = subAlgms->begin(); it != itend; it++) {
    Algorithm* theAlgorithm = (*it);
    theAlgorithm->resetExecuted( );
  }
  
  // Reset the branch filter passed flag
  m_branchFilterPassed = false;
}

bool Sequencer::branchFilterPassed

(

)

const [virtual]

Was the branch filter passed for the last event?

Definition at line 398 of file Sequencer.cpp.

{
  return m_branchFilterPassed;
}

StatusCode Sequencer::setBranchFilterPassed

(

bool

state

)

[virtual]

Set the branch filter passed flag for the last event.

Definition at line 404 of file Sequencer.cpp.

{
  m_branchFilterPassed = state;
  return StatusCode::SUCCESS;
}

bool Sequencer::isStopOverride

(

)

const [virtual]

Has the StopOverride mode been set?

Definition at line 411 of file Sequencer.cpp.

{
  return m_stopOverride.value( );
}

StatusCode Sequencer::append

(

Algorithm *

pAlgorithm

)

Append an algorithm to the sequencer.

Definition at line 417 of file Sequencer.cpp.

{
  StatusCode result = append( pAlgorithm, subAlgorithms( ) );
  return result;
}

StatusCode Sequencer::appendToBranch

(

Algorithm *

pAlgorithm

)

Append an algorithm to the sequencer branch.

Definition at line 424 of file Sequencer.cpp.

{
  StatusCode result = append( pAlgorithm, branchAlgorithms( ) );
  return result;
}

StatusCode Sequencer::createAndAppend	(	const std::string &	type,
		const std::string &	name,
		Algorithm *&	pAlgorithm
	)

Create a algorithm and append it to the sequencer.

A call to this method creates a child algorithm object. Note that the returned pointer is to Algorithm (as opposed to IAlgorithm), and thus the methods of IProperty are also available for the direct setting of the algorithm's properties. Using this mechanism instead of creating algorithms directly via the new operator is preferred since then the framework may take care of all of the necessary book-keeping.

Definition at line 431 of file Sequencer.cpp.

{
  StatusCode result = createAndAppend( type, name, pAlgorithm, subAlgorithms( ) );
  return result;
}

StatusCode Sequencer::createAndAppendToBranch	(	const std::string &	type,
		const std::string &	name,
		Algorithm *&	pAlgorithm
	)

Create a algorithm and append it to the sequencer branch.

A call to this method creates a child algorithm object. Note that the returned pointer is to Algorithm (as opposed to IAlgorithm), and thus the methods of IProperty are also available for the direct setting of the algorithm's properties. Using this mechanism instead of creating algorithms directly via the new operator is preferred since then the framework may take care of all of the necessary book-keeping.

Definition at line 440 of file Sequencer.cpp.

{
  StatusCode result = createAndAppend( type, name, pAlgorithm, branchAlgorithms( ) );
  return result;
}

StatusCode Sequencer::remove

(

Algorithm *

pAlgorithm

)

Remove the specified algorithm from the sequencer.

Definition at line 449 of file Sequencer.cpp.

{
  std::string theName = pAlgorithm->name( );
  StatusCode result = remove( theName );
  return result;
}

StatusCode Sequencer::remove

(

const std::string &

name

)

Definition at line 457 of file Sequencer.cpp.

{
  StatusCode result = remove( algname, subAlgorithms( ) );
  return result;
}

StatusCode Sequencer::removeFromBranch

(

Algorithm *

pAlgorithm

)

Definition at line 464 of file Sequencer.cpp.

{
  std::string theName = pAlgorithm->name( );
  StatusCode result = removeFromBranch( theName );
  return result;
}

StatusCode Sequencer::removeFromBranch

(

const std::string &

name

)

Definition at line 472 of file Sequencer.cpp.

{
  StatusCode result = remove( algname, branchAlgorithms( ) );
  return result;
}

std::vector< Algorithm * > * Sequencer::branchAlgorithms

(

)

const

List of branch algorithms.

These are the algorithms that would get executed if a filter algorithm indicated a failure. The branch is located within the main sequence by the first element, which is the filter algorithm.

Definition at line 479 of file Sequencer.cpp.

                                   {
  return m_branchAlgs;
}

StatusCode Sequencer::decodeMemberNames

(

)

Decode Member Name list.

Definition at line 484 of file Sequencer.cpp.

{
  StatusCode result = StatusCode::SUCCESS;
  
  // Decode the membership list
  result = decodeNames( m_names, 
                        subAlgorithms( ),
                        m_isInverted );
  
  return result;
}

void Sequencer::membershipHandler

(

Property &

theProp

)

"Members" property handler

Definition at line 497 of file Sequencer.cpp.

{
  if ( isInitialized() ) decodeMemberNames();
}

StatusCode Sequencer::decodeBranchMemberNames

(

)

Decode branch member naem list.

Definition at line 503 of file Sequencer.cpp.

{
  StatusCode result = StatusCode::SUCCESS;
  
  // Decode the branch membership list
  result = decodeNames( m_branchNames,
                        branchAlgorithms( ),
                        m_isBranchInverted );
  
  return result;
}

void Sequencer::branchMembershipHandler

(

Property &

theProp

)

"BranchMembers" propertry handler

Definition at line 516 of file Sequencer.cpp.

{
  if ( isInitialized() ) decodeBranchMemberNames();
}

StatusCode Sequencer::append	(	Algorithm *	pAlgorithm,
		std::vector< Algorithm * > *	theAlgs
	)			[protected]

Append an algorithm to the sequencer.

Definition at line 526 of file Sequencer.cpp.

{
  StatusCode result = StatusCode::SUCCESS;
  // Check that the specified algorithm doesn't already exist in the membership list
  std::vector<Algorithm*>::iterator it;
  std::vector<Algorithm*>::iterator itend = theAlgs->end( );
  for (it = theAlgs->begin(); it != itend; it++) {
    Algorithm* theAlgorithm = (*it);
    if ( theAlgorithm == pAlgorithm ) {
      result = StatusCode::FAILURE;
      break;
    }
  }
  if ( result.isSuccess( ) ) {
    theAlgs->push_back( pAlgorithm );
    pAlgorithm->addRef();
  }
  return result;
}

StatusCode Sequencer::createAndAppend	(	const std::string &	type,
		const std::string &	name,
		Algorithm *&	pAlgorithm,
		std::vector< Algorithm * > *	theAlgs
	)			[protected]

Create a algorithm and append it to the sequencer.

A call to this method creates a child algorithm object. Note that the returned pointer is to Algorithm (as opposed to IAlgorithm), and thus the methods of IProperty are also available for the direct setting of the algorithm's properties. Using this mechanism instead of creating algorithms directly via the new operator is preferred since then the framework may take care of all of the necessary book-keeping.

Definition at line 548 of file Sequencer.cpp.

{
  StatusCode result = StatusCode::FAILURE;
  MsgStream log( msgSvc( ), name( ) );
  IAlgManager* theAlgMgr = 0;
  //result = service( "ApplicationMgr", theAlgMgr );
  result = serviceLocator()->getService( "ApplicationMgr",
                                       IID_IAlgManager,
                                       *pp_cast<IInterface>(&theAlgMgr) );
  if ( result.isSuccess( ) ) {
    IAlgorithm* tmp;
    result = theAlgMgr->createAlgorithm( type, algName, tmp );
    if ( result.isSuccess( ) ) {
      try{
        pAlgorithm = dynamic_cast<Algorithm*>(tmp);
        theAlgs->push_back( pAlgorithm );
      } catch(...){
        log << MSG::ERROR << "Unable to create Algorithm " << algName << endreq;
        result = StatusCode::FAILURE;
      }
    }
        }
  theAlgMgr->release();
        return result;
}

StatusCode Sequencer::decodeNames	(	StringArrayProperty &	theNames,
		std::vector< Algorithm * > *	theAlgs,
		std::vector< bool > &	theLogic
	)			[protected]

Decode algorithm names, creating or appending algorithms as appropriate.

Definition at line 578 of file Sequencer.cpp.

{
  StatusCode result;
  MsgStream log( msgSvc( ), name( ) );
  IAlgManager* theAlgMgr = 0;
  //result = service( "ApplicationMgr", theAlgMgr );
  result = serviceLocator()->getService( "ApplicationMgr",
                                         IID_IAlgManager,
                                         *pp_cast<IInterface>(&theAlgMgr) );

  if ( result.isSuccess( ) ) {
    
    // Clear the existing list of algorithms
    theAlgs->clear( );

    // Build the list of member algorithms from the contents of the
    // theNames list.
    const std::vector<std::string>& theNameVector = theNames.value( );
    std::vector<std::string>::const_iterator it;
    std::vector<std::string>::const_iterator itend = theNameVector.end( );
    for (it = theNameVector.begin(); it != itend; it++) {

      // Parse the name for a syntax of the form:
      //
      // <type>/<name>
      //
      // Where <name> is the algorithm instance name, and <type> is the
      // algorithm class type (being a subclass of Algorithm).
      std::string theName = (*it);
      std::string theType = (*it);
      std::string::size_type slash = (*it).find_first_of( "/" );
      if ( std::string::npos != slash ) {
        theType = (*it).substr( 0, slash );
        theName = (*it).substr( slash+1 );
      }

      // Parse the name for a syntax of the form:
      //
      // <name>:invert
      //
      // Where <name> is the algorithm instance name and ":invert"
      // indicates that the filter passed logic is inverted.
      bool isInverted = false;
      std::string::size_type invert = theName.find_first_of( ":" );
      while ( std::string::npos != invert
              && invert < (theName.size() - 1) && theName[invert+1] == ':' )
        invert = theName.find_first_of( ":", invert+2 );
      if ( std::string::npos != invert ) {
        if ( theName == theType ) {
          // This means that we got something like "Type:invert",
          // so we have to strip the ":invert" from the type too.
          theType = theType.substr( 0, invert );
        }
        theName = theName.substr( 0, invert );
        isInverted = true;
      }
      // Check whether the suppied name corresponds to an existing
      // Algorithm object.
      IAlgorithm* theIAlg;
      Algorithm*  theAlgorithm;
      StatusCode status = theAlgMgr->getAlgorithm( theName, theIAlg );
      if ( status.isSuccess( ) ) {
        try{
          theAlgorithm = dynamic_cast<Algorithm*>(theIAlg);
        } catch(...){
          log << MSG::WARNING << theName << " is not an Algorithm - Failed dynamic cast" << endreq;
          status = StatusCode::FAILURE;
        }
      }
      if ( status.isSuccess( ) ) {
        
        // The specified Algorithm already exists - just append it to the membership list.
        status = append( theAlgorithm, theAlgs );
        if ( status.isSuccess( ) ) {
          log << MSG::DEBUG << theName << " already exists - appended to member list" << endreq;
        } else {
          log << MSG::WARNING << theName << " already exists - append failed!!!" << endreq;
          result = StatusCode::FAILURE;
        }
      } else {
        
        // The specified name doesn't exist - create a new object of the specified type
        // and append it to the membership list.
        status = createAndAppend( theType, theName, theAlgorithm, theAlgs );
        if ( status.isSuccess( ) ) {
          log << MSG::DEBUG << theName << " doesn't exist - created and appended to member list" << endreq;
        } else {
          log << MSG::WARNING << theName << " doesn't exist - creation failed!!!" << endreq;
          result = StatusCode::FAILURE;
        }
      }
      if ( status.isSuccess( ) ) {
        theLogic.push_back( isInverted );
      }
    }
    
  }
  // Print membership list
  if ( result.isSuccess() && theAlgs->size() != 0 ) {
    log << MSG::INFO << "Member list: ";
    std::vector<Algorithm*>::iterator ai = theAlgs->begin();
    std::vector<bool>::iterator li = theLogic.begin();
    for ( ; ai != theAlgs->end(); ++ai, ++li ) {
      
      if ( ai != theAlgs->begin() ) log << ", ";
      
      if ( (*ai)->name() == System::typeinfoName(typeid(**ai)) )
        log << (*ai)->name();
      else
        log << System::typeinfoName(typeid(**ai)) << "/" << (*ai)->name();
      
      if (*li) log << ":invert";
    }
    log << endmsg;
  }
  theAlgMgr->release();
  return result;
}

StatusCode Sequencer::execute	(	std::vector< Algorithm * > *	theAlgs,
		std::vector< bool > &	theLogic,
		Algorithm *&	lastAlgorithm,
		unsigned int	first = 0
	)			[protected]

Execute the members in the specified list.

Definition at line 700 of file Sequencer.cpp.

{
  StatusCode result = StatusCode::SUCCESS;
  
  // Loop over all algorithms calling their execute functions if they
  // are (a) not disabled, and (b) aren't already executed. Note that
  // in the latter case the filter state is still examined. Terminate
  // the loop if an algorithm indicates that it's filter didn't pass.
  unsigned int size = theAlgs->size( );
  for (unsigned int i = first; i < size; i++) {
    lastAlgorithm = (*theAlgs)[i];
    result = executeMember( lastAlgorithm );
    if ( result.isSuccess( ) ) {
      
      // Take the filter passed status of this algorithm as my own status.
      // Note that we take into account inverted logic.
      bool passed = lastAlgorithm->filterPassed( );
      bool isInverted = theLogic[i];
      if ( isInverted ) {
        passed = ! passed;
      }
      setFilterPassed( passed );
      
      // The behaviour when the filter fails depends on the StopOverride property.
      // The default action is to stop processing, but this default can be
      // overridden by setting the "StopOverride" property to true.
      if ( ! isStopOverride( ) ) {
        if ( ! passed ) break;
      }
    } else {
      break;
    }
  }
  return result;
}

StatusCode Sequencer::executeMember

(

Algorithm *

theAlgorithm

)

[protected]

Execute member algorithm.

Definition at line 740 of file Sequencer.cpp.

{
  StatusCode result = StatusCode::SUCCESS;
  if ( theAlgorithm->isEnabled( ) ) {
    if ( ! theAlgorithm->isExecuted( ) ) {
      result = theAlgorithm->sysExecute( );
      
      // Set the executed state of the algorithm.
      // I think this should be done by the algorithm itself, but just in case...
      theAlgorithm->setExecuted( true );
    }
  }
  return result;
}

StatusCode Sequencer::remove	(	const std::string &	algname,
		std::vector< Algorithm * > *	theAlgs
	)			[protected]

Remove the specified algorithm from the sequencer.

Definition at line 756 of file Sequencer.cpp.

{
  MsgStream log( msgSvc( ), name( ) );
  StatusCode result = StatusCode::FAILURE;
  
  // Test that the algorithm exists in the member list
  std::vector<Algorithm*>::iterator it;
  std::vector<Algorithm*>::iterator itend = theAlgs->end( );
  for (it = theAlgs->begin(); it != itend; it++) {
    Algorithm* theAlgorithm = (*it);
    if ( theAlgorithm->name( ) == algname ) {
      
      // Algorithm with specified name exists in the algorithm list - remove it
      // THIS ISN'T IMPLEMENTED YET!!!!
      log << MSG::INFO <<"Sequencer::remove( ) isn't implemented yet!!!!!" << endreq;
      result = StatusCode::SUCCESS;
      break;
    }
  }
  return result;
}

Sequencer& Sequencer::operator=

(

const Sequencer &

rhs

)

[private]

Private asignment operator: NO ASSIGNMENT ALLOWED.

---

Member Data Documentation

StringArrayProperty Sequencer::m_names [private]

Definition at line 244 of file Sequencer.h.

std::vector<bool> Sequencer::m_isInverted [private]

Definition at line 245 of file Sequencer.h.

StringArrayProperty Sequencer::m_branchNames [private]

Definition at line 246 of file Sequencer.h.

std::vector<Algorithm*>* Sequencer::m_branchAlgs [private]

Definition at line 247 of file Sequencer.h.

std::vector<bool> Sequencer::m_isBranchInverted [private]

Definition at line 248 of file Sequencer.h.

BooleanProperty Sequencer::m_stopOverride [private]

Definition at line 249 of file Sequencer.h.

bool Sequencer::m_branchFilterPassed [private]

Definition at line 250 of file Sequencer.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiAlg/GaudiAlg/Sequencer.h
• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiAlg/src/lib/Sequencer.cpp

---