itk::XMLReaderBase Class Reference

#include <itkXMLFile.h>

Inheritance diagram for itk::XMLReaderBase:

Collaboration diagram for itk::XMLReaderBase:

Detailed Description

XMLReaderBase encapsulates the expat library (Insight/Utilities/expat and defines the methods needed in a derived class to receive the contents of an XML file in a structured manner. It's 'impure virtual' in that some functions that are generic to opening and parsing a file are implemented here.

Definition at line 33 of file itkXMLFile.h.

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

Public Member Functions
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	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const bool &	GetAbortGenerateData () const
virtual const char *	GetNameOfClass () const
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 *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const ITK_OVERRIDE
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) ITK_OVERRIDE
virtual void	UnRegister () const ITK_OVERRIDE
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

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

Protected Attributes
std::string	m_Filename
Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
void	operator= (const Self &)
	XMLReaderBase (const Self &)

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 flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Member Typedef Documentation

typedef XMLReaderBase itk::XMLReaderBase::Self

Definition at line 36 of file itkXMLFile.h.

Constructor & Destructor Documentation

itk::XMLReaderBase::XMLReaderBase ( )

inlineprotected

Definition at line 66 of file itkXMLFile.h.

virtual itk::XMLReaderBase::~XMLReaderBase ( )

inlineprotectedvirtual

Definition at line 67 of file itkXMLFile.h.

itk::XMLReaderBase::XMLReaderBase ( const Self &  )

private

Member Function Documentation

virtual int itk::XMLReaderBase::CanReadFile ( const char *  name )

pure virtual

determine whether a file can be opened and read

Implemented in itk::PolygonGroupSpatialObjectXMLFileReader.

virtual void itk::XMLReaderBase::CharacterDataHandler ( const char *  inData, int  inLength  )

pure virtual

Callback function – called from XML parser with the character data for an XML element

Implemented in itk::PolygonGroupSpatialObjectXMLFileReader.

virtual void itk::XMLReaderBase::EndElement ( const char *  name )

pure virtual

Callback function – called from XML parser when ending tag encountered

Implemented in itk::PolygonGroupSpatialObjectXMLFileReader.

virtual void itk::XMLReaderBase::GenerateOutputInformation ( )

virtual

do the actual parsing of the input file

virtual const char* itk::XMLReaderBase::GetFilename ( ) const

virtual

Get the filename to write

void itk::XMLReaderBase::operator= ( const Self &  )

private

void itk::XMLReaderBase::parse ( void  )

protected

Instantiates and invokes the XML parser for the file named by m_Filename. The parser will throw an exception in the case of XML syntax errors, missing filenames, unreadable input file, etc.

virtual void itk::XMLReaderBase::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::LightProcessObject.

virtual void itk::XMLReaderBase::SetFilename ( const char *  _arg )

virtual

Set the filename to write

virtual void itk::XMLReaderBase::StartElement ( const char *  name, const char **  atts  )

pure virtual

Callback function – called from XML parser with start-of-element information.

Implemented in itk::PolygonGroupSpatialObjectXMLFileReader.

Member Data Documentation

std::string itk::XMLReaderBase::m_Filename

protected

Definition at line 76 of file itkXMLFile.h.

---

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

• itkXMLFile.h