ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
itk::XMLReaderBase Class Reference

#include <itkXMLFile.h>

+ Inheritance diagram for itk::XMLReaderBase:
+ Collaboration diagram for itk::XMLReaderBase:

List of all members.

Public Types

typedef XMLReaderBase 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

Protected Member Functions

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

Protected Attributes

std::string m_Filename

Private Member Functions

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

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 34 of file itkXMLFile.h.


Member Typedef Documentation

Standard class typedefs.

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::XMLReader< T >, itk::XMLReader< PGroupSpatialObjectType >, and itk::PolygonGroupSpatialObjectXMLFileReader.

Definition at line 37 of file itkXMLFile.h.


Constructor & Destructor Documentation

itk::XMLReaderBase::XMLReaderBase ( ) [inline, protected]

Definition at line 67 of file itkXMLFile.h.

virtual itk::XMLReaderBase::~XMLReaderBase ( ) [inline, protected, virtual]

Definition at line 68 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.

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]

This method causes the filter to generate its output.

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::XMLReader< T >, itk::XMLReader< PGroupSpatialObjectType >, and itk::PolygonGroupSpatialObjectXMLFileReader.

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.

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

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 77 of file itkXMLFile.h.


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