FWFFNavigator Class Reference

#include <FWFFNavigator.h>

Inheritance diagram for FWFFNavigator:

Public Types
enum	FWFFNavigatorState {   kNoTransition, kNextEvent, kPreviousEvent, kFirstEvent,   kLastEvent }
Public Types inherited from FWNavigatorBase
enum	EFilterMode { kOr = 1, kAnd = 2 }
enum	EFilterState { kOff, kOn, kWithdrawn }

Public Member Functions
void	addTo (FWConfiguration &) const override
enum FWFFNavigatorState	currentTransition ()
void	firstEvent () override
	FWFFNavigator (CmsShowMainBase &main)
const edm::EventBase *	getCurrentEvent () const override
const edm::EventID &	getFirstEventID ()
int	getNSelectedEvents () override
int	getNTotalEvents () override
void	goToRunEvent (edm::RunNumber_t, edm::LuminosityBlockNumber_t, edm::EventNumber_t) override
bool	isFirstEvent () override
bool	isLastEvent () override
void	lastEvent () override
void	nextEvent () override
bool	nextSelectedEvent () override
void	previousEvent () override
bool	previousSelectedEvent () override
void	resetTransition ()
void	setCurrentEvent (const edm::Event *)
void	setFrom (const FWConfiguration &) override
Public Member Functions inherited from FWNavigatorBase
	FWNavigatorBase (const CmsShowMainBase &)
	~FWNavigatorBase () override
Public Member Functions inherited from FWConfigurable
	FWConfigurable ()
virtual	~FWConfigurable ()

Private Attributes
const edm::Event *	m_currentEvent
enum FWFFNavigatorState	m_currentTransition
edm::EventID	m_firstEventID

Additional Inherited Members
Public Attributes inherited from FWNavigatorBase
sigc::signal< void >	newEvent_

Detailed Description

Definition at line 11 of file FWFFNavigator.h.

Member Enumeration Documentation

FWFFNavigatorState

enum FWFFNavigator::FWFFNavigatorState

Enumerator
kNoTransition
kNextEvent
kPreviousEvent
kFirstEvent
kLastEvent

Definition at line 13 of file FWFFNavigator.h.

{ kNoTransition, kNextEvent, kPreviousEvent, kFirstEvent, kLastEvent };

Constructor & Destructor Documentation

FWFFNavigator()

FWFFNavigator::FWFFNavigator ( CmsShowMainBase &  main )

inline

Definition at line 15 of file FWFFNavigator.h.

      : FWNavigatorBase(main), m_currentEvent(nullptr), m_currentTransition(kNoTransition) {}

Member Function Documentation

addTo()

void FWFFNavigator::addTo ( FWConfiguration &  ) const

inlineoverridevirtual

Implements FWNavigatorBase.

Definition at line 18 of file FWFFNavigator.h.

{}

currentTransition()

enum FWFFNavigatorState FWFFNavigator::currentTransition ( )

inline

Definition at line 55 of file FWFFNavigator.h.

{ return m_currentTransition; }

References m_currentTransition.

firstEvent()

void FWFFNavigator::firstEvent ( )

overridevirtual

Implements FWNavigatorBase.

Definition at line 14 of file FWFFNavigator.cc.

                               {
  m_currentTransition = kFirstEvent;
  gSystem->ExitLoop();
}

References kFirstEvent, and m_currentTransition.

getCurrentEvent()

const edm::EventBase* FWFFNavigator::getCurrentEvent ( ) const

inlineoverridevirtual

Implements FWNavigatorBase.

Definition at line 45 of file FWFFNavigator.h.

{ return m_currentEvent; }

References m_currentEvent.

getFirstEventID()

const edm::EventID & FWFFNavigator::getFirstEventID

(

)

Definition at line 35 of file FWFFNavigator.cc.

{ return m_firstEventID; }

References m_firstEventID.

getNSelectedEvents()

int FWFFNavigator::getNSelectedEvents ( )

inlineoverridevirtual

Implements FWNavigatorBase.

Definition at line 47 of file FWFFNavigator.h.

{ return getNTotalEvents(); }

References getNTotalEvents().

getNTotalEvents()

int FWFFNavigator::getNTotalEvents ( )

inlineoverridevirtual

Implements FWNavigatorBase.

Definition at line 50 of file FWFFNavigator.h.

{ return 0; }

Referenced by getNSelectedEvents().

goToRunEvent()

void FWFFNavigator::goToRunEvent ( edm::RunNumber_t  , edm::LuminosityBlockNumber_t  , edm::EventNumber_t    )

inlineoverridevirtual

Implements FWNavigatorBase.

Definition at line 39 of file FWFFNavigator.h.

{}

isFirstEvent()

bool FWFFNavigator::isFirstEvent ( )

inlineoverridevirtual

Implements FWNavigatorBase.

Definition at line 43 of file FWFFNavigator.h.

{ return m_currentEvent->id() == m_firstEventID; }

References edm::EventBase::id(), m_currentEvent, and m_firstEventID.

isLastEvent()

bool FWFFNavigator::isLastEvent ( )

inlineoverridevirtual

Implements FWNavigatorBase.

Definition at line 42 of file FWFFNavigator.h.

{ return false; }

lastEvent()

void FWFFNavigator::lastEvent ( )

overridevirtual

Implements FWNavigatorBase.

Definition at line 19 of file FWFFNavigator.cc.

                              {
  m_currentTransition = kLastEvent;
  gSystem->ExitLoop();
}

References kLastEvent, and m_currentTransition.

nextEvent()

void FWFFNavigator::nextEvent ( )

overridevirtual

Implements FWNavigatorBase.

Definition at line 4 of file FWFFNavigator.cc.

                              {
  m_currentTransition = kNextEvent;
  gSystem->ExitLoop();
}

References kNextEvent, and m_currentTransition.

Referenced by nextSelectedEvent().

nextSelectedEvent()

bool FWFFNavigator::nextSelectedEvent ( )

inlineoverridevirtual

Implements FWNavigatorBase.

Definition at line 25 of file FWFFNavigator.h.

                                    {
    nextEvent();
    return true;
  }

References nextEvent().

previousEvent()

void FWFFNavigator::previousEvent ( )

overridevirtual

Implements FWNavigatorBase.

Definition at line 9 of file FWFFNavigator.cc.

                                  {
  m_currentTransition = kPreviousEvent;
  gSystem->ExitLoop();
}

References kPreviousEvent, and m_currentTransition.

Referenced by previousSelectedEvent().

previousSelectedEvent()

bool FWFFNavigator::previousSelectedEvent ( )

inlineoverridevirtual

Implements FWNavigatorBase.

Definition at line 29 of file FWFFNavigator.h.

                                        {
    previousEvent();
    return true;
  }

References previousEvent().

resetTransition()

void FWFFNavigator::resetTransition ( )

inline

Definition at line 56 of file FWFFNavigator.h.

{ m_currentTransition = kNoTransition; }

References kNoTransition, and m_currentTransition.

setCurrentEvent()

void FWFFNavigator::setCurrentEvent

(

const edm::Event *

event

)

API to move to a given event. Notice that it is also responsible for keeping registering the ID of the first event, so that we can stop going back.

Definition at line 28 of file FWFFNavigator.cc.

                                                         {
  m_currentEvent = event;
  if (m_firstEventID == edm::EventID())
    m_firstEventID = m_currentEvent->id();
  newEvent_.emit();
}

References event(), edm::EventBase::id(), m_currentEvent, m_firstEventID, and FWNavigatorBase::newEvent_.

setFrom()

void FWFFNavigator::setFrom ( const FWConfiguration &  )

inlineoverridevirtual

Implements FWNavigatorBase.

Definition at line 19 of file FWFFNavigator.h.

{}

Member Data Documentation

m_currentEvent

const edm::Event* FWFFNavigator::m_currentEvent

private

Definition at line 59 of file FWFFNavigator.h.

Referenced by getCurrentEvent(), isFirstEvent(), and setCurrentEvent().

m_currentTransition

enum FWFFNavigatorState FWFFNavigator::m_currentTransition

private

Definition at line 61 of file FWFFNavigator.h.

Referenced by currentTransition(), firstEvent(), lastEvent(), nextEvent(), previousEvent(), and resetTransition().

m_firstEventID

edm::EventID FWFFNavigator::m_firstEventID

private

Definition at line 60 of file FWFFNavigator.h.

Referenced by getFirstEventID(), isFirstEvent(), and setCurrentEvent().