JEEP::JFunctionAdaptor< JReturn_t, JFirst_t, JSecond_t > Struct Template Reference

Function adaptor. More...

#include <JFunctionAdaptor.hh>

Inheritance diagram for JEEP::JFunctionAdaptor< JReturn_t, JFirst_t, JSecond_t >:

Public Types
typedef JReturn_t(*	pF )(JFirst_t, JSecond_t)
	Type definition of method. More...

Public Member Functions
	JFunctionAdaptor ()
	Default constructor. More...
	JFunctionAdaptor (const JFunctionAdaptor &adaptor)
	Copy constructor. More...
	JFunctionAdaptor (pF pf)
	Constructor. More...
	JFunctionAdaptor (const char *file_name, const char *function_name)
	Constructor. More...
JReturn_t	operator() (JFirst_t first, JSecond_t second) const
	Function operation. More...
bool	is_valid () const
	Check validity. More...
void	reset ()
	Reset function adaptor helper. More...
void	set (JReturn_t(*)(JFirst_t, JSecond_t)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...
const int	getCount ()
	Get count. More...

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

Protected Attributes
void *	handle
JReturn_t(*)(JFirst_t, JSecond_t)	function
int *	counter

Detailed Description

template<class JReturn_t = void, class JFirst_t = void, class JSecond_t = void>
struct JEEP::JFunctionAdaptor< JReturn_t, JFirst_t, JSecond_t >

Function adaptor.

Function adaptor for function with two arguments.

Definition at line 243 of file JFunctionAdaptor.hh.

Member Typedef Documentation

template<class JReturn_t = void, class JFirst_t = void, class JSecond_t = void>

typedef JReturn_t(* JEEP::JFunctionAdaptor< JReturn_t, JFirst_t, JSecond_t >::pF)(JFirst_t, JSecond_t)

Type definition of method.

Definition at line 322 of file JFunctionAdaptor.hh.

Constructor & Destructor Documentation

template<class JReturn_t = void, class JFirst_t = void, class JSecond_t = void>

JEEP::JFunctionAdaptor< JReturn_t, JFirst_t, JSecond_t >::JFunctionAdaptor ( )

inline

Default constructor.

Definition at line 328 of file JFunctionAdaptor.hh.

                       :
      JFunctionAdaptorHelper<pF>()
    {}

template<class JReturn_t = void, class JFirst_t = void, class JSecond_t = void>

JEEP::JFunctionAdaptor< JReturn_t, JFirst_t, JSecond_t >::JFunctionAdaptor ( const JFunctionAdaptor< JReturn_t, JFirst_t, JSecond_t > &  adaptor )

inline

Copy constructor.

Parameters

adaptor

adaptor

Definition at line 338 of file JFunctionAdaptor.hh.

                                                      :
      JFunctionAdaptorHelper<pF>(adaptor)
    {}

template<class JReturn_t = void, class JFirst_t = void, class JSecond_t = void>

JEEP::JFunctionAdaptor< JReturn_t, JFirst_t, JSecond_t >::JFunctionAdaptor ( pF  pf )

inline

Constructor.

Parameters

pf	pointer to function

Definition at line 348 of file JFunctionAdaptor.hh.

                            :
      JFunctionAdaptorHelper<pF>(pf)
    {}

template<class JReturn_t = void, class JFirst_t = void, class JSecond_t = void>

JEEP::JFunctionAdaptor< JReturn_t, JFirst_t, JSecond_t >::JFunctionAdaptor ( const char *  file_name, const char *  function_name  )

inline

Constructor.

Parameters

file_name	file name
function_name	function name

Definition at line 359 of file JFunctionAdaptor.hh.

                                                :
      JFunctionAdaptorHelper<pF>(file_name, function_name)
    {}

Member Function Documentation

template<class JReturn_t = void, class JFirst_t = void, class JSecond_t = void>

JReturn_t JEEP::JFunctionAdaptor< JReturn_t, JFirst_t, JSecond_t >::operator() ( JFirst_t  first, JSecond_t  second  ) const

inline

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

bool JEEP::JFunctionAdaptorHelper< JReturn_t(*)(JFirst_t, JSecond_t) >::is_valid ( ) const

inlineinherited

Check validity.

Returns

true if valid function; else false

Definition at line 52 of file JFunctionAdaptor.hh.

    {
      return (function != NULL);
    }

void JEEP::JFunctionAdaptorHelper< JReturn_t(*)(JFirst_t, JSecond_t) >::reset ( )

inlineinherited

Reset function adaptor helper.

Definition at line 61 of file JFunctionAdaptor.hh.

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

void JEEP::JFunctionAdaptorHelper< JReturn_t(*)(JFirst_t, JSecond_t) >::set ( JReturn_t(*)(JFirst_t, JSecond_t)  pf )

inlineinherited

Set function.

Parameters

pf	pointer to function

Definition at line 76 of file JFunctionAdaptor.hh.

    {
      reset();
      
      function = pf;
    }

void JEEP::JFunctionAdaptorHelper< JReturn_t(*)(JFirst_t, JSecond_t) >::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();
    }

void JEEP::JFunctionAdaptorHelper< JReturn_t(*)(JFirst_t, JSecond_t) >::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;
    }

void JEEP::JFunctionAdaptorHelper< JReturn_t(*)(JFirst_t, JSecond_t) >::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.");
      }
    }

void JLANG::JSharedCounter::initialise ( )

inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

    {
      detach();

      counter = new int(1);
    }

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

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

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

void* JEEP::JFunctionAdaptorHelper< JReturn_t(*)(JFirst_t, JSecond_t) >::handle

protectedinherited

Definition at line 234 of file JFunctionAdaptor.hh.

JReturn_t(*)(JFirst_t, JSecond_t) JEEP::JFunctionAdaptorHelper< JReturn_t(*)(JFirst_t, JSecond_t) >::function

protectedinherited

Definition at line 235 of file JFunctionAdaptor.hh.

int* JLANG::JSharedCounter::counter

protectedinherited

Definition at line 94 of file JSharedCounter.hh.

---

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

• JFunctionAdaptor.hh