VTK  9.3.20240619
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkXMLFileReadTester Class Reference

Utility class for vtkXMLReader and subclasses. More...

#include <vtkXMLFileReadTester.h>

Inheritance diagram for vtkXMLFileReadTester:
[legend]
Collaboration diagram for vtkXMLFileReadTester:
[legend]

Public Types

typedef vtkXMLParser Superclass
 
- Public Types inherited from vtkXMLParser
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkXMLFileReadTesterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
int TestReadFile ()
 Try to read the file given by FileName.
 
virtual char * GetFileDataType ()
 Get the data type of the XML file tested.
 
virtual char * GetFileVersion ()
 Get the file version of the XML file tested.
 
- Public Member Functions inherited from vtkXMLParser
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkXMLParserNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual int Parse ()
 Parse the XML input.
 
virtual void SetStream (istream *)
 Get/Set the input stream.
 
virtual istream * GetStream ()
 Get/Set the input stream.
 
vtkTypeInt64 TellG ()
 Used by subclasses and their supporting classes.
 
void SeekG (vtkTypeInt64 position)
 Used by subclasses and their supporting classes.
 
virtual int Parse (const char *inputString)
 Parse the XML message.
 
virtual int Parse (const char *inputString, unsigned int length)
 Parse the XML message.
 
virtual int InitializeParser ()
 When parsing fragments of XML, or when streaming XML, use the following three methods:
 
virtual int ParseChunk (const char *inputString, unsigned int length)
 When parsing fragments of XML, or when streaming XML, use the following three methods:
 
virtual int CleanupParser ()
 When parsing fragments of XML, or when streaming XML, use the following three methods:
 
 vtkSetFilePathMacro (FileName)
 Set and get file name.
 
 vtkGetFilePathMacro (FileName)
 Set and get file name.
 
virtual void SetIgnoreCharacterData (vtkTypeBool)
 If this is off (the default), CharacterDataHandler will be called to process text within XML Elements.
 
virtual vtkTypeBool GetIgnoreCharacterData ()
 If this is off (the default), CharacterDataHandler will be called to process text within XML Elements.
 
virtual void SetEncoding (const char *)
 Set and get the encoding the parser should expect (nullptr defaults to Expat's own default encoder, i.e UTF-8).
 
virtual char * GetEncoding ()
 Set and get the encoding the parser should expect (nullptr defaults to Expat's own default encoder, i.e UTF-8).
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLFileReadTesterSafeDownCast (vtkObjectBase *o)
 
static vtkXMLFileReadTesterNew ()
 
- Static Public Member Functions inherited from vtkXMLParser
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLParserSafeDownCast (vtkObjectBase *o)
 
static vtkXMLParserNew ()
 
static bool hasLargeOffsets ()
 The Expat library can only handle binary files > 2Gb if either size_of(long) == 8 or the "large size" feature is present.
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLFileReadTester ()
 
 ~vtkXMLFileReadTester () override
 
void StartElement (const char *name, const char **atts) override
 
int ParsingComplete () override
 
void ReportStrayAttribute (const char *, const char *, const char *) override
 
void ReportMissingAttribute (const char *, const char *) override
 
void ReportBadAttribute (const char *, const char *, const char *) override
 
void ReportUnknownElement (const char *) override
 
void ReportXmlParseError () override
 
virtual void SetFileDataType (const char *)
 
virtual void SetFileVersion (const char *)
 
- Protected Member Functions inherited from vtkXMLParser
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLParser ()
 
 ~vtkXMLParser () override
 
virtual int CreateParser ()
 
virtual int ParseXML ()
 
virtual int ParsingComplete ()
 
virtual void StartElement (const char *name, const char **atts)
 
virtual void EndElement (const char *name)
 
virtual void CharacterDataHandler (const char *data, int length)
 
virtual void ReportStrayAttribute (const char *element, const char *attr, const char *value)
 
virtual void ReportMissingAttribute (const char *element, const char *attr)
 
virtual void ReportBadAttribute (const char *element, const char *attr, const char *value)
 
virtual void ReportUnknownElement (const char *element)
 
virtual void ReportXmlParseError ()
 
vtkTypeInt64 GetXMLByteIndex ()
 
virtual int ParseBuffer (const char *buffer, unsigned int count)
 
int ParseBuffer (const char *buffer)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

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
 
vtkTypeBool IgnoreCharacterData
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkXMLParser
static int IsSpace (char c)
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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 19 of file vtkXMLFileReadTester.h.

Member Typedef Documentation

◆ Superclass

Definition at line 22 of file vtkXMLFileReadTester.h.

Constructor & Destructor Documentation

◆ vtkXMLFileReadTester()

vtkXMLFileReadTester::vtkXMLFileReadTester ( )
protected

◆ ~vtkXMLFileReadTester()

vtkXMLFileReadTester::~vtkXMLFileReadTester ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXMLFileReadTester::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkXMLParser.

◆ NewInstance()

vtkXMLFileReadTester * vtkXMLFileReadTester::NewInstance ( ) const

◆ PrintSelf()

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

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.

◆ New()

static vtkXMLFileReadTester * vtkXMLFileReadTester::New ( )
static

◆ TestReadFile()

int vtkXMLFileReadTester::TestReadFile ( )

Try to read the file given by FileName.

Returns 1 if the file is a VTK XML file, and 0 otherwise.

◆ GetFileDataType()

virtual char * vtkXMLFileReadTester::GetFileDataType ( )
virtual

Get the data type of the XML file tested.

If the file could not be read, returns nullptr.

◆ GetFileVersion()

virtual char * vtkXMLFileReadTester::GetFileVersion ( )
virtual

Get the file version of the XML file tested.

If the file could not be read, returns nullptr.

◆ StartElement()

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

Reimplemented from vtkXMLParser.

◆ ParsingComplete()

int vtkXMLFileReadTester::ParsingComplete ( )
overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ ReportStrayAttribute()

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

Reimplemented from vtkXMLParser.

Definition at line 54 of file vtkXMLFileReadTester.h.

◆ ReportMissingAttribute()

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

Reimplemented from vtkXMLParser.

Definition at line 55 of file vtkXMLFileReadTester.h.

◆ ReportBadAttribute()

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

Reimplemented from vtkXMLParser.

Definition at line 56 of file vtkXMLFileReadTester.h.

◆ ReportUnknownElement()

void vtkXMLFileReadTester::ReportUnknownElement ( const char *  )
inlineoverrideprotectedvirtual

Reimplemented from vtkXMLParser.

Definition at line 57 of file vtkXMLFileReadTester.h.

◆ ReportXmlParseError()

void vtkXMLFileReadTester::ReportXmlParseError ( )
inlineoverrideprotectedvirtual

Reimplemented from vtkXMLParser.

Definition at line 58 of file vtkXMLFileReadTester.h.

◆ SetFileDataType()

virtual void vtkXMLFileReadTester::SetFileDataType ( const char *  )
protectedvirtual

◆ SetFileVersion()

virtual void vtkXMLFileReadTester::SetFileVersion ( const char *  )
protectedvirtual

Member Data Documentation

◆ FileDataType

char* vtkXMLFileReadTester::FileDataType
protected

Definition at line 60 of file vtkXMLFileReadTester.h.

◆ FileVersion

char* vtkXMLFileReadTester::FileVersion
protected

Definition at line 61 of file vtkXMLFileReadTester.h.

◆ Done

int vtkXMLFileReadTester::Done
protected

Definition at line 62 of file vtkXMLFileReadTester.h.


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