Writer service for saving surfaces in PLY format. More...

#include <mitkPlyFileWriterService.h>

Inheritance diagram for mitk::PlyFileWriterService:

[legend]

Collaboration diagram for mitk::PlyFileWriterService:

[legend]

Public Member Functions
	PlyFileWriterService ()

	~PlyFileWriterService () 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. More...

void	SetOutputLocation (const std::string &location) override
	Set the output file-system path, clearing any output stream. 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 and associated location label. More...

std::ostream *	GetOutputStream () const override
	Get the current output stream. More...

ConfidenceLevel	GetConfidenceLevel () const override
	Determine confidence for writing the current input data. More...

MimeType	GetRegisteredMimeType () const
	Get the MIME type that was registered for this writer. More...

Options	GetOptions () const override
	Get the current option values. More...

us::Any	GetOption (const std::string &name) const override
	Get the value of a specific option. More...

void	SetOptions (const Options &options) override
	Set multiple options at once. More...

void	SetOption (const std::string &name, const us::Any &value) override
	Set a single option value. More...

void	AddProgressCallback (const ProgressCallback &callback) override
	Register a progress callback. More...

void	RemoveProgressCallback (const ProgressCallback &callback) override
	Remove a previously registered progress callback. More...

us::ServiceRegistration< IFileWriter >	RegisterService (us::ModuleContext *context=us::GetModuleContext())
	Register this writer as a CppMicroServices service. More...

void	UnregisterService ()
	Unregister this writer from the CppMicroServices registry. More...

Public Member Functions inherited from mitk::IFileWriter
	~IFileWriter () override

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 reader's or writer's ability to handle the given data or file format. More...

typedef std::map< std::string, us::Any >	Options
	Options for reading or writing data. More...

typedef mitk::MessageAbstractDelegate1< float >	ProgressCallback
	Callback delegate type for progress reporting. More...

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 human-readable description. More...

static std::string	PROP_MIMETYPE ()
	Service property name for the mime-type associated with this reader or writer. More...

Protected Member Functions inherited from mitk::AbstractFileWriter
	~AbstractFileWriter () override

	AbstractFileWriter (const AbstractFileWriter &other)
	Copy constructor. More...

	AbstractFileWriter (const std::string &baseDataType)
	Construct a writer for the given BaseData type name. More...

	AbstractFileWriter (const std::string &baseDataType, const CustomMimeType &mimeType, const std::string &description)
	Construct a writer for the given BaseData type, MIME type, and description. More...

virtual us::ServiceProperties	GetServiceProperties () const
	Get the service properties for registration. More...

virtual us::ServiceRegistration< CustomMimeType >	RegisterMimeType (us::ModuleContext *context)
	Register a new CustomMimeType service object. More...

void	SetMimeType (const CustomMimeType &mimeType)
	Set the MIME type this writer can handle. More...

const CustomMimeType *	GetMimeType () const
	Get the MIME type this writer can handle. More...

void	SetMimeTypePrefix (const std::string &prefix)
	Set the prefix used for auto-generated MIME type names. More...

std::string	GetMimeTypePrefix () const
	Get the current MIME type name prefix. More...

void	SetDescription (const std::string &description)
	Set a human-readable description of this writer. More...

std::string	GetDescription () const
	Get the human-readable description of this writer. More...

void	SetDefaultOptions (const Options &defaultOptions)
	Set the default options for this writer. More...

Options	GetDefaultOptions () const
	Get the default options for this writer. More...

void	SetRanking (int ranking)
	Set the service ranking for this file writer. More...

int	GetRanking () const
	Get the service ranking for this file writer. More...

void	SetBaseDataType (const std::string &baseDataType)
	Set the name of the mitk::BaseData sub-class this writer supports. More...

virtual std::string	GetBaseDataType () const
	Get the name of the mitk::BaseData sub-class this writer supports. More...

void	ValidateOutputLocation () const
	Validate the output location or stream. More...

Detailed Description

Writer service for saving surfaces in PLY format.

Currently, this writer uses the binary format as default. Should the ASCII format be required, it is suggested to incorporate Options.

Definition at line 26 of file mitkPlyFileWriterService.h.

Constructor & Destructor Documentation

◆ PlyFileWriterService()

mitk::PlyFileWriterService::PlyFileWriterService ( )

◆ ~PlyFileWriterService()

mitk::PlyFileWriterService::~PlyFileWriterService ( )

override

Member Function Documentation

◆ Write() [1/2]

void mitk::PlyFileWriterService::Write ( )

overridevirtual

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

Subclasses must implement this method. 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 writer cannot use streams directly, use LocalFile to retrieve a temporary local file name instead.

Exceptions

mitk::Exception if writing fails.

See also: LocalFile; IFileWriter::Write()

Implements mitk::AbstractFileWriter.

◆ Write() [2/2]

void mitk::AbstractFileWriter::Write