Computer Assited Medical Intervention Tool Kit  version 4.1
Public Member Functions | Protected Member Functions | List of all members
camitk::ImageComponentExtension Class Referenceabstract

Abstract class created to support export file formats for ImageComponent Any data component plugin creating an ImageComponent should inherit from this class. More...

#include <ImageComponentExtension.h>

Inherits camitk::ComponentExtension.

Inherited by ItkImageComponentExtension, and VtkImageComponentExtension.

Public Member Functions

QString getDescription () const override
 get the plugin description (can be html) More...
 
QString getName () const override
 get the plugin name More...
 
Componentopen (const QString &)=0
 get a new instance from data stored in a file This method may throw an AbortException if a problem occurs. More...
 
- Public Member Functions inherited from camitk::ComponentExtension
 ~ComponentExtension () override=default
 protected destructor, More...
 
virtual QStringList getFileExtensions () const =0
 get the list of managed extensions (each file with an extension in the list can be loaded by this Component) More...
 
virtual bool save (Component *component) const
 save a given Component (does not have to be top-level) into one of the currently managed format (check the component QFileInfo(component->getFileName()).completeSuffix(). More...
 
virtual bool hasDataDirectory () const
 return true if this component manages directory instead of individual files (e.g. Dicom series are stored in directories, not files) More...
 
QString getLocation () const
 get the file path (location of the .dll/.so/.dylib) of this plugin More...
 
void setLocation (const QString loc)
 set the file path (once loaded as a dynamic library) More...
 
void initResources ()
 Load, for the selected langage (asked to the Application), the associated .qm file. More...
 

Protected Member Functions

 ImageComponentExtension ()
 Constructor protected because the class is virtual. More...
 
 ~ImageComponentExtension ()=default
 the destructor More...
 
- Protected Member Functions inherited from camitk::ComponentExtension
 ComponentExtension ()
 protected constructor, More...
 

Detailed Description

Abstract class created to support export file formats for ImageComponent Any data component plugin creating an ImageComponent should inherit from this class.

Constructor & Destructor Documentation

◆ ImageComponentExtension()

camitk::ImageComponentExtension::ImageComponentExtension ( )
protected

Constructor protected because the class is virtual.

◆ ~ImageComponentExtension()

camitk::ImageComponentExtension::~ImageComponentExtension ( )
protecteddefault

the destructor

Member Function Documentation

◆ getDescription()

QString camitk::ImageComponentExtension::getDescription ( ) const
overridevirtual

get the plugin description (can be html)

Implements camitk::ComponentExtension.

Reimplemented in ItkImageComponentExtension, and VtkImageComponentExtension.

◆ getName()

QString camitk::ImageComponentExtension::getName ( ) const
overridevirtual

get the plugin name

Implements camitk::ComponentExtension.

Reimplemented in ItkImageComponentExtension, and VtkImageComponentExtension.

Referenced by SaveAsAction::apply().

◆ open()

Component* camitk::ImageComponentExtension::open ( const QString &  )
pure virtual

get a new instance from data stored in a file This method may throw an AbortException if a problem occurs.

Implements camitk::ComponentExtension.

Implemented in ItkImageComponentExtension, and VtkImageComponentExtension.


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