Commits

Anonymous committed 35646e0

EventCounter.h Prescaler.h Sequencer.h
Changes for Gaudi Release 4 and improved comments etc.

David Quarrie

Comments (0)

Files changed (3)

GaudiSequencer/EventCounter.h

-///#include <iostream.h>
 #include "Gaudi/Algorithm/Algorithm.h"
 #include "Gaudi/JobOptionsSvc/Property.h"
 
 class EventCounter : public Algorithm {
 public:
+
+    /**
+     ** Constructor(s)
+     **/
     EventCounter( const std::string& name, ISvcLocator* pSvcLocator );
+
+    /**
+     ** Destructor
+     **/
     ~EventCounter( );
+
+    /*****************************
+     ** Public Function Members **
+     *****************************/
+
     StatusCode initialize();
     StatusCode execute();
     StatusCode finalize();
 
 private:
+
+    /**************************
+     ** Private Data Members **
+     **************************/
+
+    /**
+     ** The frequency with which the number of events
+     ** should be reported. The default is 1, corresponding
+     ** to every event.
+     **/
     IntegerProperty m_frequency;
+
+    /**
+     ** The number of events skipped since the last time
+     ** the count was reported.
+     **/
     int m_skip;
+
+    /**
+     ** The total events seen.
+     **/
     int m_total;
 };

GaudiSequencer/Prescaler.h

-///#include <iostream.h>
 #include "Gaudi/Algorithm/Algorithm.h"
 #include "Gaudi/JobOptionsSvc/Property.h"
 
 class Prescaler:public Algorithm {
 public:
+
+    /**
+     ** Constructor(s)
+     **/
     Prescaler( const std::string& name, ISvcLocator* pSvcLocator );
+
+    /**
+     ** Destructor
+     **/
     ~Prescaler( );
+
+    /*****************************
+     ** Public Function Members **
+     *****************************/
+
     StatusCode initialize();
     StatusCode execute();
     StatusCode finalize();
 
 private:
-    SimpleProperty<double> m_percentPass;
+
+    /**************************
+     ** Private Data Members **
+     **************************/
+
+    /**
+     ** Percentage of events that should be passed
+     **/
+    DoubleProperty m_percentPass;
+
+    /**
+     ** Number of events passed
+     **/
     int m_pass;
+
+    /**
+     ** Number of events seen
+     **/
     int m_seen;
 };

GaudiSequencer/Sequencer.h

-// $Header: /build/atlas/cvs/atlas/offline/Control/GaudiSequencer/GaudiSequencer/Sequencer.h,v 1.1 2000-05-02 18:27:22 calaf Exp $
+// $Header: /build/atlas/cvs/atlas/offline/Control/GaudiSequencer/GaudiSequencer/Sequencer.h,v 1.2 2000-06-02 08:23:38 dquarrie Exp $
 #ifndef ALGORITHM_SEQUENCER_H
 #define ALGORITHM_SEQUENCER_H
 
 #include "Gaudi/Algorithm/Algorithm.h"
 #include "Gaudi/JobOptionsSvc/Property.h"
 
-//
-// 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.
-//
+/**
+ ** 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.
+ **/
 class Sequencer : virtual public Algorithm {
  public:
-    // Constructor and destructor
-    GaudiDllCall Sequencer( const std::string& name, // The path object's name
+
+    /**
+     ** Constructor(s)
+     **/
+    Sequencer( const std::string& name, // The path object's name
 	                        ISvcLocator *svcloc      // A pointer to a service location service
-		                   );
-    GaudiDllCall virtual ~Sequencer( );
+              );
 
-    // 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.
-    GaudiDllCall virtual StatusCode initialize( );
+    /**
+     ** Destructor
+     **/
+    virtual ~Sequencer( );
 
-    // The actions to be performed by the sequencer on an event. This method
-    // is invoked once per event.
-    GaudiDllCall virtual StatusCode execute( );
+    /*****************************
+     ** Public Function Members **
+     *****************************/
 
-    // Sequencer finalization.
-    GaudiDllCall virtual StatusCode finalize( );
+    /**
+     ** 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.
+     **/
+    virtual StatusCode initialize( );
 
-    // Reset the Sequencer
-    GaudiDllCall StatusCode reset( );
+    /**
+     ** The actions to be performed by the sequencer on an event. This method
+     ** is invoked once per event.
+     **/
+    virtual StatusCode execute( );
 
-    // Append an algorithm to the sequencer.
-    GaudiDllCall StatusCode append( Algorithm* pAlgorithm );
+    /**
+     ** Sequencer finalization.
+     **/
+    virtual StatusCode finalize( );
 
-    // 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.
-    GaudiDllCall StatusCode createAndAppend(
+    /**
+     ** Reset the Sequencer
+      **/
+    StatusCode reset( );
+
+    /**
+     ** Append an algorithm to the sequencer.
+     **/
+    StatusCode append( 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.
+     **/
+     StatusCode createAndAppend(
 	    const std::string& type,  // The concrete algorithm class of the algorithm
 	    const std::string& name,  // The name to be given to the algorithm
 	    Algorithm*& pAlgorithm    // Set to point to the newly created algorithm object
         );
 
-    // Remove the specified algorithm from the sequencer
-    GaudiDllCall StatusCode remove( Algorithm* pAlgorithm );
-    GaudiDllCall StatusCode remove( const std::string& name );
+    /**
+     ** Remove the specified algorithm from the sequencer
+     **/
+    StatusCode remove( Algorithm* pAlgorithm );
+    StatusCode remove( const std::string& name );
 
  private:
+
+    /******************************
+     ** Private Function Members **
+     ******************************/
+
+    /**
+     ** Private Copy constructor: NO COPY ALLOWED
+     **/
+    Sequencer( const Sequencer& a );
+
+    /**
+     ** Private asignment operator: NO ASSIGNMENT ALLOWED
+     **/
+    Sequencer& operator=( const Sequencer& rhs );
+
+    /**************************
+     ** Private Data Members **
+     **************************/
+
     std::vector<std::string> m_Names;        // Member names
     BooleanProperty m_stopOverride;          // Stop on filter failure Override flag
-
-    // Private Copy constructor: NO COPY ALLOWED
-    GaudiDllCall Sequencer( const Sequencer& a );
-
-    // Private asignment operator: NO ASSIGNMENT ALLOWED
-    GaudiDllCall Sequencer& operator=( const Sequencer& rhs );
 };
 
 #endif //ALGORITHM_SEQUENCER_H