RS_FilterInterface Class Reference

This is the interface that must be implemented for all format filter classes. More...

#include <rs_filterinterface.h>

Inheritance diagram for RS_FilterInterface:

List of all members.

Public Member Functions
	RS_FilterInterface ()
	Constructor.
virtual	~RS_FilterInterface ()
	Destructor.
virtual bool	canImport (RS2::FormatType t)
	Checks if this filter can import the given file type.
virtual bool	canExport (RS2::FormatType t)
	Checks if this filter can export the given file type.
virtual bool	fileImport (RS_Graphic &g, const RS_String &file, RS2::FormatType type)=0
	The implementation of this method in a inherited format class should read a file from disk and put the entities into the current entity container.
virtual bool	fileExport (RS_Graphic &g, const RS_String &file, RS2::FormatType type)=0
	The implementation of this method in a inherited format class should write the entities in the current entity container to a file on the disk.
Protected Member Functions
void	addImportFormat (RS2::FormatType type)
	Adds a file extension which can be imported by this filter.
void	addExportFormat (RS2::FormatType type)
	Adds a file extension which can be exported by this filter.
Protected Attributes
RS_ValueList< RS2::FormatType >	importFormats
	Vector of file extensions this filter can import.
RS_ValueList< RS2::FormatType >	exportFormats
	Vector of file extensions this filter can export.

---

Detailed Description

This is the interface that must be implemented for all format filter classes.

The RS_FileIO class uses the methods defined in here to interact with the format filter classes.

Author:

Andrew Mustun

---

Member Function Documentation

virtual bool RS_FilterInterface::canExport (  RS2::FormatType  t  )  [inline, virtual]

Checks if this filter can export the given file type. Returns: true if the filter can export the file type, false otherwise.

virtual bool RS_FilterInterface::canImport (  RS2::FormatType  t  )  [inline, virtual]

Checks if this filter can import the given file type. Return values: true  if the filter can import the file type false  otherwise.

---

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

• rs_filterinterface.h

---