Marlin  1.17.1
 All Classes Namespaces Functions Variables Enumerations Friends Pages
Public Member Functions | List of all members
marlin::MarlinSteerCheck Class Reference

this class is a Marlin Steering File consistency check Tool. More...

#include <MarlinSteerCheck.h>

Public Member Functions

 MarlinSteerCheck (const char *steerFileName=NULL, const CommandLineParametersMap *cmdlineparams=NULL)
 
 MarlinSteerCheck (const marlin::MarlinSteerCheck &)=delete
 
MarlinSteerCheck operator= (const marlin::MarlinSteerCheck &)=delete
 
CMProcessorgetMProcs ()
 Returns the Marlin Processors.
 
ProcVec & getAProcs ()
 Returns the Active Processors.
 
ProcVec & getIProcs ()
 Returns the Inactive Processors.
 
int existsProcessor (const std::string &type, const std::string &name="")
 Check if a processor of the given type with the given name already exists Returns 0 if the processor does not exist Returns 1 if the processor exists and is active Returns 2 if the processor exists and is inactive.
 
ColVec & getLCIOCols () const
 Returns the collections read from LCIO files.
 
StringVec & getLCIOFiles ()
 Returns the names of the LCIO files found in the global section.
 
sSet & getColsSet (const std::string &type, const std::string &name, CCProcessor *proc)
 Returns a list of all available Collections for a given type, name and processor (to use in a ComboBox)
 
std::shared_ptr< StringParametersgetGlobalParameters ()
 Returns the Global Parameters.
 
void dumpColErrors (unsigned int i, std::ostream &stream, bool separators=false)
 Writes the collection errors for the active processor with given index to the given stream.
 
int addLCIOFile (const std::string &file)
 Add LCIO file and read all collections inside it.
 
void remLCIOFile (const std::string &file)
 Remove LCIO file and all collections associated to it.
 
void changeLCIOFilePos (unsigned int pos, unsigned int newPos)
 Change the LCIO File at the given index to the new given position.
 
void addProcessor (bool status, const std::string &name, const std::string &type, std::shared_ptr< StringParameters > p)
 Add a new processor.
 
void remProcessor (unsigned int index, bool status)
 Remove processor with the given status at the given index.
 
void activateProcessor (unsigned int index)
 Activate processor at the given index.
 
void deactivateProcessor (unsigned int index)
 Deactivate processor at the given index.
 
void changeProcessorPos (unsigned int pos, unsigned int newPos)
 Change the active processor at the given index to the new given position.
 
void consistencyCheck ()
 Performs a check at all active processors to search for unavailable collections.
 
bool saveAsXMLFile (const std::string &file)
 Saves the data to an XML file with the given name Returns false if error occured.
 
const std::string getXMLFileRelPath ()
 
const std::string getXMLFileAbsPath ()
 
const std::string getXMLFileName ()
 
const std::string getXMLFile ()
 
void dump_information ()
 Dumps all information read from the steering file to stdout.
 
sSet & getErrors ()
 Returns a set with all the errors found after performing a consistency check.
 
sSet & getPConditions ()
 Returns a set with all the processor's conditions.
 
const std::string getCondition (unsigned int index)
 Returns the condition for a given index.
 
void addCondition (const std::string &condition)
 Add a new Condition.
 
void repCondition (const std::string &oldCond, const std::string &newCond)
 Replace a Condition.
 
void remCondition (const std::string &condition)
 Removes the given condition.
 
bool saveAsDOTFile (const std::string &file)
 Saves steering file in dot format.
 

Detailed Description

this class is a Marlin Steering File consistency check Tool.

It can parse XML steering files using the marlin parser and search the lcio file(s) specified at the global section for available collections. Together with the active and inactive processors specified in the steering file and their respective collections it can perform a full consistency check and check for unavailable collections. The Program checks if an adequate available collection exists for every input collection of a processor.

(where input collection means a collection the processor requires as input, and output collections mean a collection that is created in the processor and marked as available for the upcoming processors)

Information about the consistency check can be dumped.

Author
Jan Engels, Benjamin Eberhardt, DESY
Version
Id:
MarlinSteerCheck.h,v 1.32 2007-04-23 16:21:01 gaede Exp

The documentation for this class was generated from the following files: