Medical Imaging Interaction Toolkit  2024.06.99-5f7b36e7
Medical Imaging Interaction Toolkit
mitk::PointSetReaderService Class Reference

#include <mitkPointSetReaderService.h>

Inheritance diagram for mitk::PointSetReaderService:
Collaboration diagram for mitk::PointSetReaderService:

Public Member Functions

 PointSetReaderService ()
 ~PointSetReaderService () override
std::vector< itk::SmartPointer< BaseData > > Read () override
 Reads a path or stream and creates a list of BaseData objects. More...
DataStorage::SetOfObjects::Pointer Read (mitk::DataStorage &ds) override
- Public Member Functions inherited from mitk::AbstractFileReader
void SetInput (const std::string &location) override
 Set the input location. More...
void SetInput (const std::string &location, std::istream *is) override
 Set an input stream to read from. More...
std::string GetInputLocation () const override
 Get the current input location. More...
std::istream * GetInputStream () const override
 Get the input stream. More...
MimeType GetRegisteredMimeType () const
std::vector< itk::SmartPointer< BaseData > > Read () override
 Reads a path or stream and creates a list of BaseData objects. More...
DataStorage::SetOfObjects::Pointer Read (mitk::DataStorage &ds) override
 Reads the specified file or input stream, loading its contents into the provided DataStorage. More...
ConfidenceLevel GetConfidenceLevel () const override
 The confidence level of the reader or writer implementation. More...
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< IFileReaderRegisterService (us::ModuleContext *context=us::GetModuleContext())
void UnregisterService ()
std::vector< std::string > GetReadFiles () override
void SetProperties (const PropertyList *properties) override
 Optionally provide base data properties as a source of meta data. More...
- Public Member Functions inherited from mitk::IFileReader
 ~IFileReader () override
virtual ~IFileReader ()
- Public Member Functions inherited from mitk::IFileIO
virtual ~IFileIO ()

Protected Member Functions

std::vector< itk::SmartPointer< BaseData > > DoRead () override
- Protected Member Functions inherited from mitk::AbstractFileReader
 AbstractFileReader ()
 ~AbstractFileReader () override
 AbstractFileReader (const AbstractFileReader &other)
 AbstractFileReader (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)
std::string GetDescription () const
void SetDefaultOptions (const Options &defaultOptions)
Options GetDefaultOptions () const
void SetRanking (int ranking)
 Set the service ranking for this file reader. More...
int GetRanking () const
std::string GetLocalFileName () const
 Get a local file name for reading. More...
virtual void SetDefaultDataNodeProperties (DataNode *node, const std::string &filePath)
const PropertyListGetProperties () const override

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::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 Attributes inherited from mitk::AbstractFileReader
std::vector< std::string > m_ReadFiles

Detailed Description

Definition at line 41 of file mitkPointSetReaderService.h.

Constructor & Destructor Documentation

◆ PointSetReaderService()

mitk::PointSetReaderService::PointSetReaderService ( )

◆ ~PointSetReaderService()

mitk::PointSetReaderService::~PointSetReaderService ( )

Member Function Documentation

◆ DoRead()

std::vector<itk::SmartPointer<BaseData> > mitk::PointSetReaderService::DoRead ( )

Method that should be implemented by derived classes and does the real loading. This method is called by Read(). This method must be implemented for each specific reader. Call GetInputStream() first and check for a non-null stream to read from. If the input stream is nullptr, use GetInputLocation() to read from a local file-system path.

If the reader cannot use streams directly, use GetLocalFileName() instead.

The created BaseData objects.
See also

Implements mitk::AbstractFileReader.

◆ Read() [1/2]

std::vector<itk::SmartPointer<BaseData> > mitk::AbstractFileReader::Read

Reads a path or stream and creates a list of BaseData objects.

The default implementation of this method (1) calls DoRead() (Implement the specific reader operation there) and (2) it adds general meta information about the loading process.

◆ Read() [2/2]

DataStorage::SetOfObjects::Pointer mitk::AbstractFileReader::Read

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