tlp::ImportModule Class Reference
[Plugins]

Base class for import plug-ins. More...

#include <ImportModule.h>

Inheritance diagram for tlp::ImportModule:

[legend]

Collaboration diagram for tlp::ImportModule:

[legend]

List of all members.

Public Member Functions

• ImportModule (AlgorithmContext context)

  Initializes the DataSet to the one passed in the context.
  

• virtual ~ImportModule ()
• virtual bool import (const std::string &)=0

  The import operations should take place here.
  

Public Attributes

• Graph * graph

  The Graph in which to write the data to import.
  

• PluginProgress * pluginProgress

  A means to report progress to the user.
  

• DataSet * dataSet

  A container for the parameters of this import plug-in.
  

---

Detailed Description

Base class for import plug-ins.

---

Constructor & Destructor Documentation

tlp::ImportModule::ImportModule

(

AlgorithmContext

context

)

[inline]

Initializes the DataSet to the one passed in the context.

Parameters:

context

THe context this import plug-in runs into.

virtual tlp::ImportModule::~ImportModule

(

)

[inline, virtual]

---

Member Function Documentation

virtual bool tlp::ImportModule::import

(

const std::string &

)

[pure virtual]

The import operations should take place here.

Parameters:

unused,deprecated

parameter

Returns:

bool Whether the import was sucessful or not.

---

Member Data Documentation

DataSet* tlp::ImportModule::dataSet

A container for the parameters of this import plug-in.

Graph* tlp::ImportModule::graph

The Graph in which to write the data to import.

PluginProgress* tlp::ImportModule::pluginProgress

A means to report progress to the user.