Overview     Modules     Class Hierarchy     Classes     Members  

Interface for exportModule plug-ins. More...

#include <ExportModule.h>

Inheritance diagram for tlp::ExportModule:
Collaboration diagram for tlp::ExportModule:

Public Member Functions

 ExportModule (AlgorithmContext context)
virtual ~ExportModule ()
virtual bool exportGraph (std::ostream &os)
 The export operations should take place here.
virtual _DEPRECATED bool exportGraph (std::ostream &, Graph *)
 deprecated method.
- Public Member Functions inherited from tlp::WithParameter
const
tlp::ParameterDescriptionList
getParameters ()
 Retrieves the parameters.
template<typename T >
void addInParameter (const char *str, const char *inHelp=0, const char *inDefValue=0, bool isMandatory=true)
 Adds an IN parameter to the plug-in.
template<typename T >
void addOutParameter (const char *str, const char *inHelp=0, const char *inDefValue=0, bool isMandatory=true)
 Adds an OUT parameter to the plug-in.
template<typename T >
void addInOutParameter (const char *str, const char *inHelp=0, const char *inDefValue=0, bool isMandatory=true)
 Adds an INOUT parameter to the plug-in.
template<typename T >
void addParameter (const char *parameterName, const char *help=NULL, const char *defaultValue=NULL, bool isMandatory=true)
 Adds an IN parameter to the plug-in (deprecated)
- Public Member Functions inherited from tlp::WithDependency
std::list< DependencygetDependencies ()
 Gets the list of Dependencies of this plug-in.
template<typename Ty >
void addDependency (const char *name, const char *release)
 Adds a dependency upon another plug-in. The parameters should be null-terminated strings, or NULL.

Public Attributes

Graphgraph
PluginProgresspluginProgress
DataSetdataSet

Additional Inherited Members

- Protected Member Functions inherited from tlp::WithDependency
void addDependency (const char *factory, const char *name, const char *release)
 Adds a dependency upon another plug-in.
- Protected Attributes inherited from tlp::WithParameter
ParameterDescriptionList parameters
 The internal structure storing the parameters.
- Protected Attributes inherited from tlp::WithDependency
std::list< Dependencydependencies
 The inner list of dependencies.

Detailed Description

Interface for exportModule plug-ins.

Constructor & Destructor Documentation

tlp::ExportModule::ExportModule ( AlgorithmContext  context)
inline
virtual tlp::ExportModule::~ExportModule ( )
inlinevirtual

Member Function Documentation

virtual bool tlp::ExportModule::exportGraph ( std::ostream &  os)
virtual

The export operations should take place here.

Parameters
theoutput stream
Returns
bool Whether the export was successful or not.
virtual _DEPRECATED bool tlp::ExportModule::exportGraph ( std::ostream &  ,
Graph  
)
inlinevirtual

deprecated method.

Parameters
unused,deprecatedparameter
Returns
bool Whether the import was successful or not.

Member Data Documentation

DataSet* tlp::ExportModule::dataSet
Graph* tlp::ExportModule::graph

It is the root graph

PluginProgress* tlp::ExportModule::pluginProgress


Tulip Software by LaBRI Visualization Team    2001 - 2012