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

Fill a vtkBlueObeliskData container with data from the BODR XML dataset. More...

#include <vtkBlueObeliskDataParser.h>

Inheritance diagram for vtkBlueObeliskDataParser:
[legend]
Collaboration diagram for vtkBlueObeliskDataParser:
[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...
 
vtkBlueObeliskDataParserNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetTarget (vtkBlueObeliskData *bodr)
 Set the target vtkBlueObeliskData object that this parser will populate. More...
 
int Parse () override
 Start parsing. More...
 
int Parse (const char *) override
 These are only implemented to prevent compiler warnings about hidden virtual overloads. More...
 
int Parse (const char *, unsigned int) override
 
- 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 void SetStream (istream *)
 Get/Set the input stream. More...
 
virtual istream * GetStream ()
 
vtkTypeInt64 TellG ()
 Used by subclasses and their supporting classes. More...
 
void SeekG (vtkTypeInt64 position)
 
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)
 
virtual int CleanupParser ()
 
virtual void SetFileName (const char *)
 Set and get file name. More...
 
virtual char * GetFileName ()
 
virtual void SetIgnoreCharacterData (int)
 If this is off (the default), CharacterDataHandler will be called to process text within XML Elements. More...
 
virtual int GetIgnoreCharacterData ()
 
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 ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkBlueObeliskDataParserSafeDownCast (vtkObjectBase *o)
 
static vtkBlueObeliskDataParserNew ()
 
- 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Types

enum  AtomValueType {
  None = 0, AtomicNumber, Symbol, Name,
  PeriodicTableBlock, ElectronicConfiguration, Family, Mass,
  ExactMass, IonizationEnergy, ElectronAffinity, PaulingElectronegativity,
  CovalentRadius, VDWRadius, DefaultColor, BoilingPoint,
  MeltingPoint, Period, Group
}
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkBlueObeliskDataParser ()
 
 ~vtkBlueObeliskDataParser () override
 
void StartElement (const char *name, const char **attr) override
 
void EndElement (const char *name) override
 
void CharacterDataHandler (const char *data, int length) override
 
void SetCurrentValue (const char *data, int length)
 
void SetCurrentValue (const char *data)
 
void NewAtomStarted (const char **attr)
 
void NewAtomFinished ()
 
void NewValueStarted (const char **attr)
 
void NewValueFinished ()
 
- Protected Member Functions inherited from vtkXMLParser
 vtkXMLParser ()
 
 ~vtkXMLParser () override
 
virtual int CreateParser ()
 
virtual int ParseXML ()
 
virtual int ParsingComplete ()
 
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 ()
 
- 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

vtkBlueObeliskDataTarget
 
bool IsProcessingAtom
 
bool IsProcessingValue
 
std::string CharacterDataValueBuffer
 
enum vtkBlueObeliskDataParser::AtomValueType CurrentValueType
 
int CurrentAtomicNumber
 
vtkStdStringCurrentSymbol
 
vtkStdStringCurrentName
 
vtkStdStringCurrentPeriodicTableBlock
 
vtkStdStringCurrentElectronicConfiguration
 
vtkStdStringCurrentFamily
 
float CurrentMass
 
float CurrentExactMass
 
float CurrentIonizationEnergy
 
float CurrentElectronAffinity
 
float CurrentPaulingElectronegativity
 
float CurrentCovalentRadius
 
float CurrentVDWRadius
 
float CurrentDefaultColor [3]
 
float CurrentBoilingPoint
 
float CurrentMeltingPoint
 
unsigned int CurrentPeriod
 
unsigned int CurrentGroup
 
- 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkXMLParser
static int IsSpace (char c)
 

Detailed Description

Fill a vtkBlueObeliskData container with data from the BODR XML dataset.

The Blue Obelisk Data Repository is a free, open repository of chemical information. This class extracts the BODR information into vtk arrays, which are stored in a vtkBlueObeliskData object.

Warning
The vtkBlueObeliskDataParser class should never need to be used directly. For convenient access to the BODR data, use vtkPeriodicTable. For access to the raw arrays produced by this parser, see the vtkBlueObeliskData class. A static vtkBlueObeliskData object is accessible via vtkPeriodicTable::GetBlueObeliskData().
See also
vtkPeriodicTable vtkBlueObeliskData

Definition at line 51 of file vtkBlueObeliskDataParser.h.

Member Typedef Documentation

◆ Superclass

Definition at line 54 of file vtkBlueObeliskDataParser.h.

Member Enumeration Documentation

◆ AtomValueType

Enumerator
None 
AtomicNumber 
Symbol 
Name 
PeriodicTableBlock 
ElectronicConfiguration 
Family 
Mass 
ExactMass 
IonizationEnergy 
ElectronAffinity 
PaulingElectronegativity 
CovalentRadius 
VDWRadius 
DefaultColor 
BoilingPoint 
MeltingPoint 
Period 
Group 

Definition at line 104 of file vtkBlueObeliskDataParser.h.

Constructor & Destructor Documentation

◆ vtkBlueObeliskDataParser()

vtkBlueObeliskDataParser::vtkBlueObeliskDataParser ( )
protected

◆ ~vtkBlueObeliskDataParser()

vtkBlueObeliskDataParser::~vtkBlueObeliskDataParser ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBlueObeliskDataParser::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkXMLParser.

◆ NewInstance()

vtkBlueObeliskDataParser* vtkBlueObeliskDataParser::NewInstance ( ) const

◆ PrintSelf()

void vtkBlueObeliskDataParser::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 vtkBlueObeliskDataParser* vtkBlueObeliskDataParser::New ( )
static

◆ SetTarget()

virtual void vtkBlueObeliskDataParser::SetTarget ( vtkBlueObeliskData bodr)
virtual

Set the target vtkBlueObeliskData object that this parser will populate.

◆ Parse() [1/3]

int vtkBlueObeliskDataParser::Parse ( )
overridevirtual

Start parsing.

Reimplemented from vtkXMLParser.

◆ Parse() [2/3]

int vtkBlueObeliskDataParser::Parse ( const char *  )
overridevirtual

These are only implemented to prevent compiler warnings about hidden virtual overloads.

This function simply call Parse(); the arguments are ignored.

Reimplemented from vtkXMLParser.

◆ Parse() [3/3]

int vtkBlueObeliskDataParser::Parse ( const char *  ,
unsigned int   
)
overridevirtual

Reimplemented from vtkXMLParser.

◆ StartElement()

void vtkBlueObeliskDataParser::StartElement ( const char *  name,
const char **  attr 
)
overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ EndElement()

void vtkBlueObeliskDataParser::EndElement ( const char *  name)
overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ CharacterDataHandler()

void vtkBlueObeliskDataParser::CharacterDataHandler ( const char *  data,
int  length 
)
overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ SetCurrentValue() [1/2]

void vtkBlueObeliskDataParser::SetCurrentValue ( const char *  data,
int  length 
)
protected

◆ SetCurrentValue() [2/2]

void vtkBlueObeliskDataParser::SetCurrentValue ( const char *  data)
protected

◆ NewAtomStarted()

void vtkBlueObeliskDataParser::NewAtomStarted ( const char **  attr)
protected

◆ NewAtomFinished()

void vtkBlueObeliskDataParser::NewAtomFinished ( )
protected

◆ NewValueStarted()

void vtkBlueObeliskDataParser::NewValueStarted ( const char **  attr)
protected

◆ NewValueFinished()

void vtkBlueObeliskDataParser::NewValueFinished ( )
protected

Member Data Documentation

◆ Target

vtkBlueObeliskData* vtkBlueObeliskDataParser::Target
protected

Definition at line 92 of file vtkBlueObeliskDataParser.h.

◆ IsProcessingAtom

bool vtkBlueObeliskDataParser::IsProcessingAtom
protected

Definition at line 94 of file vtkBlueObeliskDataParser.h.

◆ IsProcessingValue

bool vtkBlueObeliskDataParser::IsProcessingValue
protected

Definition at line 98 of file vtkBlueObeliskDataParser.h.

◆ CharacterDataValueBuffer

std::string vtkBlueObeliskDataParser::CharacterDataValueBuffer
protected

Definition at line 102 of file vtkBlueObeliskDataParser.h.

◆ CurrentValueType

enum vtkBlueObeliskDataParser::AtomValueType vtkBlueObeliskDataParser::CurrentValueType
protected

◆ CurrentAtomicNumber

int vtkBlueObeliskDataParser::CurrentAtomicNumber
protected

Definition at line 127 of file vtkBlueObeliskDataParser.h.

◆ CurrentSymbol

vtkStdString* vtkBlueObeliskDataParser::CurrentSymbol
protected

Definition at line 128 of file vtkBlueObeliskDataParser.h.

◆ CurrentName

vtkStdString* vtkBlueObeliskDataParser::CurrentName
protected

Definition at line 129 of file vtkBlueObeliskDataParser.h.

◆ CurrentPeriodicTableBlock

vtkStdString* vtkBlueObeliskDataParser::CurrentPeriodicTableBlock
protected

Definition at line 130 of file vtkBlueObeliskDataParser.h.

◆ CurrentElectronicConfiguration

vtkStdString* vtkBlueObeliskDataParser::CurrentElectronicConfiguration
protected

Definition at line 131 of file vtkBlueObeliskDataParser.h.

◆ CurrentFamily

vtkStdString* vtkBlueObeliskDataParser::CurrentFamily
protected

Definition at line 132 of file vtkBlueObeliskDataParser.h.

◆ CurrentMass

float vtkBlueObeliskDataParser::CurrentMass
protected

Definition at line 133 of file vtkBlueObeliskDataParser.h.

◆ CurrentExactMass

float vtkBlueObeliskDataParser::CurrentExactMass
protected

Definition at line 134 of file vtkBlueObeliskDataParser.h.

◆ CurrentIonizationEnergy

float vtkBlueObeliskDataParser::CurrentIonizationEnergy
protected

Definition at line 135 of file vtkBlueObeliskDataParser.h.

◆ CurrentElectronAffinity

float vtkBlueObeliskDataParser::CurrentElectronAffinity
protected

Definition at line 136 of file vtkBlueObeliskDataParser.h.

◆ CurrentPaulingElectronegativity

float vtkBlueObeliskDataParser::CurrentPaulingElectronegativity
protected

Definition at line 137 of file vtkBlueObeliskDataParser.h.

◆ CurrentCovalentRadius

float vtkBlueObeliskDataParser::CurrentCovalentRadius
protected

Definition at line 138 of file vtkBlueObeliskDataParser.h.

◆ CurrentVDWRadius

float vtkBlueObeliskDataParser::CurrentVDWRadius
protected

Definition at line 139 of file vtkBlueObeliskDataParser.h.

◆ CurrentDefaultColor

float vtkBlueObeliskDataParser::CurrentDefaultColor[3]
protected

Definition at line 140 of file vtkBlueObeliskDataParser.h.

◆ CurrentBoilingPoint

float vtkBlueObeliskDataParser::CurrentBoilingPoint
protected

Definition at line 141 of file vtkBlueObeliskDataParser.h.

◆ CurrentMeltingPoint

float vtkBlueObeliskDataParser::CurrentMeltingPoint
protected

Definition at line 142 of file vtkBlueObeliskDataParser.h.

◆ CurrentPeriod

unsigned int vtkBlueObeliskDataParser::CurrentPeriod
protected

Definition at line 143 of file vtkBlueObeliskDataParser.h.

◆ CurrentGroup

unsigned int vtkBlueObeliskDataParser::CurrentGroup
protected

Definition at line 144 of file vtkBlueObeliskDataParser.h.


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