edm::ProcessingController Class Reference

#include <ProcessingController.h>

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. More...
ForwardState	forwardState () const
	Returns the present state of processing. More...
bool	lastOperationSucceeded () const
const ProcessingController &	operator= (const ProcessingController &)=delete
	ProcessingController (ForwardState forwardState, ReverseState reverseState, bool iCanRandomAccess)
	ProcessingController (const ProcessingController &)=delete
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 Attributes
bool	canRandomAccess_
ForwardState	forwardState_
bool	lastOperationSucceeded_
ReverseState	reverseState_
EventID	specifiedEvent_
Transition	transition_

Detailed Description

Definition at line 29 of file ProcessingController.h.

Member Enumeration Documentation

ForwardState

enum edm::ProcessingController::ForwardState

Enumerator
kEventsAheadInFile
kNextFileExists
kAtLastEvent
kUnknownForward

Definition at line 31 of file ProcessingController.h.

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

ReverseState

enum edm::ProcessingController::ReverseState

Enumerator
kEventsBackwardsInFile
kPreviousFileExists
kAtFirstEvent
kUnknownReverse

Definition at line 38 of file ProcessingController.h.

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

Transition

enum edm::ProcessingController::Transition

Enumerator
kToNextEvent
kToPreviousEvent
kToSpecifiedEvent

Definition at line 58 of file ProcessingController.h.

{ kToNextEvent, kToPreviousEvent, kToSpecifiedEvent };

Constructor & Destructor Documentation

ProcessingController() [1/2]

ProcessingController::ProcessingController	(	ForwardState	forwardState,
		ReverseState	reverseState,
		bool	iCanRandomAccess
	)

Definition at line 30 of file ProcessingController.cc.

    : forwardState_(forwardState),
      reverseState_(reverseState),
      transition_(kToNextEvent),
      specifiedEvent_(),
      canRandomAccess_(iCanRandomAccess),
      lastOperationSucceeded_(true) {}

ProcessingController() [2/2]

edm::ProcessingController::ProcessingController ( const ProcessingController &  )

delete

Member Function Documentation

canRandomAccess()

bool ProcessingController::canRandomAccess

(

)

const

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

Definition at line 80 of file ProcessingController.cc.

References canRandomAccess_.

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

{ return canRandomAccess_; }

forwardState()

ProcessingController::ForwardState ProcessingController::forwardState

(

)

const

Returns the present state of processing.

Definition at line 76 of file ProcessingController.cc.

References forwardState_.

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

{ return forwardState_; }

lastOperationSucceeded()

bool ProcessingController::lastOperationSucceeded

(

)

const

Definition at line 86 of file ProcessingController.cc.

References lastOperationSucceeded_.

Referenced by edm::NavigateEventsLooper::duringLoop(), and edm::EventProcessor::processEventWithLooper().

{ return lastOperationSucceeded_; }

operator=()

const ProcessingController& edm::ProcessingController::operator= ( const ProcessingController &  )

delete

requestedTransition()

ProcessingController::Transition ProcessingController::requestedTransition

(

)

const

Definition at line 82 of file ProcessingController.cc.

References transition_.

Referenced by edm::EventProcessor::processEventWithLooper().

{ return transition_; }

reverseState()

ProcessingController::ReverseState ProcessingController::reverseState

(

)

const

Definition at line 78 of file ProcessingController.cc.

References reverseState_.

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

{ return reverseState_; }

setLastOperationSucceeded()

void ProcessingController::setLastOperationSucceeded

(

bool

value

)

Definition at line 71 of file ProcessingController.cc.

References lastOperationSucceeded_, and relativeConstraints::value.

Referenced by edm::EventProcessor::processEventWithLooper().

{ lastOperationSucceeded_ = value; }

setTransitionToEvent()

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 66 of file ProcessingController.cc.

References kToSpecifiedEvent, specifiedEvent_, and transition_.

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

                                                                     {
  transition_ = kToSpecifiedEvent;
  specifiedEvent_ = iID;
}

setTransitionToNextEvent()

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 62 of file ProcessingController.cc.

References kToNextEvent, and transition_.

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

{ transition_ = kToNextEvent; }

setTransitionToPreviousEvent()

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 64 of file ProcessingController.cc.

References kToPreviousEvent, and transition_.

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

{ transition_ = kToPreviousEvent; }

specifiedEventTransition()

edm::EventID ProcessingController::specifiedEventTransition

(

)

const

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

Definition at line 84 of file ProcessingController.cc.

References specifiedEvent_.

Referenced by edm::EventProcessor::processEventWithLooper().

{ return specifiedEvent_; }

Member Data Documentation

canRandomAccess_

bool edm::ProcessingController::canRandomAccess_

private

Definition at line 95 of file ProcessingController.h.

Referenced by canRandomAccess().

forwardState_

ForwardState edm::ProcessingController::forwardState_

private

Definition at line 91 of file ProcessingController.h.

Referenced by forwardState().

lastOperationSucceeded_

bool edm::ProcessingController::lastOperationSucceeded_

private

Definition at line 96 of file ProcessingController.h.

Referenced by lastOperationSucceeded(), and setLastOperationSucceeded().

reverseState_

ReverseState edm::ProcessingController::reverseState_

private

Definition at line 92 of file ProcessingController.h.

Referenced by reverseState().

specifiedEvent_

EventID edm::ProcessingController::specifiedEvent_

private

Definition at line 94 of file ProcessingController.h.

Referenced by setTransitionToEvent(), and specifiedEventTransition().

transition_

Transition edm::ProcessingController::transition_

private

Definition at line 93 of file ProcessingController.h.

Referenced by requestedTransition(), setTransitionToEvent(), setTransitionToNextEvent(), and setTransitionToPreviousEvent().