btk::AcquisitionFileIO::Extension Class Reference

Native extension used with an acquisition file IO. More...

Public Member Functions
	Extension (const std::string &n)
	Extension (const std::string &n, const std::string &d)

Public Attributes
std::string	desc
std::string	name

Detailed Description

Native extension used with an acquisition file IO.

Note

This class should be only used with the macro BTK_FILE_IO_SUPPORTED_EXTENSIONS during the declaration of a class inheriting from btk::AcquisitionFileIO if several file formats are supported. For example:

* class FooFileIO : public AcquisitionFileIO
* {
*   BTK_FILE_IO_SUPPORTED_EXTENSIONS(Extension("FOO") | Extension("BAR"));
* public:
* // ...
* };
* 

You can also add a description to the file format. This description could be used to set the name of the company to distinguish two classes which use the same extension. For example,

* class EMGEliteFileIO : public AcquisitionFileIO
* {
*   BTK_FILE_IO_SUPPORTED_EXTENSIONS(Extension("EMG","BTS Bioengineering"));
* public:
* // ...
* };
* class EMGDelsysFileIO : public AcquisitionFileIO
* {
*   BTK_FILE_IO_SUPPORTED_EXTENSIONS(Extension("EMG", "Delsys Inc."));
* public:
* // ...
* };
* 

Constructor & Destructor Documentation

btk::AcquisitionFileIO::Extension::Extension ( const std::string &  n )

inline

Constructor.

btk::AcquisitionFileIO::Extension::Extension ( const std::string &  n, const std::string &  d  )

inline

Constructor where the name and the description can be set.

Member Data Documentation

btk::AcquisitionFileIO::Extension::desc

Description associated with the file format. This could be used to set the name of the company to distinguish two classes which use the same extension.

btk::AcquisitionFileIO::Extension::name

Name of the supported file format.