Medical Imaging Interaction Toolkit
2024.12.99-0da743f6
Medical Imaging Interaction Toolkit
|
#include <mitkExampleDataStructureWriterService.h>
Public Types | |
typedef mitk::ExampleDataStructure | InputType |
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::Any > | Options |
Options for reading or writing data. More... | |
typedef mitk::MessageAbstractDelegate1< float > | ProgressCallback |
Public Member Functions | |
ExampleDataStructureWriterService () | |
~ExampleDataStructureWriterService () override | |
void | Write () override |
Write the base data to the specified location or output stream. More... | |
void | Write () override=0 |
Write the base data to the specified location or output stream. More... | |
Public Member Functions inherited from mitk::AbstractFileWriter | |
void | SetInput (const BaseData *data) override |
Set the input data for writing. More... | |
const BaseData * | GetInput () const override |
Get the input data set via SetInput(). More... | |
void | SetOutputLocation (const std::string &location) override |
Set the output location. More... | |
std::string | GetOutputLocation () const override |
Get the current output location. More... | |
void | SetOutputStream (const std::string &location, std::ostream *os) override |
Set an output stream for writing. More... | |
std::ostream * | GetOutputStream () const override |
Get the output stream. More... | |
ConfidenceLevel | GetConfidenceLevel () const override |
The confidence level of the reader or writer implementation. More... | |
MimeType | GetRegisteredMimeType () const |
Options | GetOptions () const override |
returns a list of the supported options More... | |
us::Any | GetOption (const std::string &name) const override |
void | SetOptions (const Options &options) override |
void | SetOption (const std::string &name, const us::Any &value) override |
void | AddProgressCallback (const ProgressCallback &callback) override |
void | RemoveProgressCallback (const ProgressCallback &callback) override |
us::ServiceRegistration< IFileWriter > | RegisterService (us::ModuleContext *context=us::GetModuleContext()) |
void | UnregisterService () |
Public Member Functions inherited from mitk::IFileWriter | |
~IFileWriter () override | |
Public Member Functions inherited from mitk::IFileIO | |
virtual | ~IFileIO () |
Protected Member Functions | |
ExampleDataStructureWriterService (const ExampleDataStructureWriterService &other) | |
mitk::ExampleDataStructureWriterService * | Clone () const override |
Protected Member Functions inherited from mitk::AbstractFileWriter | |
~AbstractFileWriter () override | |
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< CustomMimeType > | RegisterMimeType (us::ModuleContext *context) |
void | SetMimeType (const CustomMimeType &mimeType) |
const CustomMimeType * | GetMimeType () 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 |
Additional Inherited Members | |
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... | |
Writes example data structures to a file
Definition at line 25 of file mitkExampleDataStructureWriterService.h.
Definition at line 28 of file mitkExampleDataStructureWriterService.h.
mitk::ExampleDataStructureWriterService::ExampleDataStructureWriterService | ( | ) |
|
override |
|
protected |
|
overrideprotectedvirtual |
Implements mitk::AbstractFileWriter.
|
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 nullptr
, 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.
mitk::Exception |
Implements mitk::AbstractFileWriter.
|
override |
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 nullptr
, 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.
mitk::Exception |