Medical Imaging Interaction Toolkit  2018.4.99-a3d2e8fb
Medical Imaging Interaction Toolkit
mitk::ContourModelWriter Class Reference

#include <mitkContourModelWriter.h>

Inheritance diagram for mitk::ContourModelWriter:
Collaboration diagram for mitk::ContourModelWriter:

Public Member Functions

 ContourModelWriter ()
 
 ~ContourModelWriter () override
 
void Write () override
 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 BaseDataGetInput () 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< IFileWriterRegisterService (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 ()
 

Static Public Attributes

static const char * XML_CONTOURMODEL
 
static const char * XML_HEAD
 
static const char * XML_GEOMETRY_INFO
 
static const char * XML_DATA
 
static const char * XML_TIME_STEP
 
static const char * XML_CONTROL_POINTS
 
static const char * XML_POINT
 
static const char * XML_X
 
static const char * XML_Y
 
static const char * XML_Z
 

Protected Member Functions

 ContourModelWriter (const ContourModelWriter &other)
 
mitk::ContourModelWriterClone () const override
 
template<typename T >
std::string ConvertToString (T value)
 
void WriteXML (const mitk::ContourModel *contourModel, std::ostream &out)
 
void WriteGeometryInformation (const mitk::TimeGeometry *geometry, std::ostream &out)
 
void WriteGeometryInformation (const mitk::TimeSlicedGeometry *geometry, std::ostream &out)
 
void WriteXMLHeader (std::ostream &file)
 
void WriteStartElement (const char *const tag, std::ostream &file)
 
void WriteStartElementWithAttribut (const char *const tag, std::vector< std::string > attributes, std::vector< std::string > values, std::ostream &file)
 
void WriteEndElement (const char *const tag, std::ostream &file, const bool &indent=true)
 
void WriteCharacterData (const char *const data, std::ostream &file)
 
void WriteStartElement (std::string &tag, std::ostream &file)
 
void WriteEndElement (std::string &tag, std::ostream &file, const bool &indent=true)
 
void WriteCharacterData (std::string &data, std::ostream &file)
 
void WriteIndent (std::ostream &file)
 
- 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< 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
 

Protected Attributes

unsigned int m_IndentDepth
 
unsigned int m_Indent
 

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...
 

Detailed Description

Definition at line 56 of file mitkContourModelWriter.h.

Constructor & Destructor Documentation

◆ ContourModelWriter() [1/2]

◆ ~ContourModelWriter()

mitk::ContourModelWriter::~ContourModelWriter ( )
override

Definition at line 86 of file mitkContourModelWriter.cpp.

◆ ContourModelWriter() [2/2]

mitk::ContourModelWriter::ContourModelWriter ( const ContourModelWriter other)
protected

Definition at line 81 of file mitkContourModelWriter.cpp.

Member Function Documentation

◆ Clone()

mitk::ContourModelWriter * mitk::ContourModelWriter::Clone ( ) const
overrideprotectedvirtual

Implements mitk::AbstractFileWriter.

Definition at line 135 of file mitkContourModelWriter.cpp.

References ContourModelWriter().

◆ ConvertToString()

template<typename T >
std::string mitk::ContourModelWriter::ConvertToString ( value)
protected

Converts an arbitrary type to a string. The type has to support the << operator. This works fine at least for integral data types as float, int, long etc.

Parameters
valuethe value to convert
Returns
the string representation of value

Definition at line 238 of file mitkContourModelWriter.cpp.

Referenced by WriteXML().

◆ Write()

void mitk::ContourModelWriter::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 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.

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

Implements mitk::AbstractFileWriter.

Definition at line 90 of file mitkContourModelWriter.cpp.

References mitk::AbstractFileWriter::GetInput(), mitk::AbstractFileWriter::GetOutputLocation(), mitk::AbstractFileWriter::GetOutputStream(), mitkThrow, WriteXML(), and WriteXMLHeader().

Referenced by mitk::ContourModelSerializer::Serialize(), and mitk::ContourModelSetWriter::Write().

◆ WriteCharacterData() [1/2]

void mitk::ContourModelWriter::WriteCharacterData ( const char *const  data,
std::ostream &  file 
)
protected

Write character data inside a tag.

Definition at line 311 of file mitkContourModelWriter.cpp.

Referenced by WriteGeometryInformation(), and WriteXML().

◆ WriteCharacterData() [2/2]

void mitk::ContourModelWriter::WriteCharacterData ( std::string &  data,
std::ostream &  file 
)
protected

Write character data inside a tag.

Definition at line 326 of file mitkContourModelWriter.cpp.

◆ WriteEndElement() [1/2]

void mitk::ContourModelWriter::WriteEndElement ( const char *const  tag,
std::ostream &  file,
const bool &  indent = true 
)
protected

Write an end element tag End-Elements following character data should pass indent = false.

Definition at line 300 of file mitkContourModelWriter.cpp.

Referenced by WriteXML().

◆ WriteEndElement() [2/2]

void mitk::ContourModelWriter::WriteEndElement ( std::string &  tag,
std::ostream &  file,
const bool &  indent = true 
)
protected

Write an end element tag

Definition at line 321 of file mitkContourModelWriter.cpp.

◆ WriteGeometryInformation() [1/2]

void mitk::ContourModelWriter::WriteGeometryInformation ( const mitk::TimeGeometry geometry,
std::ostream &  out 
)
protected

Writes the geometry information of the TimeGeometry to an outstream. The root tag is not included.

Parameters
geometrythe TimeGeometry of the contour.
thestream to write to.

Definition at line 232 of file mitkContourModelWriter.cpp.

References WriteCharacterData().

Referenced by WriteXML().

◆ WriteGeometryInformation() [2/2]

void mitk::ContourModelWriter::WriteGeometryInformation ( const mitk::TimeSlicedGeometry geometry,
std::ostream &  out 
)
protected

Writes the geometry information of the TimeGeometry to an outstream. The root tag is not included.

Parameters
geometrythe TimeGeometry of the contour.
thestream to write to.
Deprecated:
(as of 2013_09) Please use TimeGeometry instead of TimeSlicedGeometry. For more information see http://www.mitk.org/Development/Refactoring%20of%20the%20Geometry%20Classes%20-%20Part%201

◆ WriteIndent()

void mitk::ContourModelWriter::WriteIndent ( std::ostream &  file)
protected

Writes empty spaces to the stream according to m_IndentDepth and m_Indent

Definition at line 331 of file mitkContourModelWriter.cpp.

Referenced by WriteStartElement().

◆ WriteStartElement() [1/2]

void mitk::ContourModelWriter::WriteStartElement ( const char *const  tag,
std::ostream &  file 
)
protected

Write a start element tag

Definition at line 257 of file mitkContourModelWriter.cpp.

References WriteIndent().

Referenced by WriteXML().

◆ WriteStartElement() [2/2]

void mitk::ContourModelWriter::WriteStartElement ( std::string &  tag,
std::ostream &  file 
)
protected

Write a start element tag

Definition at line 316 of file mitkContourModelWriter.cpp.

◆ WriteStartElementWithAttribut()

void mitk::ContourModelWriter::WriteStartElementWithAttribut ( const char *const  tag,
std::vector< std::string >  attributes,
std::vector< std::string >  values,
std::ostream &  file 
)
protected

Definition at line 265 of file mitkContourModelWriter.cpp.

Referenced by WriteXML().

◆ WriteXML()

void mitk::ContourModelWriter::WriteXML ( const mitk::ContourModel contourModel,
std::ostream &  out 
)
protected

◆ WriteXMLHeader()

void mitk::ContourModelWriter::WriteXMLHeader ( std::ostream &  file)
protected

Writes an standard xml header to the given stream.

Parameters
filethe stream in which the header is written.

Definition at line 252 of file mitkContourModelWriter.cpp.

Referenced by Write().

Member Data Documentation

◆ m_Indent

unsigned int mitk::ContourModelWriter::m_Indent
protected

Definition at line 144 of file mitkContourModelWriter.h.

◆ m_IndentDepth

unsigned int mitk::ContourModelWriter::m_IndentDepth
protected

Definition at line 142 of file mitkContourModelWriter.h.

◆ XML_CONTOURMODEL

const char * mitk::ContourModelWriter::XML_CONTOURMODEL
static

Definition at line 147 of file mitkContourModelWriter.h.

Referenced by WriteXML().

◆ XML_CONTROL_POINTS

const char * mitk::ContourModelWriter::XML_CONTROL_POINTS
static

Definition at line 157 of file mitkContourModelWriter.h.

Referenced by WriteXML().

◆ XML_DATA

const char * mitk::ContourModelWriter::XML_DATA
static

Definition at line 153 of file mitkContourModelWriter.h.

Referenced by WriteXML().

◆ XML_GEOMETRY_INFO

const char * mitk::ContourModelWriter::XML_GEOMETRY_INFO
static

Definition at line 151 of file mitkContourModelWriter.h.

Referenced by WriteXML().

◆ XML_HEAD

const char * mitk::ContourModelWriter::XML_HEAD
static

Definition at line 149 of file mitkContourModelWriter.h.

Referenced by WriteXML().

◆ XML_POINT

const char * mitk::ContourModelWriter::XML_POINT
static

Definition at line 159 of file mitkContourModelWriter.h.

Referenced by WriteXML().

◆ XML_TIME_STEP

const char * mitk::ContourModelWriter::XML_TIME_STEP
static

Definition at line 155 of file mitkContourModelWriter.h.

Referenced by WriteXML().

◆ XML_X

const char * mitk::ContourModelWriter::XML_X
static

Definition at line 161 of file mitkContourModelWriter.h.

Referenced by WriteXML().

◆ XML_Y

const char * mitk::ContourModelWriter::XML_Y
static

Definition at line 163 of file mitkContourModelWriter.h.

Referenced by WriteXML().

◆ XML_Z

const char * mitk::ContourModelWriter::XML_Z
static

Definition at line 165 of file mitkContourModelWriter.h.

Referenced by WriteXML().


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