CMS 3D CMS Logo

List of all members | Classes | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
FWJobMetadataManager Class Referenceabstract

#include <FWJobMetadataManager.h>

Inheritance diagram for FWJobMetadataManager:
FWFFMetadataManager FWLiteJobMetadataManager

Classes

struct  Data
 

Public Member Functions

 FWJobMetadataManager ()
 
virtual bool hasModuleLabel (std::string &moduleLabel)=0
 
void initReps (const FWTypeToRepresentations &iTypeAndReps)
 
std::vector< std::string > & processNamesInJob ()
 
void update (FWJobMetadataUpdateRequest *request)
 
std::vector< Data > & usableData ()
 
virtual ~FWJobMetadataManager ()
 

Public Attributes

sigc::signal< void()> metadataChanged_
 

Protected Member Functions

virtual bool doUpdate (FWJobMetadataUpdateRequest *)=0
 

Protected Attributes

std::vector< Datam_metadata
 
std::vector< std::string > m_processNamesInJob
 
FWTypeToRepresentationsm_typeAndReps
 

Detailed Description

Base class which keeps track of various job specific metadata information. fwlite and (eventually) full-framework derived implementations are where the job is actually done.

Definition at line 18 of file FWJobMetadataManager.h.

Constructor & Destructor Documentation

◆ FWJobMetadataManager()

FWJobMetadataManager::FWJobMetadataManager ( void  )

Definition at line 5 of file FWJobMetadataManager.cc.

5 : m_typeAndReps(nullptr) {}
FWTypeToRepresentations * m_typeAndReps

◆ ~FWJobMetadataManager()

FWJobMetadataManager::~FWJobMetadataManager ( )
virtual

Definition at line 7 of file FWJobMetadataManager.cc.

7 {}

Member Function Documentation

◆ doUpdate()

virtual bool FWJobMetadataManager::doUpdate ( FWJobMetadataUpdateRequest )
protectedpure virtual

This is the bit that needs to be implemented by a derived class to update the various metadata structures.

Returns
true if any update actually took place.

Implemented in FWFFMetadataManager, and FWLiteJobMetadataManager.

Referenced by update().

◆ hasModuleLabel()

virtual bool FWJobMetadataManager::hasModuleLabel ( std::string &  moduleLabel)
pure virtual

◆ initReps()

void FWJobMetadataManager::initReps ( const FWTypeToRepresentations iTypeAndReps)

This needs to be invoked to make the metadata manager keep track of the changes in the TypeToRepresentation.

Definition at line 25 of file FWJobMetadataManager.cc.

References m_typeAndReps.

Referenced by CmsShowMainBase::setupViewManagers().

25  {
26  delete m_typeAndReps;
27  m_typeAndReps = new FWTypeToRepresentations(iTypeAndReps);
28 }
FWTypeToRepresentations * m_typeAndReps

◆ processNamesInJob()

std::vector<std::string>& FWJobMetadataManager::processNamesInJob ( )
inline

◆ update()

void FWJobMetadataManager::update ( FWJobMetadataUpdateRequest request)

Invoked when a given update request needs to happen. Will emit the metadataChanged_ signal when done so that observers can update accordingly.

Derived classes should implement the doUpdate() protected method to actually modify the metadata according to the request.

Notice that this method is a consumer of request object and takes ownership of the lifetime of the request objects.

Invoked when a given update request needs to happen. Will emit the metadataChanged_ signal when done so that observers can update accordingly.

Derived classes should implement the doUpdate() protected method to actually modify the metadata according to the request.

Notice that this method is a consumer of request object and takes ownership of the lifetime of the request objects.

Definition at line 19 of file FWJobMetadataManager.cc.

References doUpdate(), and metadataChanged_.

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

19  {
20  std::unique_ptr<FWJobMetadataUpdateRequest> ptr(request);
21  if (doUpdate(request))
23 }
virtual bool doUpdate(FWJobMetadataUpdateRequest *)=0
sigc::signal< void()> metadataChanged_

◆ usableData()

std::vector<Data>& FWJobMetadataManager::usableData ( )
inline

Member Data Documentation

◆ m_metadata

std::vector<Data> FWJobMetadataManager::m_metadata
protected

Definition at line 63 of file FWJobMetadataManager.h.

Referenced by usableData().

◆ m_processNamesInJob

std::vector<std::string> FWJobMetadataManager::m_processNamesInJob
protected

Definition at line 64 of file FWJobMetadataManager.h.

Referenced by processNamesInJob().

◆ m_typeAndReps

FWTypeToRepresentations* FWJobMetadataManager::m_typeAndReps
protected

◆ metadataChanged_

sigc::signal<void()> FWJobMetadataManager::metadataChanged_

Definition at line 54 of file FWJobMetadataManager.h.

Referenced by FWGUIEventDataAdder::FWGUIEventDataAdder(), and update().