Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::LegacyFileWriterService Class Reference

#include <mitkLegacyFileWriterService.h>

Inheritance diagram for mitk::LegacyFileWriterService:
Collaboration diagram for mitk::LegacyFileWriterService:

Public Member Functions

 LegacyFileWriterService (mitk::FileWriter::Pointer legacyWriter, const std::string &description)
 
 ~LegacyFileWriterService ()
 
virtual void Write () override
 Write the base data to the specified location or output stream. More...
 
virtual ConfidenceLevel GetConfidenceLevel () const override
 The confidence level of the reader or writer implementation. More...
 
- Public Member Functions inherited from mitk::AbstractFileWriter
virtual void SetInput (const BaseData *data) override
 Set the input data for writing. More...
 
virtual const BaseDataGetInput () const override
 Get the input data set via SetInput(). More...
 
virtual void SetOutputLocation (const std::string &location) override
 Set the output location. More...
 
virtual std::string GetOutputLocation () const override
 Get the current output location. More...
 
virtual void SetOutputStream (const std::string &location, std::ostream *os) override
 Set an output stream for writing. More...
 
virtual std::ostream * GetOutputStream () const override
 Get the output stream. More...
 
MimeType GetRegisteredMimeType () const
 
virtual Options GetOptions () const override
 returns a list of the supported options More...
 
virtual us::Any GetOption (const std::string &name) const override
 
virtual void SetOptions (const Options &options) override
 
virtual void SetOption (const std::string &name, const us::Any &value) override
 
virtual void AddProgressCallback (const ProgressCallback &callback) override
 
virtual void RemoveProgressCallback (const ProgressCallback &callback) override
 
us::ServiceRegistration< IFileWriterRegisterService (us::ModuleContext *context=us::GetModuleContext())
 
void UnregisterService ()
 
- Public Member Functions inherited from mitk::IFileWriter
virtual ~IFileWriter ()
 
- Public Member Functions inherited from mitk::IFileIO
virtual ~IFileIO ()
 

Additional Inherited Members

- Public Types inherited from mitk::IFileIO
enum  ConfidenceLevel { Unsupported, PartiallySupported, Supported }
 A confidence level describing the confidence of the reader or writer in handling the given data. More...
 
typedef std::map< std::string, us::AnyOptions
 Options for reading or writing data. More...
 
typedef mitk::MessageAbstractDelegate1< float > ProgressCallback
 
- Static Public Member Functions inherited from mitk::IFileWriter
static std::string PROP_BASEDATA_TYPE ()
 Service property name for the supported mitk::BaseData sub-class. More...
 
- Static Public Member Functions inherited from mitk::IFileIO
static std::string PROP_DESCRIPTION ()
 Service property name for a description. More...
 
static std::string PROP_MIMETYPE ()
 Service property name for the mime-type associated with this file writer. More...
 
- Protected Member Functions inherited from mitk::AbstractFileWriter
 ~AbstractFileWriter ()
 
 AbstractFileWriter (const AbstractFileWriter &other)
 
 AbstractFileWriter (const std::string &baseDataType)
 
 AbstractFileWriter (const std::string &baseDataType, const CustomMimeType &mimeType, const std::string &description)
 
virtual us::ServiceProperties GetServiceProperties () const
 
virtual us::ServiceRegistration< CustomMimeTypeRegisterMimeType (us::ModuleContext *context)
 
void SetMimeType (const CustomMimeType &mimeType)
 
const CustomMimeTypeGetMimeType () const
 
void SetMimeTypePrefix (const std::string &prefix)
 
std::string GetMimeTypePrefix () const
 
void SetDescription (const std::string &description)
 Sets a human readable description of this writer. More...
 
std::string GetDescription () const
 
void SetDefaultOptions (const Options &defaultOptions)
 
Options GetDefaultOptions () const
 
void SetRanking (int ranking)
 Set the service ranking for this file writer. More...
 
int GetRanking () const
 
void SetBaseDataType (const std::string &baseDataType)
 Sets the name of the mitk::Basedata that this writer is able to handle. More...
 
virtual std::string GetBaseDataType () const
 
void ValidateOutputLocation () const
 

Detailed Description

Definition at line 25 of file mitkLegacyFileWriterService.h.

Constructor & Destructor Documentation

mitk::LegacyFileWriterService::~LegacyFileWriterService ( )

Definition at line 56 of file mitkLegacyFileWriterService.cpp.

Member Function Documentation

mitk::IFileWriter::ConfidenceLevel mitk::LegacyFileWriterService::GetConfidenceLevel ( ) const
overridevirtual

The confidence level of the reader or writer implementation.

Returns
Confidence level.

The level is used to rank multiple competing implementations.

Reimplemented from mitk::AbstractFileWriter.

Definition at line 76 of file mitkLegacyFileWriterService.cpp.

References mitk::AbstractFileWriter::GetConfidenceLevel(), and mitk::DataNode::New().

void mitk::LegacyFileWriterService::Write ( )
overridevirtual

Write the base data to the specified location or output stream.

This method must be implemented for each specific writer. Call GetOutputStream() first and check for a non-null stream to write to. If the output stream is NULL, use GetOutputLocation() to write to a local file-system path.

If the reader cannot use streams directly, use GetLocalFile() to retrieve a temporary local file name instead.

Exceptions
mitk::Exception
See also
GetLocalFile()
IFileWriter::Write()

Implements mitk::AbstractFileWriter.

Definition at line 62 of file mitkLegacyFileWriterService.cpp.

References mitk::AbstractFileWriter::LocalFile::GetFileName(), and mitkThrow.


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