VTK  9.2.20220809
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkExodusIIReaderParser Class Reference

internal parser used by vtkExodusIIReader. More...

#include <vtkExodusIIReaderParser.h>

Inheritance diagram for vtkExodusIIReaderParser:
[legend]
Collaboration diagram for vtkExodusIIReaderParser:
[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. More...
 
vtkExodusIIReaderParserNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Go (VTK_FILEPATH const char *filename)
 Trigger parsing of the XML file. More...
 
bool HasInformationAboutBlock (int id)
 
std::string GetBlockName (int id)
 Given a block "id" return the name as determined from the xml. More...
 
virtual vtkMutableDirectedGraphGetSIL ()
 Returns the SIL. More...
 
void GetBlockIds (std::set< int > &blockIdsSet)
 Fills up the blockIdsSet with the block ids referred to by the XML. More...
 
- Public Member Functions inherited from vtkXMLParser
vtkXMLParserNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual int Parse ()
 Parse the XML input. More...
 
virtual void SetStream (istream *)
 Get/Set the input stream. More...
 
virtual istream * GetStream ()
 Get/Set the input stream. More...
 
vtkTypeInt64 TellG ()
 Used by subclasses and their supporting classes. More...
 
void SeekG (vtkTypeInt64 position)
 Used by subclasses and their supporting classes. More...
 
virtual int Parse (const char *inputString)
 Parse the XML message. More...
 
virtual int Parse (const char *inputString, unsigned int length)
 Parse the XML message. More...
 
virtual int InitializeParser ()
 When parsing fragments of XML, or when streaming XML, use the following three methods: More...
 
virtual int ParseChunk (const char *inputString, unsigned int length)
 When parsing fragments of XML, or when streaming XML, use the following three methods: More...
 
virtual int CleanupParser ()
 When parsing fragments of XML, or when streaming XML, use the following three methods: More...
 
 vtkSetFilePathMacro (FileName)
 Set and get file name. More...
 
 vtkGetFilePathMacro (FileName)
 Set and get file name. More...
 
virtual void SetIgnoreCharacterData (int)
 If this is off (the default), CharacterDataHandler will be called to process text within XML Elements. More...
 
virtual int GetIgnoreCharacterData ()
 If this is off (the default), CharacterDataHandler will be called to process text within XML Elements. More...
 
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). More...
 
virtual char * GetEncoding ()
 Set and get the encoding the parser should expect (nullptr defaults to Expat's own default encoder, i.e UTF-8). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkExodusIIReaderParserNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkExodusIIReaderParserSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkXMLParser
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLParserSafeDownCast (vtkObjectBase *o)
 
static vtkXMLParserNew ()
 
- 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkExodusIIReaderParser ()
 
 ~vtkExodusIIReaderParser () override
 
void StartElement (const char *tagName, const char **attrs) override
 
void EndElement (const char *tagName) override
 
void FinishedParsing ()
 
const char * GetValue (const char *attr, const char **attrs)
 
vtkIdType AddVertexToSIL (const char *name)
 
vtkIdType AddChildEdgeToSIL (vtkIdType src, vtkIdType dst)
 
vtkIdType AddCrossEdgeToSIL (vtkIdType src, vtkIdType dst)
 
vtkIdType GetPartVertex (const char *part_number_instance_string)
 Returns the vertex id for the "part" with given part_number_instance_string formed as "{part-number} Instance: {part-instance}". More...
 
- Protected Member Functions inherited from vtkXMLParser
 vtkXMLParser ()
 
 ~vtkXMLParser () override
 
virtual int CreateParser ()
 
virtual int ParseXML ()
 
virtual int ParsingComplete ()
 
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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

std::map< int, vtkIdTypeBlockID_To_VertexID
 
std::map< int, std::string > BlockID_To_MaterialName
 
std::map< std::string, vtkIdTypeMaterialName_To_VertexID
 
std::map< vtkIdType, std::string > PartVertexID_To_Descriptions
 
std::map< vtkIdType, std::string > MaterialSpecifications
 
std::map< std::string, vtkIdTypePart_To_VertexID
 
std::map< int, std::string > BlockID_To_Part
 
vtkMutableDirectedGraphSIL
 
vtkSmartPointer< vtkStringArrayNamesArray
 
vtkSmartPointer< vtkUnsignedCharArrayCrossEdgesArray
 
std::string BlockPartNumberString
 
vtkIdType RootVertex
 
vtkIdType BlocksVertex
 
vtkIdType AssembliesVertex
 
vtkIdType MaterialsVertex
 
std::vector< vtkIdTypeCurrentVertex
 
bool InBlocks
 
bool InMaterialAssignments
 
- 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
 
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

internal parser used by vtkExodusIIReader.

vtkExodusIIReaderParser is an internal XML parser used by vtkExodusIIReader. This is not for public use.

Definition at line 39 of file vtkExodusIIReaderParser.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkExodusIIReaderParser.h.

Constructor & Destructor Documentation

◆ vtkExodusIIReaderParser()

vtkExodusIIReaderParser::vtkExodusIIReaderParser ( )
protected

◆ ~vtkExodusIIReaderParser()

vtkExodusIIReaderParser::~vtkExodusIIReaderParser ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkExodusIIReaderParser* vtkExodusIIReaderParser::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkExodusIIReaderParser::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 vtkExodusIIReaderParser* vtkExodusIIReaderParser::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkExodusIIReaderParser::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkXMLParser.

◆ NewInstance()

vtkExodusIIReaderParser* vtkExodusIIReaderParser::NewInstance ( ) const

◆ PrintSelf()

void vtkExodusIIReaderParser::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.

◆ GetSIL()

virtual vtkMutableDirectedGraph* vtkExodusIIReaderParser::GetSIL ( )
virtual

Returns the SIL.

This is valid only after Go().

◆ Go()

void vtkExodusIIReaderParser::Go ( VTK_FILEPATH const char *  filename)

Trigger parsing of the XML file.

◆ HasInformationAboutBlock()

bool vtkExodusIIReaderParser::HasInformationAboutBlock ( int  id)
inline

Definition at line 61 of file vtkExodusIIReaderParser.h.

◆ GetBlockName()

std::string vtkExodusIIReaderParser::GetBlockName ( int  id)

Given a block "id" return the name as determined from the xml.

This is valid only after Go().

◆ GetBlockIds()

void vtkExodusIIReaderParser::GetBlockIds ( std::set< int > &  blockIdsSet)
inline

Fills up the blockIdsSet with the block ids referred to by the XML.

This is valid only after Go().

Definition at line 77 of file vtkExodusIIReaderParser.h.

◆ StartElement()

void vtkExodusIIReaderParser::StartElement ( const char *  tagName,
const char **  attrs 
)
overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ EndElement()

void vtkExodusIIReaderParser::EndElement ( const char *  tagName)
overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ FinishedParsing()

void vtkExodusIIReaderParser::FinishedParsing ( )
protected

◆ GetValue()

const char* vtkExodusIIReaderParser::GetValue ( const char *  attr,
const char **  attrs 
)
inlineprotected

Definition at line 95 of file vtkExodusIIReaderParser.h.

◆ AddVertexToSIL()

vtkIdType vtkExodusIIReaderParser::AddVertexToSIL ( const char *  name)
protected

◆ AddChildEdgeToSIL()

vtkIdType vtkExodusIIReaderParser::AddChildEdgeToSIL ( vtkIdType  src,
vtkIdType  dst 
)
protected

◆ AddCrossEdgeToSIL()

vtkIdType vtkExodusIIReaderParser::AddCrossEdgeToSIL ( vtkIdType  src,
vtkIdType  dst 
)
protected

◆ GetPartVertex()

vtkIdType vtkExodusIIReaderParser::GetPartVertex ( const char *  part_number_instance_string)
protected

Returns the vertex id for the "part" with given part_number_instance_string formed as "{part-number} Instance: {part-instance}".

Member Data Documentation

◆ BlockID_To_VertexID

std::map<int, vtkIdType> vtkExodusIIReaderParser::BlockID_To_VertexID
protected

Definition at line 131 of file vtkExodusIIReaderParser.h.

◆ BlockID_To_MaterialName

std::map<int, std::string> vtkExodusIIReaderParser::BlockID_To_MaterialName
protected

Definition at line 134 of file vtkExodusIIReaderParser.h.

◆ MaterialName_To_VertexID

std::map<std::string, vtkIdType> vtkExodusIIReaderParser::MaterialName_To_VertexID
protected

Definition at line 138 of file vtkExodusIIReaderParser.h.

◆ PartVertexID_To_Descriptions

std::map<vtkIdType, std::string> vtkExodusIIReaderParser::PartVertexID_To_Descriptions
protected

Definition at line 140 of file vtkExodusIIReaderParser.h.

◆ MaterialSpecifications

std::map<vtkIdType, std::string> vtkExodusIIReaderParser::MaterialSpecifications
protected

Definition at line 146 of file vtkExodusIIReaderParser.h.

◆ Part_To_VertexID

std::map<std::string, vtkIdType> vtkExodusIIReaderParser::Part_To_VertexID
protected

Definition at line 150 of file vtkExodusIIReaderParser.h.

◆ BlockID_To_Part

std::map<int, std::string> vtkExodusIIReaderParser::BlockID_To_Part
protected

Definition at line 153 of file vtkExodusIIReaderParser.h.

◆ SIL

vtkMutableDirectedGraph* vtkExodusIIReaderParser::SIL
protected

Definition at line 155 of file vtkExodusIIReaderParser.h.

◆ NamesArray

vtkSmartPointer<vtkStringArray> vtkExodusIIReaderParser::NamesArray
protected

Definition at line 156 of file vtkExodusIIReaderParser.h.

◆ CrossEdgesArray

vtkSmartPointer<vtkUnsignedCharArray> vtkExodusIIReaderParser::CrossEdgesArray
protected

Definition at line 157 of file vtkExodusIIReaderParser.h.

◆ BlockPartNumberString

std::string vtkExodusIIReaderParser::BlockPartNumberString
protected

Definition at line 159 of file vtkExodusIIReaderParser.h.

◆ RootVertex

vtkIdType vtkExodusIIReaderParser::RootVertex
protected

Definition at line 161 of file vtkExodusIIReaderParser.h.

◆ BlocksVertex

vtkIdType vtkExodusIIReaderParser::BlocksVertex
protected

Definition at line 162 of file vtkExodusIIReaderParser.h.

◆ AssembliesVertex

vtkIdType vtkExodusIIReaderParser::AssembliesVertex
protected

Definition at line 163 of file vtkExodusIIReaderParser.h.

◆ MaterialsVertex

vtkIdType vtkExodusIIReaderParser::MaterialsVertex
protected

Definition at line 164 of file vtkExodusIIReaderParser.h.

◆ CurrentVertex

std::vector<vtkIdType> vtkExodusIIReaderParser::CurrentVertex
protected

Definition at line 165 of file vtkExodusIIReaderParser.h.

◆ InBlocks

bool vtkExodusIIReaderParser::InBlocks
protected

Definition at line 167 of file vtkExodusIIReaderParser.h.

◆ InMaterialAssignments

bool vtkExodusIIReaderParser::InMaterialAssignments
protected

Definition at line 168 of file vtkExodusIIReaderParser.h.


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