itk::XMLReader< T > Class Template Reference

#include <itkXMLFile.h>

Detailed Description

template<typename T>
class itk::XMLReader< T >

template base class for an XMLReader Its purpose really is just to define the simple interface for extracting the object resulting from reading the XML File. Since it doesn't define any of the pure virtual methods in XMLReaderBase, It can't be instantiated by itself

Definition at line 100 of file itkXMLFile.h.

Inheritance diagram for itk::XMLReader< T >:

Collaboration diagram for itk::XMLReader< T >:

Public Types
using	Self = XMLReader
Public Types inherited from itk::XMLReaderBase
using	Self = XMLReaderBase
Public Types inherited from itk::LightProcessObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightProcessObject
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
T *	GetOutputObject ()
void	SetOutputObject (T *obj)
Public Member Functions inherited from itk::XMLReaderBase
virtual int	CanReadFile (const char *name)=0
virtual void	CharacterDataHandler (const char *inData, int inLength)=0
virtual void	EndElement (const char *name)=0
virtual void	GenerateOutputInformation ()
virtual const char *	GetFilename () const
virtual void	SetFilename (const char *_arg)
virtual void	StartElement (const char *name, const char **atts)=0
Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOn ()
virtual const bool &	GetAbortGenerateData () const
const char *	GetNameOfClass () const override
virtual void	SetAbortGenerateData (bool _arg)
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
virtual void	SetProgress (float _arg)
virtual const float &	GetProgress () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
LightObject::Pointer	CreateAnother () const override
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
const char *	GetNameOfClass () const override
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag) const
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexcept override
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
Pointer	Clone () const
virtual Pointer	CreateAnother () const
virtual void	Delete ()
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const noexcept

Protected Member Functions
	XMLReader ()
	~XMLReader () override=default
Protected Member Functions inherited from itk::XMLReaderBase
void	parse ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	XMLReaderBase ()=default
	~XMLReaderBase () override=default
Protected Member Functions inherited from itk::LightProcessObject
virtual void	GenerateData ()
	LightProcessObject ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~LightProcessObject () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
	~Object () override
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Protected Attributes
T *	m_OutputObject {}
Protected Attributes inherited from itk::XMLReaderBase
std::string	m_Filename {}
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Additional Inherited Members
Static Public Member Functions inherited from itk::LightProcessObject
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Member Typedef Documentation

Self

template<typename T >

using itk::XMLReader< T >::Self = XMLReader

Definition at line 105 of file itkXMLFile.h.

Constructor & Destructor Documentation

XMLReader()

template<typename T >

itk::XMLReader< T >::XMLReader ( )

inlineprotected

Definition at line 125 of file itkXMLFile.h.

~XMLReader()

template<typename T >

itk::XMLReader< T >::~XMLReader ( )

overrideprotecteddefault

Member Function Documentation

GetOutputObject()

template<typename T >

T * itk::XMLReader< T >::GetOutputObject ( )

inline

Get the output object, after an XML File has been successfully parsed.

Definition at line 119 of file itkXMLFile.h.

SetOutputObject()

template<typename T >

void itk::XMLReader< T >::SetOutputObject ( T *  obj )

inline

Set the output object. Doesn't make sense for a client of the XMLReader, but could be used in derived class to assign pointer to result object.

Definition at line 111 of file itkXMLFile.h.

Member Data Documentation

m_OutputObject

template<typename T >

T* itk::XMLReader< T >::m_OutputObject {}

protected

Definition at line 131 of file itkXMLFile.h.

---

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

• itkXMLFile.h