CAFPlugin Class Reference

#include <CAFPlugin.h>

Inheritance diagram for CAFPlugin:

List of all members.

Public Member Functions
CAccessor *	makeAccessor (const CXMLElement &) const
char *	getName ()
	CAFPlugin (string, string, string)
	CAFPlugin (CAFPlugin &)
	~CAFPlugin ()
bool	isSane () const
void	registerFactory (CAccessorFactoryContainer &outContainer)
Protected Attributes
void *	mDlOpenHandle
string	mName
CAccessor *(*	mMakeAccessor )(const CXMLElement &)
char *(*	mGetName )(void)
bool	mIsSane

---

Detailed Description

Definition at line 41 of file CAFPlugin.h.

---

Constructor & Destructor Documentation

CAFPlugin::CAFPlugin	(	string	inLibraryDirName,
		string	inLibraryFileName,
		string	inLibraryName
	)

opens the library and sets the make query etc. functions

makes the CAFPlugin. All it needs is:

Parameters:

inLibraryFileName

the file name of the shared object to be treated

Definition at line 17 of file CAFPlugin.cc.

References mDlOpenHandle, mGetName, mIsSane, mMakeAccessor, and mName.

                              :
  mGetName(0),
  mMakeAccessor(0),
  mName("no name given"),
  mIsSane(0){
  
  const char* lError;
  string lLibraryPath=inLibraryDirName+"/"+inLibraryFileName;
  string lStringGetClassName(inLibraryName+"_getClassName");
  string lStringMakeAccessor(inLibraryName+"_makeAccessor");

  mDlOpenHandle = dlopen (lLibraryPath.c_str(), RTLD_LAZY);
  if (!mDlOpenHandle) {
    cerr << "Could not open library: " << endl
   << dlerror() << endl;
    //throw VEConfigurationError(dlerror());
    mIsSane=0;
  }else{
  
    mGetName = (typeof(mGetName))dlsym(mDlOpenHandle, 
               lStringGetClassName.c_str());
    if ((lError = dlerror()) != NULL)  {
      cerr << "Could not link to symbol " << lStringGetClassName << ":" << lError << endl;
    }else{
      mName=(*mGetName)();
      mMakeAccessor=(typeof(mMakeAccessor))dlsym(mDlOpenHandle,
             lStringMakeAccessor.c_str());
      if ((lError = dlerror()) != NULL)  {
  cerr << "Could not link to symbol " << lStringMakeAccessor << ":" << lError << endl;
      }else{
  mIsSane=1;
      }
    }
  }
}

CAFPlugin::CAFPlugin

(

CAFPlugin &

inPlugin

)

copy all the content

Definition at line 55 of file CAFPlugin.cc.

                                       :
  mGetName(inPlugin.mGetName),
  mMakeAccessor(inPlugin.mMakeAccessor),
  mName(inPlugin.mName){
}

CAFPlugin::~CAFPlugin

(

)

close the DlOpenHandle of the library

Definition at line 61 of file CAFPlugin.cc.

References mDlOpenHandle.

                     {
  if(mDlOpenHandle){
    dlclose(mDlOpenHandle);
  }
}

---

Member Function Documentation

CAccessor * CAFPlugin::makeAccessor

(

const CXMLElement &

inXMLElement

)

const

Add some register function here

the rest can stay the same makes a CAccessor object

makes a CAccessor object

Definition at line 6 of file CAFPlugin.cc.

References mMakeAccessor.

                                                                      {
  return (*mMakeAccessor)(inXMLElement);
}

char * CAFPlugin::getName

(

)

gets the name of the plugin

gets the name of the plugin

Definition at line 10 of file CAFPlugin.cc.

References mGetName.

Referenced by CAccessorFactoryContainer::configure(), and registerFactory().

                        {
  return (*mGetName)();
};

bool CAFPlugin::isSane

(

)

const

is this well constructed

Definition at line 67 of file CAFPlugin.cc.

References mIsSane.

Referenced by CAccessorFactoryContainer::configure().

                           {
  return mIsSane;
}

void CAFPlugin::registerFactory

(

CAccessorFactoryContainer &

outContainer

)

[virtual]

register the factory

Reimplemented from CAccessorFactory.

Definition at line 71 of file CAFPlugin.cc.

References getName(), and CAccessorFactoryContainer::registerFactory().

                                                                      {
  outContainer.registerFactory(this,
             getName());
};

---

Member Data Documentation

void* CAFPlugin::mDlOpenHandle [protected]

the handle which enables us to open

Definition at line 44 of file CAFPlugin.h.

Referenced by CAFPlugin(), and ~CAFPlugin().

string CAFPlugin::mName [protected]

the name of the plugin

Reimplemented from CAccessorFactory.

Definition at line 46 of file CAFPlugin.h.

Referenced by CAFPlugin().

CAccessor*(* CAFPlugin::mMakeAccessor)(const CXMLElement &) [protected]

the function for making a CAccessor object

Referenced by CAFPlugin(), and makeAccessor().

char*(* CAFPlugin::mGetName)(void) [protected]

this function gives us the name of the plugin

Referenced by CAFPlugin(), and getName().

bool CAFPlugin::mIsSane [protected]

is this well constructed?

Definition at line 52 of file CAFPlugin.h.

Referenced by CAFPlugin(), and isSane().

---

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

• gift/libMRML/include/CAFPlugin.h
• gift/libMRML/cc/CAFPlugin.cc