Ocean
Ocean::IO::FileManager Class Referenceabstract

This class is the base class for all plugin manager able to load and manager files. More...

Inheritance diagram for Ocean::IO::FileManager:

Public Types

typedef std::map< std::string, std::string > FileExtensions
 Definition of a map mapping supported file extensions to file type descriptions. More...
 

Public Member Functions

virtual FileExtensions supportedExtensions ()=0
 Returns all currently supported file extensions. More...
 
virtual bool isSupported (const std::string &extension)
 Returns whether a specified file extension is supported. More...
 

Protected Member Functions

 FileManager ()
 Creates a new file manager object. More...
 
virtual ~FileManager ()
 Destructs a file manager object. More...
 

Detailed Description

This class is the base class for all plugin manager able to load and manager files.

Member Typedef Documentation

◆ FileExtensions

typedef std::map<std::string, std::string> Ocean::IO::FileManager::FileExtensions

Definition of a map mapping supported file extensions to file type descriptions.

Constructor & Destructor Documentation

◆ FileManager()

Ocean::IO::FileManager::FileManager ( )
protected

Creates a new file manager object.

◆ ~FileManager()

virtual Ocean::IO::FileManager::~FileManager ( )
protectedvirtual

Destructs a file manager object.

Member Function Documentation

◆ isSupported()

virtual bool Ocean::IO::FileManager::isSupported ( const std::string &  extension)
virtual

Returns whether a specified file extension is supported.

Parameters
extensionExtension to check
Returns
True, if so

◆ supportedExtensions()

virtual FileExtensions Ocean::IO::FileManager::supportedExtensions ( )
pure virtual

Returns all currently supported file extensions.

Returns
All supported file extensions

Implemented in Ocean::SceneDescription::Manager, and Ocean::Interaction::Manager.


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