Computer Assited Medical Intervention Tool Kit  version 4.1
MMLComponentExtension.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2018 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 
26 #ifndef MMLCOMPONENTEXTENSION_H
27 #define MMLCOMPONENTEXTENSION_H
28 
29 #include <QObject>
30 #include <ComponentExtension.h>
31 #include "MMLComponentAPI.h"
43  Q_OBJECT
44  Q_INTERFACES(camitk::ComponentExtension)
45  Q_PLUGIN_METADATA(IID "fr.imag.camitk.modeling.component.mmlcomponent")
46 
47 public:
50 
52  virtual QString getName() const;
53 
55  virtual QString getDescription() const;
56 
58  virtual QStringList getFileExtensions() const;
59 
63  virtual camitk::Component* open(const QString&);
64 
66  virtual bool save(camitk::Component* component) const;
67 
68 protected:
70  virtual ~MMLComponentExtension() = default;
71 };
72 
73 #endif
camitk::ComponentExtension::open
virtual Component * open(const QString &)=0
get a new instance from data stored in a file (this is the most important method to redefine in your ...
MMLComponentExtension::open
virtual camitk::Component * open(const QString &)
get a new instance from data stored in a file (this is the most important method to redefine in your ...
Definition: MMLComponentExtension.cpp:50
MMLComponentAPI.h
camitk::ComponentExtension
This class describes what is a generic Component extension. To add a ComponentExtension to CamiTK cor...
Definition: ComponentExtension.h:80
camitk::Component::setModified
virtual void setModified(bool modified=true)
set the modified flag
Definition: sdk/libraries/core/component/Component.h:882
camitk::ComponentExtension::ComponentExtension
ComponentExtension()
protected constructor,
Definition: ComponentExtension.cpp:57
MMLComponentExtension::save
virtual bool save(camitk::Component *component) const
save (only work with mml component)
Definition: MMLComponentExtension.cpp:55
MMLComponentExtension::getDescription
virtual QString getDescription() const
get the plugin description (can be html)
Definition: MMLComponentExtension.cpp:37
MMLComponentExtension.h
MMLComponentExtension::getName
virtual QString getName() const
get the plugin name
Definition: MMLComponentExtension.cpp:32
MMLComponentExtension::getFileExtensions
virtual QStringList getFileExtensions() const
get the list of managed extensions (each file with an extension in the list can be loaded by this Ext...
Definition: MMLComponentExtension.cpp:42
camitk::ComponentExtension::getDescription
virtual QString getDescription() const =0
get the plugin description
camitk::ComponentExtension::getFileExtensions
virtual QStringList getFileExtensions() const =0
get the list of managed extensions (each file with an extension in the list can be loaded by this Com...
MMLComponent::saveMML
void saveMML()
save the mml in the current filename (and the pml if needed)
Definition: MMLComponent.cpp:192
MMLComponent
This class manage an MML monitoring document ".mml".
Definition: MMLComponent.h:48
camitk::ComponentExtension::save
virtual bool save(Component *component) const
save a given Component (does not have to be top-level) into one of the currently managed format (chec...
Definition: ComponentExtension.cpp:62
ComponentExtension.h
MMLCOMPONENT_API
#define MMLCOMPONENT_API
Definition: MMLComponentAPI.h:54
MMLComponentExtension
This MML ComponentPlugin allows you to manipulate MML document. see http://www-timc....
Definition: MMLComponentExtension.h:42
MMLComponent.h
camitk::ComponentExtension::getName
virtual QString getName() const =0
camitk::Component
A Component represents something that could be included in the explorer view, the interactive 3D view...
Definition: sdk/libraries/core/component/Component.h:298
camitk
Definition: Action.cpp:36