Abstract interface for all Dinver inversion plugins. More...

#include <DinverInterface.h>

Inheritance diagram for DinverCore::DinverInterface:

Public Member Functions
virtual void	addFileMenu (QMenu *m)
virtual void	addViewMenu (QMenu *m)
virtual void	clear ()
virtual AbstractForward *	createForward ()=0
virtual QWidget *	createParamWidget ()
virtual QWidget *	createTargetWidget ()
virtual QString	description () const
virtual bool	initForward (AbstractForward *)
virtual const char *	interfaceVersion () const =0
bool	isValid () const
virtual bool	setArguments (int &, char **)
virtual void	setCurrentForward (AbstractForward *, const QString &)
virtual QString	tag () const =0
virtual QString	title () const =0
virtual QString	version () const =0
virtual XMLMember	xml_member (XML_MEMBER_ARGS)
virtual bool	xml_polishChild (XML_POLISHCHILD_ARGS)
virtual void	xml_writeChildren (XML_WRITECHILDREN_ARGS) const
virtual bool	xmlSupport () const
virtual	~DinverInterface ()

Detailed Description

Abstract interface for all Dinver inversion plugins.

Constructor & Destructor Documentation

virtual DinverCore::DinverInterface::~DinverInterface ( ) [inline, virtual]

{}

Member Function Documentation

void DinverCore::DinverInterface::addFileMenu ( QMenu * m ) [virtual]

Place to add items to dinver file menu

References TRACE.

{
  TRACE;
}

void DinverCore::DinverInterface::addViewMenu ( QMenu * m ) [virtual]

Place to add items to dinver view menu

Reimplemented in DCPlugin.

References TRACE.

Referenced by DinverGui::addViewActions().

{
  TRACE;
}

void DinverCore::DinverInterface::clear ( ) [virtual]

Function called after "File/New"

Reimplemented in DCPlugin.

References TRACE.

Referenced by DinverGui::clear().

{
  TRACE;
}

virtual AbstractForward* DinverCore::DinverInterface::createForward ( ) [pure virtual]

Implemented in DCPlugin.

QWidget * DinverCore::DinverInterface::createParamWidget ( ) [virtual]

Create and return a widget that lets the user customize the parameter space definition

Reimplemented in DCPlugin.

References TRACE.

Referenced by DinverGui::setPlugin().

{
  TRACE;
  return 0;
}

QWidget * DinverCore::DinverInterface::createTargetWidget ( ) [virtual]

Create and return a widget that lets the user customize the target definition

Reimplemented in DCPlugin.

References TRACE.

Referenced by DinverGui::setPlugin().

{
  TRACE;
  return 0;
}

QString DinverCore::DinverInterface::description ( ) const [virtual]

Detailed description of the plugin

Reimplemented in DCPlugin.

References QGpCoreTools::tr(), and TRACE.

Referenced by PluginSelector::setLibList().

{
  TRACE;
  return tr("No description available");
}

virtual bool DinverCore::DinverInterface::initForward ( AbstractForward * ) [inline, virtual]

Reimplemented in DCPlugin.

{return true;}

const char * DinverCore::DinverInterface::interfaceVersion ( ) const [pure virtual]

Returns the dinvercore version of the plugin (at compile time)

Implemented in DCPlugin.

Referenced by isValid(), and DinverCore::DinverCoreObject::loadPlugin().

bool DinverCore::DinverInterface::isValid ( ) const

Check if the plugin version is compatible with the current core

References QGpCoreTools::Version::compatible(), and interfaceVersion().

Referenced by DinverCore::DinverCoreObject::pluginFile(), DinverCore::DinverCoreObject::printPluginList(), PluginSelector::setLibList(), DinverCore::BatchRun::setParameters(), and DinverCore::BatchRun::setTargets().

{
  static const Version vRef(DINVERCORE_VERSION);
  Version v(interfaceVersion());
  return v.compatible(vRef);
}

virtual bool DinverCore::DinverInterface::setArguments	(	int &	,
		char **
	)		`[inline, virtual]`

Referenced by modeNeighborhoodOptimization().

{return true;}

virtual void DinverCore::DinverInterface::setCurrentForward	(	AbstractForward *	,
		const QString &
	)		`[inline, virtual]`

Reimplemented in DCPlugin.

{}

QString DinverCore::DinverInterface::tag ( ) const [pure virtual]

Unique tag to identify in .report files models generated by this plugin.

Implemented in DCPlugin.

Referenced by DinverCore::DinverCoreObject::pluginFile(), DinverCore::DinverCoreObject::printPluginList(), xml_member(), DinverCore::XMLDinver::xml_setProperty(), and DinverCore::XMLDinver::xml_writeProperties().

QString DinverCore::DinverInterface::title ( ) const [pure virtual]

User friendly title, displayed at Dinver startup.

Implemented in DCPlugin.

Referenced by DinverCore::DinverCoreObject::printPluginList(), PluginSelector::setLibList(), and DinverCore::XMLDinver::xml_writeProperties().

QString DinverCore::DinverInterface::version ( ) const [pure virtual]

Current version of the plugin

Implemented in DCPlugin.

Referenced by DinverCore::DinverCoreObject::printPluginList(), and PluginSelector::setLibList().

XMLMember DinverCore::DinverInterface::xml_member ( XML_MEMBER_ARGS ) [virtual]

Re-implement this function to load parameters and targets (e.g. while restoring dinver environments)

Reimplemented in DCPlugin.

References tag(), and TRACE.

Referenced by DinverCore::XMLDinver::xml_member().

{
  TRACE;
  Q_UNUSED(tag)
  Q_UNUSED(attributes)
  Q_UNUSED(context);
  return XMLMember(XMLMember::Unknown);
}

bool DinverCore::DinverInterface::xml_polishChild ( XML_POLISHCHILD_ARGS ) [virtual]

Re-implement this function to initialize parameters and targets (e.g. after restoring dinver environments)

Reimplemented in DCPlugin.

References TRACE.

Referenced by DinverCore::XMLDinver::xml_polishChild().

{
  TRACE;
  Q_UNUSED(child)
  Q_UNUSED(context);
  return false;
}

void DinverCore::DinverInterface::xml_writeChildren ( XML_WRITECHILDREN_ARGS ) const [virtual]

Re-implement this function to save parameters and targets (e.g. while saving dinver environments)

Reimplemented in DCPlugin.

References TRACE.

Referenced by DinverCore::XMLDinver::xml_writeChildren().

{
  TRACE;
  Q_UNUSED(s)
  Q_UNUSED(context);
}

virtual bool DinverCore::DinverInterface::xmlSupport ( ) const [inline, virtual]

Reimplemented in DCPlugin.

Referenced by DinverCore::BatchRun::setParameters(), and DinverCore::BatchRun::setTargets().

{return false;}

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

DinverCore/DinverInterface.h
DinverCore/DinverInterface.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation