MarlinTrk::IMarlinTrkSystem Class Reference

Base class for tracking system implementations in MarlinTrk. More...

#include <IMarlinTrkSystem.h>

Inheritance diagram for MarlinTrk::IMarlinTrkSystem:

Classes
struct	CFG
	'Enums' for configuration options to be used with setOption(). More...

Public Member Functions
virtual	~IMarlinTrkSystem ()
	D'tor - cleans up any allocated resources. More...
virtual void	setOption (unsigned CFGOption, bool val)
	Sets the specified option ( one of the constants defined in IMarlinTrkSystem::CFG ) to the given value. More...
bool	getOption (unsigned CFGOption)
	Return the option's current value - false if option not defined. More...
std::string	getOptions ()
	String with all configuration options and their current values. More...
virtual std::string	name ()
	the name of the implementation More...
virtual void	init ()=0
	Initialise tracking system - to be called after configuration with setOption() - IMarlinTrkSystem cannot be used before a call to init(). More...
virtual MarlinTrk::IMarlinTrack *	createTrack ()=0
	Return an instance of IMarlinTrack corresponding to the current implementation. More...

Protected Member Functions
void	registerOptions ()
	Register the possible configuration options. More...

Protected Attributes
ConfigFlags	_cfg {}

Private Member Functions
IMarlinTrkSystem &	operator= (const IMarlinTrkSystem &)

Detailed Description

Base class for tracking system implementations in MarlinTrk.

Version

$Id$

Author

S.Aplin, F. Gaede DESY

Definition at line 45 of file IMarlinTrkSystem.h.

Constructor & Destructor Documentation

virtual MarlinTrk::IMarlinTrkSystem::~IMarlinTrkSystem ( )

inlinevirtual

D'tor - cleans up any allocated resources.

Definition at line 65 of file IMarlinTrkSystem.h.

Member Function Documentation

virtual MarlinTrk::IMarlinTrack* MarlinTrk::IMarlinTrkSystem::createTrack ( )

pure virtual

Return an instance of IMarlinTrack corresponding to the current implementation.

Implemented in MarlinTrk::MarlinDDKalTest, and MarlinTrk::MarlinAidaTT.

Referenced by MarlinTrk::finaliseLCIOTrack().

bool MarlinTrk::IMarlinTrkSystem::getOption

(

unsigned

CFGOption

)

Return the option's current value - false if option not defined.

Definition at line 11 of file IMarlinTrkSystem.cc.

References _cfg.

Referenced by MarlinTrk::MarlinDDKalTestTrack::fit(), MarlinTrk::MarlinAidaTT::init(), MarlinTrk::MarlinDDKalTest::init(), and MarlinTrk::TrkSysConfig< CFG >::TrkSysConfig().

std::string MarlinTrk::IMarlinTrkSystem::getOptions

(

)

String with all configuration options and their current values.

Definition at line 16 of file IMarlinTrkSystem.cc.

References _cfg, and std::stringstream::str().

Referenced by MarlinTrk::MarlinAidaTT::init(), and MarlinTrk::MarlinDDKalTest::init().

virtual void MarlinTrk::IMarlinTrkSystem::init ( )

pure virtual

Initialise tracking system - to be called after configuration with setOption() - IMarlinTrkSystem cannot be used before a call to init().

Implemented in MarlinTrk::MarlinDDKalTest, and MarlinTrk::MarlinAidaTT.

virtual std::string MarlinTrk::IMarlinTrkSystem::name ( )

inlinevirtual

the name of the implementation

Reimplemented in MarlinTrk::MarlinDDKalTest, and MarlinTrk::MarlinAidaTT.

Definition at line 83 of file IMarlinTrkSystem.h.

Referenced by MarlinTrk::finaliseLCIOTrack().

IMarlinTrkSystem& MarlinTrk::IMarlinTrkSystem::operator= ( const IMarlinTrkSystem &  )

private

void MarlinTrk::IMarlinTrkSystem::registerOptions ( )

protected

Register the possible configuration options.

Definition at line 23 of file IMarlinTrkSystem.cc.

References _cfg, MarlinTrk::ConfigFlags::registerOption(), MarlinTrk::IMarlinTrkSystem::CFG::usedEdx, MarlinTrk::IMarlinTrkSystem::CFG::useQMS, and MarlinTrk::IMarlinTrkSystem::CFG::useSmoothing.

Referenced by MarlinTrk::MarlinAidaTT::MarlinAidaTT(), and MarlinTrk::MarlinDDKalTest::MarlinDDKalTest().

void MarlinTrk::IMarlinTrkSystem::setOption ( unsigned  CFGOption, bool  val  )

virtual

Sets the specified option ( one of the constants defined in IMarlinTrkSystem::CFG ) to the given value.

Implementation classes can override this if they need to re-configure after the initialization.

Reimplemented in MarlinTrk::MarlinDDKalTest.

Definition at line 6 of file IMarlinTrkSystem.cc.

References _cfg, and MarlinTrk::ConfigFlags::setOption().

Referenced by MarlinTrk::MarlinDDKalTest::setOption(), MarlinTrk::TrkSysConfig< CFG >::TrkSysConfig(), and MarlinTrk::TrkSysConfig< CFG >::~TrkSysConfig().

Member Data Documentation

ConfigFlags MarlinTrk::IMarlinTrkSystem::_cfg {}

protected

Definition at line 106 of file IMarlinTrkSystem.h.

Referenced by getOption(), getOptions(), registerOptions(), and setOption().

---

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

• /afs/desy.de/user/d/dudarboh/iLCSoft/MarlinTrk/include/MarlinTrk/IMarlinTrkSystem.h
• /afs/desy.de/user/d/dudarboh/iLCSoft/MarlinTrk/src/IMarlinTrkSystem.cc