Medical Imaging Interaction Toolkit  2018.4.99-12ad79a3
Medical Imaging Interaction Toolkit
mitk::PlanarFigureReader Class Reference

reads xml representations of mitk::PlanarFigure from a file More...

#include <mitkPlanarFigureReader.h>

Inheritance diagram for mitk::PlanarFigureReader:
Collaboration diagram for mitk::PlanarFigureReader:

Public Member Functions

 mitkClassMacro (PlanarFigureReader, FileReader)
 
Pointer Clone () const
 
virtual void SetFileName (const char *_arg)
 Sets the filename of the file to be read. More...
 
virtual const char * GetFileName () const
 Returns the filename of the point set xml-file. More...
 
virtual void SetFilePrefix (const char *_arg)
 
virtual const char * GetFilePrefix () const
 
virtual void SetFilePattern (const char *_arg)
 
virtual const char * GetFilePattern () const
 
virtual bool GetSuccess () const
 
- Public Member Functions inherited from mitk::PlanarFigureSource
 mitkClassMacro (PlanarFigureSource, BaseDataSource) static Pointer New()
 
Pointer Clone () const
 
mitkBaseDataSourceGetOutputDeclarations itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
void GenerateInputRequestedRegion () override
 
- Public Member Functions inherited from mitk::BaseDataSource
virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Access itk::ProcessObject::m_Updating. More...
 
- Public Member Functions inherited from mitk::FileReader
virtual std::vector< std::string > GetClassHierarchy () const
 
 itkTypeMacroNoParent (FileReader) virtual const char *GetFileName() const =0
 Get the specified the file to load. More...
 
virtual bool CanReadFromMemory ()
 Specifies, whether the file reader also can read a file from a memory buffer. More...
 
virtual void SetReadFromMemory (bool read)
 Set/Get functions to advise the file reader to use a memory array for reading a file. More...
 
virtual bool GetReadFromMemory ()
 
virtual void SetMemoryBuffer (const char *dataArray, unsigned int size)
 To be used along with a call of SetReadFromMemory(true). This sets the memory buffer and the size from which the reader will read. More...
 

Static Public Member Functions

static Pointer New ()
 
static bool CanReadFile (const std::string filename, const std::string filePrefix, const std::string filePattern)
 
- Static Public Member Functions inherited from mitk::BaseDataSource
static const char * GetStaticNameOfClass ()
 
- Static Public Member Functions inherited from mitk::FileReader
static const char * GetStaticNameOfClass ()
 

Protected Types

typedef std::list< double > DoubleList
 

Protected Member Functions

 PlanarFigureReader ()
 
 ~PlanarFigureReader () override
 
void GenerateData () override
 
void GenerateOutputInformation () override
 
virtual void ResizeOutputs (const unsigned int &num)
 
virtual int CanReadFile (const char *name)
 
mitk::Vector3D GetVectorFromXMLNode (TiXmlElement *e)
 parses the element for the attributes x,y,z and returns a mitk::Vector3D filled with these values More...
 
mitk::Point3D GetPointFromXMLNode (TiXmlElement *e)
 parses the element for the attributes x,y,z and returns a mitk::Point3D filled with these values More...
 
DoubleList GetDoubleAttributeListFromXMLNode (TiXmlElement *e, const char *attributeNameBase, unsigned int count)
 parses the element for the attributes name0 to nameN, where "name" and the number of attributes to read are passed as argument. Returns a list of double vales. More...
 
- Protected Member Functions inherited from mitk::PlanarFigureSource
 PlanarFigureSource ()
 
 ~PlanarFigureSource () override
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 
 ~BaseDataSource () override
 
- Protected Member Functions inherited from mitk::FileReader
 FileReader ()
 
virtual ~FileReader ()
 

Protected Attributes

std::string m_FileName
 
std::string m_FilePrefix
 
std::string m_FilePattern
 
bool m_Success
 
- Protected Attributes inherited from mitk::FileReader
bool m_CanReadFromMemory
 
bool m_ReadFromMemory
 
const char * m_MemoryBuffer
 
unsigned int m_MemorySize
 

Additional Inherited Members

- Public Types inherited from mitk::PlanarFigureSource
typedef mitk::PlanarFigure OutputType
 
typedef OutputType::Pointer OutputTypePointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 
- Public Types inherited from mitk::FileReader
typedef FileReader Self
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 

Detailed Description

reads xml representations of mitk::PlanarFigure from a file

Reader for xml files containing one or multiple xml represenations of mitk::PlanarFigure. If multiple mitk::PlanarFigure are stored in one file, these are assigned to multiple outputs of the filter.

Definition at line 33 of file mitkPlanarFigureReader.h.

Member Typedef Documentation

◆ DoubleList

typedef std::list<double> mitk::PlanarFigureReader::DoubleList
protected

Definition at line 77 of file mitkPlanarFigureReader.h.

Constructor & Destructor Documentation

◆ PlanarFigureReader()

mitk::PlanarFigureReader::PlanarFigureReader ( )
protected

◆ ~PlanarFigureReader()

mitk::PlanarFigureReader::~PlanarFigureReader ( )
overrideprotected

Virtual destructor

Definition at line 49 of file mitkPlanarFigureReader.cpp.

Member Function Documentation

◆ CanReadFile() [1/2]

bool mitk::PlanarFigureReader::CanReadFile ( const std::string  filename,
const std::string  filePrefix,
const std::string  filePattern 
)
static

Definition at line 416 of file mitkPlanarFigureReader.cpp.

Referenced by GenerateData().

◆ CanReadFile() [2/2]

int mitk::PlanarFigureReader::CanReadFile ( const char *  name)
protectedvirtual

Checks if the given file has appropriate read access.

Returns
true if the file exists and may be read or false otherwise.

Definition at line 402 of file mitkPlanarFigureReader.cpp.

◆ Clone()

Pointer mitk::PlanarFigureReader::Clone ( ) const

◆ GenerateData()

◆ GenerateOutputInformation()

void mitk::PlanarFigureReader::GenerateOutputInformation ( )
overrideprotected

Does nothing in the current implementation

Definition at line 398 of file mitkPlanarFigureReader.cpp.

◆ GetDoubleAttributeListFromXMLNode()

mitk::PlanarFigureReader::DoubleList mitk::PlanarFigureReader::GetDoubleAttributeListFromXMLNode ( TiXmlElement *  e,
const char *  attributeNameBase,
unsigned int  count 
)
protected

parses the element for the attributes name0 to nameN, where "name" and the number of attributes to read are passed as argument. Returns a list of double vales.

Parameters
[in]ethe TiXmlElement that will be parsed
[in]attributeNameBasethe basic name of the parameters
[in]countthe number of parameters
Returns
returns a mitk::Point3D with the values x,y,z

Definition at line 376 of file mitkPlanarFigureReader.cpp.

Referenced by GenerateData().

◆ GetFileName()

virtual const char* mitk::PlanarFigureReader::GetFileName ( ) const
virtual

Returns the filename of the point set xml-file.

Returns
the filename of the point set xml-file.

◆ GetFilePattern()

virtual const char* mitk::PlanarFigureReader::GetFilePattern ( ) const
virtual
Warning
multiple load not (yet) supported

Implements mitk::FileReader.

◆ GetFilePrefix()

virtual const char* mitk::PlanarFigureReader::GetFilePrefix ( ) const
virtual
Warning
multiple load not (yet) supported

Implements mitk::FileReader.

◆ GetPointFromXMLNode()

mitk::Point3D mitk::PlanarFigureReader::GetPointFromXMLNode ( TiXmlElement *  e)
protected

parses the element for the attributes x,y,z and returns a mitk::Point3D filled with these values

Parameters
[in]ethe TiXmlElement that will be parsed
Returns
returns a mitk::Point3D with the values x,y,z

Definition at line 340 of file mitkPlanarFigureReader.cpp.

Referenced by GenerateData().

◆ GetSuccess()

virtual bool mitk::PlanarFigureReader::GetSuccess ( ) const
virtual
Returns
whether the last read attempt was successful or not.

◆ GetVectorFromXMLNode()

mitk::Vector3D mitk::PlanarFigureReader::GetVectorFromXMLNode ( TiXmlElement *  e)
protected

parses the element for the attributes x,y,z and returns a mitk::Vector3D filled with these values

Parameters
[in]ethe TiXmlElement that will be parsed
Returns
returns a mitk::Vector3D with the values x,y,z

Definition at line 358 of file mitkPlanarFigureReader.cpp.

Referenced by GenerateData().

◆ mitkClassMacro()

mitk::PlanarFigureReader::mitkClassMacro ( PlanarFigureReader  ,
FileReader   
)

◆ New()

static Pointer mitk::PlanarFigureReader::New ( )
static

Referenced by Clone().

◆ ResizeOutputs()

void mitk::PlanarFigureReader::ResizeOutputs ( const unsigned int &  num)
protectedvirtual

Resizes the output-objects according to the given number.

Parameters
numthe new number of output objects.

Definition at line 430 of file mitkPlanarFigureReader.cpp.

References mitk::PlanarFigureSource::MakeOutput().

◆ SetFileName()

virtual void mitk::PlanarFigureReader::SetFileName ( const char *  _arg)
virtual

Sets the filename of the file to be read.

Parameters
_argthe filename of the point set xml-file

Implements mitk::FileReader.

◆ SetFilePattern()

virtual void mitk::PlanarFigureReader::SetFilePattern ( const char *  _arg)
virtual
Warning
multiple load not (yet) supported

Implements mitk::FileReader.

◆ SetFilePrefix()

virtual void mitk::PlanarFigureReader::SetFilePrefix ( const char *  _arg)
virtual
Warning
multiple load not (yet) supported

Implements mitk::FileReader.

Member Data Documentation

◆ m_FileName

std::string mitk::PlanarFigureReader::m_FileName
protected

Definition at line 140 of file mitkPlanarFigureReader.h.

Referenced by GenerateData().

◆ m_FilePattern

std::string mitk::PlanarFigureReader::m_FilePattern
protected

Definition at line 142 of file mitkPlanarFigureReader.h.

◆ m_FilePrefix

std::string mitk::PlanarFigureReader::m_FilePrefix
protected

Definition at line 141 of file mitkPlanarFigureReader.h.

◆ m_Success

bool mitk::PlanarFigureReader::m_Success
protected

Definition at line 143 of file mitkPlanarFigureReader.h.

Referenced by GenerateData().


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