JRECONSTRUCTION::JQualitySorter Struct Reference

General purpose sorter of fit results. More...

#include <JEvtToolkit.hh>

Inheritance diagram for JRECONSTRUCTION::JQualitySorter:

Public Types
typedef JFunctionAdaptor< bool, const JFit &, const JFit & >	function_adaptor_type
typedef function_adaptor_type::pF	pF

Public Member Functions
	JQualitySorter ()
	Default constructor.
JReturn_t	operator() (Args... args) const
	Function operation.
bool	is_valid () const
	Check validity of function.
void	reset ()
	Reset function adaptor helper.
void	set (__pF__ pf)
	Set function.
void	get (const char *symbol)
	Get function with given name according to specific protocol.
bool	is_open () const
	Check if shared library file is open.
void	open (const char *file_name)
	Open file.
void	close ()
	Close file.
void	load (const std::string &libso, const std::string &symbol)
	Load function from shared library.
void	reload ()
	Reload function from shared library.
void	initialise ()
	Initialise counter.
void	attach (const JSharedCounter &object)
	Attach this counter to given shared counter object.
bool	detach ()
	Detach.
const int	getCount ()
	Get count.

Static Public Attributes
static const char	SEPARATOR = ':'
	Separation character between library file name and function name.

Protected Attributes
void *	handle
__pF__	function
std::string	libso
std::string	symbol
int *	counter

Detailed Description

General purpose sorter of fit results.

The default constructor will sort fit results according the method JRECONSTRUCTION::qualitySorter.
A different method can dynamically be loaded from a (shared) library using class JEEP::JFunctionAdaptor. For the definition of an alternative method, see e.g. quality_sorter.cc

Definition at line 424 of file JReconstruction/JEvtToolkit.hh.

Member Typedef Documentation

function_adaptor_type

typedef JFunctionAdaptor<bool, const JFit&, const JFit&> JRECONSTRUCTION::JQualitySorter::function_adaptor_type

Definition at line 427 of file JReconstruction/JEvtToolkit.hh.

pF

typedef function_adaptor_type::pF JRECONSTRUCTION::JQualitySorter::pF

Definition at line 428 of file JReconstruction/JEvtToolkit.hh.

Constructor & Destructor Documentation

JQualitySorter()

JRECONSTRUCTION::JQualitySorter::JQualitySorter ( )

inline

Default constructor.

Definition at line 434 of file JReconstruction/JEvtToolkit.hh.

                     :
      function_adaptor_type(qualitySorter)
    {}

Member Function Documentation

operator()()

template<class JReturn_t = void, class ... Args>

JReturn_t JEEP::JFunctionAdaptor< JReturn_t, Args >::operator() ( Args... args ) const

inlineinherited

Function operation.

Parameters

args

arguments

Returns

return value

Definition at line 346 of file JFunctionAdaptor.hh.

    {
      return this->function(args...);
    }

is_valid()

template<class __pF__ >

bool JEEP::JFunctionAdaptorHelper< __pF__ >::is_valid ( ) const

inlineinherited

Check validity of function.

Returns

true if valid function; else false

Definition at line 56 of file JFunctionAdaptor.hh.

    {
      return (function != NULL);
    }

reset()

template<class __pF__ >

void JEEP::JFunctionAdaptorHelper< __pF__ >::reset ( )

inlineinherited

Reset function adaptor helper.

Definition at line 65 of file JFunctionAdaptor.hh.

    {
      if (detach()) {
        close();
      }
      
      function = NULL;
    }

set()

template<class __pF__ >

void JEEP::JFunctionAdaptorHelper< __pF__ >::set ( __pF__ pf )

inlineinherited

Set function.

Parameters

pf	pointer to function

Definition at line 80 of file JFunctionAdaptor.hh.

    {
      reset();
      
      function = pf;
    }

get()

template<class __pF__ >

void JEEP::JFunctionAdaptorHelper< __pF__ >::get ( const char * symbol )

inlineinherited

Get function with given name according to specific protocol.

Parameters

symbol

function name

Definition at line 93 of file JFunctionAdaptor.hh.

    {
      function = NULL;
 
      if (handle != NULL) {
 
        dlerror();                 // reset errors
 
        function = (__pF__) dlsym(handle, symbol);
 
        const char* error = dlerror();
 
        if (error != NULL) {
          THROW(JFileReadException, error);
        }
 
      } else {
 
        THROW(JFileReadException, "Invalid handle.");
      }
    }

is_open()

template<class __pF__ >

bool JEEP::JFunctionAdaptorHelper< __pF__ >::is_open ( ) const

inlineinherited

Check if shared library file is open.

Returns

true if open; else false

Definition at line 121 of file JFunctionAdaptor.hh.

    {
      return (handle != NULL);
    }

open()

template<class __pF__ >

void JEEP::JFunctionAdaptorHelper< __pF__ >::open ( const char * file_name )

inlineinherited

Open file.

Parameters

file_name

file name

Definition at line 132 of file JFunctionAdaptor.hh.

    {
      reset();
      
      handle = dlopen(file_name, RTLD_LOCAL | RTLD_LAZY);
 
      if (!handle) {
        THROW(JFileOpenException, dlerror());
      }
 
      initialise();
    }

close()

template<class __pF__ >

void JEEP::JFunctionAdaptorHelper< __pF__ >::close ( )

inlineinherited

Close file.

Note that the file should remain open as long as the library function is used.

Definition at line 151 of file JFunctionAdaptor.hh.

    {
      if (handle != NULL) {
        dlclose(handle);
        dlclose(handle);
      }
 
      handle = NULL;
    }

load()

template<class __pF__ >

void JEEP::JFunctionAdaptorHelper< __pF__ >::load ( const std::string & libso, const std::string & symbol )

inlineinherited

Load function from shared library.

Parameters

libso	file name
symbol	function name

Definition at line 168 of file JFunctionAdaptor.hh.

    {
      this->libso  = libso;
      this->symbol = symbol;
 
      reload();
    }

reload()

template<class __pF__ >

void JEEP::JFunctionAdaptorHelper< __pF__ >::reload ( )

inlineinherited

Reload function from shared library.

Definition at line 180 of file JFunctionAdaptor.hh.

    {
      open(libso.c_str());
 
      get(symbol.c_str());
    }

initialise()

void JLANG::JSharedCounter::initialise ( )

inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

    {
      detach();
 
      counter = new int(1);
    }

attach()

void JLANG::JSharedCounter::attach ( const JSharedCounter & object )

inlineinherited

Attach this counter to given shared counter object.

Parameters

object

shared counter

Definition at line 46 of file JSharedCounter.hh.

    {
      detach();
 
      counter = object.counter;
 
      if (counter != NULL) {
        ++(*counter);
      }
    }

detach()

bool JLANG::JSharedCounter::detach ( )

inlineinherited

Detach.

Returns

true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

    {
      if (counter != NULL) {
 
        if (--(*counter) == 0) {
 
          delete counter;
 
          counter = NULL;
 
          return true;
        }
 
        counter = NULL;
      }
 
      return false;
    }

getCount()

const int JLANG::JSharedCounter::getCount ( )

inlineinherited

Get count.

Returns

count

Definition at line 88 of file JSharedCounter.hh.

    {
      return (counter != NULL ? *counter : 0);
    }

Member Data Documentation

SEPARATOR

template<class __pF__ >

const char JEEP::JFunctionAdaptorHelper< __pF__ >::SEPARATOR = ':'

staticinherited

Separation character between library file name and function name.

Definition at line 39 of file JFunctionAdaptor.hh.

handle

template<class __pF__ >

void* JEEP::JFunctionAdaptorHelper< __pF__ >::handle

protectedinherited

Definition at line 290 of file JFunctionAdaptor.hh.

function

template<class __pF__ >

__pF__ JEEP::JFunctionAdaptorHelper< __pF__ >::function

protectedinherited

Definition at line 291 of file JFunctionAdaptor.hh.

libso

template<class __pF__ >

std::string JEEP::JFunctionAdaptorHelper< __pF__ >::libso

protectedinherited

Definition at line 292 of file JFunctionAdaptor.hh.

symbol

template<class __pF__ >

std::string JEEP::JFunctionAdaptorHelper< __pF__ >::symbol

protectedinherited

Definition at line 293 of file JFunctionAdaptor.hh.

counter

int* JLANG::JSharedCounter::counter

protectedinherited

Definition at line 94 of file JSharedCounter.hh.

---

The documentation for this struct was generated from the following file:

• JReconstruction/JEvtToolkit.hh