JFIT::JQualitySorter Struct Reference

General purpose sorter of fit results. More...

#include <JEvtToolkit.hh>

Inheritance diagram for JFIT::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. More...
bool	operator() (const JFit & first, const JFit & second) const
	Function operation. More...
bool	is_valid () const
	Check validity. More...
void	reset ()
	Reset function adaptor helper. More...
void	set (bool(*)(const JFit &, const JFit &) pf)
	Set function. More...
void	open (const char *file_name)
	Open file. More...
void	close ()
	Close file. More...
void	initialise ()
	Initialise counter. More...
void	attach (const JSharedCounter &object)
	Attach this counter to given shared counter object. More...
bool	detach ()
	Detach. More...

Protected Member Functions
void	get (const char *function_name)
	Get function with given name according to specific protocol. More...

Protected Attributes
void *	handle
bool(*)(const JFit &, const JFit &)	function
int *	counter

Detailed Description

General purpose sorter of fit results.

The default constructor will sort fit results according the method JFIT::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 239 of file JEvtToolkit.hh.

Member Typedef Documentation

function_adaptor_type

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

Definition at line 242 of file JEvtToolkit.hh.

pF

typedef function_adaptor_type::pF JFIT::JQualitySorter::pF

Definition at line 243 of file JEvtToolkit.hh.

Constructor & Destructor Documentation

JQualitySorter()

JFIT::JQualitySorter::JQualitySorter ( )

inline

Default constructor.

Definition at line 249 of file JEvtToolkit.hh.

                     :
      function_adaptor_type(qualitySorter)
    {}

Member Function Documentation

operator()()

bool JEEP::JFunctionAdaptor< bool , const JFit & , const JFit & >::operator() ( const JFit &  first, const JFit &  second  ) const

inlineinherited

Function operation.

Parameters

first	first argument
second	second argument

Returns

return value

Definition at line 372 of file JFunctionAdaptor.hh.

    {
      return this->function(first, second);
    }

is_valid()

bool JEEP::JFunctionAdaptorHelper< bool(*)(const JFit &, const JFit &) >::is_valid ( ) const

inlineinherited

Check validity.

Returns

true if valid function; else false

Definition at line 52 of file JFunctionAdaptor.hh.

    {
      return (function != NULL);
    }

reset()

void JEEP::JFunctionAdaptorHelper< bool(*)(const JFit &, const JFit &) >::reset ( )

inlineinherited

Reset function adaptor helper.

Definition at line 61 of file JFunctionAdaptor.hh.

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

set()

void JEEP::JFunctionAdaptorHelper< bool(*)(const JFit &, const JFit &) >::set ( bool(*)(const JFit &, const JFit &)  pf )

inlineinherited

Set function.

Parameters

pf	pointer to function

Definition at line 76 of file JFunctionAdaptor.hh.

    {
      reset();
      
      function = pf;
    }

open()

void JEEP::JFunctionAdaptorHelper< bool(*)(const JFit &, const JFit &) >::open ( const char *  file_name )

inlineinherited

Open file.

Parameters

file_name

file name

Definition at line 89 of file JFunctionAdaptor.hh.

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

close()

void JEEP::JFunctionAdaptorHelper< bool(*)(const JFit &, const JFit &) >::close ( )

inlineinherited

Close file.

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

Definition at line 108 of file JFunctionAdaptor.hh.

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

get()

void JEEP::JFunctionAdaptorHelper< bool(*)(const JFit &, const JFit &) >::get ( const char *  function_name )

inlineprotectedinherited

Get function with given name according to specific protocol.

Parameters

function_name

function name

Definition at line 212 of file JFunctionAdaptor.hh.

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

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;
    }

Member Data Documentation

handle

void* JEEP::JFunctionAdaptorHelper< bool(*)(const JFit &, const JFit &) >::handle

protectedinherited

Definition at line 234 of file JFunctionAdaptor.hh.

function

bool(*)(const JFit &, const JFit &) JEEP::JFunctionAdaptorHelper< bool(*)(const JFit &, const JFit &) >::function

protectedinherited

Definition at line 235 of file JFunctionAdaptor.hh.

counter

int* JLANG::JSharedCounter::counter

protectedinherited

Definition at line 83 of file JSharedCounter.hh.

---

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

• JEvtToolkit.hh