CMS 3D CMS Logo

Public Types | Public Member Functions | Private Member Functions | Private Attributes

edm::ProcessingController Class Reference

#include <ProcessingController.h>

List of all members.

Public Types

enum  ForwardState { kEventsAheadInFile, kNextFileExists, kAtLastEvent, kUnknownForward }
enum  ReverseState { kEventsBackwardsInFile, kPreviousFileExists, kAtFirstEvent, kUnknownReverse }
enum  Transition { kToNextEvent, kToPreviousEvent, kToSpecifiedEvent }

Public Member Functions

bool canRandomAccess () const
 Returns 'true' if the job's source can randomly access.
ForwardState forwardState () const
 Returns the present state of processing.
bool lastOperationSucceeded () const
 ProcessingController (ForwardState forwardState, ReverseState reverseState, bool iCanRandomAccess)
Transition requestedTransition () const
ReverseState reverseState () const
void setLastOperationSucceeded (bool value)
void setTransitionToEvent (edm::EventID const &iID)
void setTransitionToNextEvent ()
void setTransitionToPreviousEvent ()
edm::EventID specifiedEventTransition () const

Private Member Functions

const ProcessingControlleroperator= (const ProcessingController &)
 ProcessingController (const ProcessingController &)

Private Attributes

bool canRandomAccess_
ForwardState forwardState_
bool lastOperationSucceeded_
ReverseState reverseState_
EventID specifiedEvent_
Transition transition_

Detailed Description

Definition at line 30 of file ProcessingController.h.


Member Enumeration Documentation

Enumerator:
kEventsAheadInFile 
kNextFileExists 
kAtLastEvent 
kUnknownForward 

Definition at line 33 of file ProcessingController.h.

                        {
         kEventsAheadInFile,
         kNextFileExists, // but no events ahead in this file
         kAtLastEvent,
         kUnknownForward // returned by a source which is not random accessible
      };
Enumerator:
kEventsBackwardsInFile 
kPreviousFileExists 
kAtFirstEvent 
kUnknownReverse 

Definition at line 40 of file ProcessingController.h.

                        {
         kEventsBackwardsInFile,
         kPreviousFileExists, // but no events backwards in this file
         kAtFirstEvent,
         kUnknownReverse // returned by a source which is not random accessible
      };
Enumerator:
kToNextEvent 
kToPreviousEvent 
kToSpecifiedEvent 

Definition at line 59 of file ProcessingController.h.


Constructor & Destructor Documentation

ProcessingController::ProcessingController ( ForwardState  forwardState,
ReverseState  reverseState,
bool  iCanRandomAccess 
)
edm::ProcessingController::ProcessingController ( const ProcessingController ) [private]

Member Function Documentation

bool ProcessingController::canRandomAccess ( ) const

Returns 'true' if the job's source can randomly access.

Definition at line 106 of file ProcessingController.cc.

References canRandomAccess_.

Referenced by edm::NavigateEventsLooper::duringLoop().

{
   return canRandomAccess_;
}
ProcessingController::ForwardState ProcessingController::forwardState ( ) const

Returns the present state of processing.

Definition at line 94 of file ProcessingController.cc.

References forwardState_.

Referenced by edm::NavigateEventsLooper::duringLoop(), and FWFFLooper::duringLoop().

{
   return forwardState_;
}
bool ProcessingController::lastOperationSucceeded ( ) const
const ProcessingController& edm::ProcessingController::operator= ( const ProcessingController ) [private]
ProcessingController::Transition ProcessingController::requestedTransition ( ) const

Definition at line 112 of file ProcessingController.cc.

References transition_.

{
   return transition_;
}
ProcessingController::ReverseState ProcessingController::reverseState ( ) const

Definition at line 100 of file ProcessingController.cc.

References reverseState_.

Referenced by edm::NavigateEventsLooper::duringLoop(), and FWFFLooper::duringLoop().

{
   return reverseState_;
}
void ProcessingController::setLastOperationSucceeded ( bool  value)
void ProcessingController::setTransitionToEvent ( edm::EventID const &  iID)

Tells the framework that the next event to processes should be iID. If event iID can not be found in the source, the job will drop out of the event loop.

Definition at line 78 of file ProcessingController.cc.

References kToSpecifiedEvent, specifiedEvent_, and transition_.

Referenced by edm::NavigateEventsLooper::duringLoop(), and FWFFLooper::duringLoop().

void ProcessingController::setTransitionToNextEvent ( )

Tells the framework that we should go onto the next event in the sequence. If there is no next event the job will drop out of the event loop.

Definition at line 66 of file ProcessingController.cc.

References kToNextEvent, and transition_.

Referenced by edm::NavigateEventsLooper::duringLoop(), and FWFFLooper::duringLoop().

void ProcessingController::setTransitionToPreviousEvent ( )

Tells the framework we should backup and run the previous event seen in the sequence. If you are already at the first event the job will drop out of the event loop

Definition at line 72 of file ProcessingController.cc.

References kToPreviousEvent, and transition_.

Referenced by edm::NavigateEventsLooper::duringLoop(), and FWFFLooper::duringLoop().

edm::EventID ProcessingController::specifiedEventTransition ( ) const

If 'setTransitionToEvent was called this returns the value passed, else it returns an invalid EventID

Definition at line 119 of file ProcessingController.cc.

References specifiedEvent_.

{
   return specifiedEvent_;
}

Member Data Documentation

Definition at line 104 of file ProcessingController.h.

Referenced by canRandomAccess().

Definition at line 100 of file ProcessingController.h.

Referenced by forwardState().

Definition at line 105 of file ProcessingController.h.

Referenced by lastOperationSucceeded(), and setLastOperationSucceeded().

Definition at line 101 of file ProcessingController.h.

Referenced by reverseState().

Definition at line 103 of file ProcessingController.h.

Referenced by setTransitionToEvent(), and specifiedEventTransition().