Utility class for vtkXMLReader and subclasses. More...

#include <vtkXMLFileReadTester.h>

Inheritance diagram for vtkXMLFileReadTester:

Collaboration diagram for vtkXMLFileReadTester:

Public Types
typedef vtkXMLParser	Superclass

Public Types inherited from vtkXMLParser
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkXMLFileReadTester *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

int	TestReadFile ()


virtual void	SetFileName (const char *)

virtual char *	GetFileName ()


virtual char *	GetFileDataType ()


virtual char *	GetFileVersion ()

Public Member Functions inherited from vtkXMLParser
vtkXMLParser *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	Parse ()

virtual void	SetStream (istream *)

virtual istream *	GetStream ()

vtkTypeInt64	TellG ()

void	SeekG (vtkTypeInt64 position)

virtual int	Parse (const char *inputString)

virtual int	Parse (const char *inputString, unsigned int length)

virtual int	InitializeParser ()

virtual int	ParseChunk (const char *inputString, unsigned int length)

virtual int	CleanupParser ()

virtual void	SetIgnoreCharacterData (int)

virtual int	GetIgnoreCharacterData ()

virtual void	SetEncoding (const char *)

virtual char *	GetEncoding ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkXMLFileReadTester *	SafeDownCast (vtkObjectBase *o)

static vtkXMLFileReadTester *	New ()

Static Public Member Functions inherited from vtkXMLParser
static int	IsTypeOf (const char *type)

static vtkXMLParser *	SafeDownCast (vtkObjectBase *o)

static vtkXMLParser *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXMLFileReadTester ()

	~vtkXMLFileReadTester ()

void	StartElement (const char name, const char *atts)

int	ParsingComplete ()

void	ReportStrayAttribute (const char , const char , const char *)

void	ReportMissingAttribute (const char , const char )

void	ReportBadAttribute (const char , const char , const char *)

void	ReportUnknownElement (const char *)

void	ReportXmlParseError ()

virtual void	SetFileDataType (const char *)

virtual void	SetFileVersion (const char *)

Protected Member Functions inherited from vtkXMLParser
	vtkXMLParser ()

	~vtkXMLParser ()

virtual int	CreateParser ()

virtual int	ParseXML ()

virtual void	EndElement (const char *name)

virtual void	CharacterDataHandler (const char *data, int length)

vtkTypeInt64	GetXMLByteIndex ()

virtual int	ParseBuffer (const char *buffer, unsigned int count)

int	ParseBuffer (const char *buffer)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	FileName

char *	FileDataType

char *	FileVersion

int	Done

Protected Attributes inherited from vtkXMLParser
istream *	Stream

char *	FileName

char *	Encoding

int	ParseError

const char *	InputString

int	InputStringLength

void *	Parser

int	IgnoreCharacterData

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkXMLParser
static int	IsSpace (char c)

Detailed Description

Utility class for vtkXMLReader and subclasses.

vtkXMLFileReadTester reads the smallest part of a file necessary to determine whether it is a VTK XML file. If so, it extracts the file type and version number.

Definition at line 29 of file vtkXMLFileReadTester.h.

Member Typedef Documentation

typedef vtkXMLParser vtkXMLFileReadTester::Superclass

Definition at line 32 of file vtkXMLFileReadTester.h.

Constructor & Destructor Documentation

vtkXMLFileReadTester::vtkXMLFileReadTester ( )

protected

vtkXMLFileReadTester::~vtkXMLFileReadTester ( )

protected

Member Function Documentation

static int vtkXMLFileReadTester::IsTypeOf ( const char * type )

static

virtual int vtkXMLFileReadTester::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkXMLParser.

static vtkXMLFileReadTester* vtkXMLFileReadTester::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkXMLFileReadTester::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkXMLParser.

vtkXMLFileReadTester* vtkXMLFileReadTester::NewInstance ( ) const

void vtkXMLFileReadTester::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

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 vtkObject.

static vtkXMLFileReadTester* vtkXMLFileReadTester::New ( )

static

int vtkXMLFileReadTester::TestReadFile ( )

Try to read the file given by FileName. Returns 1 if the file is a VTK XML file, and 0 otherwise.

virtual void vtkXMLFileReadTester::SetFileName ( const char * )

virtual

Get/Set the name of the file tested by TestReadFile().

Reimplemented from vtkXMLParser.

virtual char* vtkXMLFileReadTester::GetFileName ( )

virtual

Get/Set the name of the file tested by TestReadFile().

Reimplemented from vtkXMLParser.

virtual char* vtkXMLFileReadTester::GetFileDataType ( )

virtual

Get the data type of the XML file tested. If the file could not be read, returns NULL.

virtual char* vtkXMLFileReadTester::GetFileVersion ( )

virtual

Get the file version of the XML file tested. If the file could not be read, returns NULL.

void vtkXMLFileReadTester::StartElement	(	const char *	name,
		const char **	atts
	)

protectedvirtual

Reimplemented from vtkXMLParser.

int vtkXMLFileReadTester::ParsingComplete ( )

protectedvirtual

Reimplemented from vtkXMLParser.

void vtkXMLFileReadTester::ReportStrayAttribute	(	const char *	,
		const char *	,
		const char *
	)

inlineprotectedvirtual

Reimplemented from vtkXMLParser.

Definition at line 64 of file vtkXMLFileReadTester.h.

void vtkXMLFileReadTester::ReportMissingAttribute	(	const char *	,
		const char *
	)

inlineprotectedvirtual

Reimplemented from vtkXMLParser.

Definition at line 65 of file vtkXMLFileReadTester.h.

void vtkXMLFileReadTester::ReportBadAttribute	(	const char *	,
		const char *	,
		const char *
	)

inlineprotectedvirtual

Reimplemented from vtkXMLParser.

Definition at line 66 of file vtkXMLFileReadTester.h.

void vtkXMLFileReadTester::ReportUnknownElement ( const char * )

inlineprotectedvirtual

Reimplemented from vtkXMLParser.

Definition at line 67 of file vtkXMLFileReadTester.h.

void vtkXMLFileReadTester::ReportXmlParseError ( )

inlineprotectedvirtual

Reimplemented from vtkXMLParser.

Definition at line 68 of file vtkXMLFileReadTester.h.

virtual void vtkXMLFileReadTester::SetFileDataType ( const char * )

protectedvirtual

virtual void vtkXMLFileReadTester::SetFileVersion ( const char * )

protectedvirtual

Member Data Documentation

char* vtkXMLFileReadTester::FileName

protected

Definition at line 70 of file vtkXMLFileReadTester.h.

char* vtkXMLFileReadTester::FileDataType

protected

Definition at line 71 of file vtkXMLFileReadTester.h.

char* vtkXMLFileReadTester::FileVersion

protected

Definition at line 72 of file vtkXMLFileReadTester.h.

int vtkXMLFileReadTester::Done

protected

Definition at line 73 of file vtkXMLFileReadTester.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/XML/vtkXMLFileReadTester.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation