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 Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkBlueObeliskDataParserNewInstance () const
 
virtual void SetTarget (vtkBlueObeliskData *bodr)
 
virtual int Parse ()
 
virtual int Parse (const char *)
 
virtual int Parse (const char *, unsigned int)
 
- Public Member Functions inherited from vtkXMLParser
vtkXMLParserNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetStream (istream *)
 
virtual istream * GetStream ()
 
vtkTypeInt64 TellG ()
 
void SeekG (vtkTypeInt64 position)
 
virtual int InitializeParser ()
 
virtual int ParseChunk (const char *inputString, unsigned int length)
 
virtual int CleanupParser ()
 
virtual void SetFileName (const char *)
 
virtual char * GetFileName ()
 
virtual void SetIgnoreCharacterData (int)
 
virtual int GetIgnoreCharacterData ()
 
virtual void SetEncoding (const char *)
 
virtual char * GetEncoding ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
vtkCommandGetCommand (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 vtkBlueObeliskDataParserSafeDownCast (vtkObjectBase *o)
 
static vtkBlueObeliskDataParserNew ()
 
- Static Public Member Functions inherited from vtkXMLParser
static int IsTypeOf (const char *type)
 
static vtkXMLParserSafeDownCast (vtkObjectBase *o)
 
static vtkXMLParserNew ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

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 ()
 
void StartElement (const char *name, const char **attr)
 
void EndElement (const char *name)
 
void CharacterDataHandler (const char *data, int length)
 
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 ()
 
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 ()
 
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

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
vtkAtomicInt32 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 50 of file vtkBlueObeliskDataParser.h.

Member Typedef Documentation

Definition at line 53 of file vtkBlueObeliskDataParser.h.

Member Enumeration Documentation

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

Definition at line 95 of file vtkBlueObeliskDataParser.h.

Constructor & Destructor Documentation

vtkBlueObeliskDataParser::vtkBlueObeliskDataParser ( )
protected
vtkBlueObeliskDataParser::~vtkBlueObeliskDataParser ( )
protected

Member Function Documentation

static int vtkBlueObeliskDataParser::IsTypeOf ( const char *  type)
static
virtual int 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.

static vtkBlueObeliskDataParser* vtkBlueObeliskDataParser::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkBlueObeliskDataParser::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkXMLParser.

vtkBlueObeliskDataParser* vtkBlueObeliskDataParser::NewInstance ( ) const
static vtkBlueObeliskDataParser* vtkBlueObeliskDataParser::New ( )
static
virtual void vtkBlueObeliskDataParser::SetTarget ( vtkBlueObeliskData bodr)
virtual

Set the target vtkBlueObeliskData object that this parser will populate

virtual int vtkBlueObeliskDataParser::Parse ( )
virtual

Start parsing

Reimplemented from vtkXMLParser.

virtual int vtkBlueObeliskDataParser::Parse ( const char *  )
virtual

These are only implemented to prevent compiler warnings about hidden virtual overloads. This function simply call Parse(); the arguments are ignored.

Reimplemented from vtkXMLParser.

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

These are only implemented to prevent compiler warnings about hidden virtual overloads. This function simply call Parse(); the arguments are ignored.

Reimplemented from vtkXMLParser.

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

Reimplemented from vtkXMLParser.

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

Reimplemented from vtkXMLParser.

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

Reimplemented from vtkXMLParser.

void vtkBlueObeliskDataParser::SetCurrentValue ( const char *  data,
int  length 
)
protected
void vtkBlueObeliskDataParser::SetCurrentValue ( const char *  data)
protected
void vtkBlueObeliskDataParser::NewAtomStarted ( const char **  attr)
protected
void vtkBlueObeliskDataParser::NewAtomFinished ( )
protected
void vtkBlueObeliskDataParser::NewValueStarted ( const char **  attr)
protected
void vtkBlueObeliskDataParser::NewValueFinished ( )
protected

Member Data Documentation

vtkBlueObeliskData* vtkBlueObeliskDataParser::Target
protected

Definition at line 83 of file vtkBlueObeliskDataParser.h.

bool vtkBlueObeliskDataParser::IsProcessingAtom
protected

Definition at line 85 of file vtkBlueObeliskDataParser.h.

bool vtkBlueObeliskDataParser::IsProcessingValue
protected

Definition at line 89 of file vtkBlueObeliskDataParser.h.

std::string vtkBlueObeliskDataParser::CharacterDataValueBuffer
protected

Definition at line 93 of file vtkBlueObeliskDataParser.h.

enum vtkBlueObeliskDataParser::AtomValueType vtkBlueObeliskDataParser::CurrentValueType
protected
int vtkBlueObeliskDataParser::CurrentAtomicNumber
protected

Definition at line 117 of file vtkBlueObeliskDataParser.h.

vtkStdString* vtkBlueObeliskDataParser::CurrentSymbol
protected

Definition at line 118 of file vtkBlueObeliskDataParser.h.

vtkStdString* vtkBlueObeliskDataParser::CurrentName
protected

Definition at line 119 of file vtkBlueObeliskDataParser.h.

vtkStdString* vtkBlueObeliskDataParser::CurrentPeriodicTableBlock
protected

Definition at line 120 of file vtkBlueObeliskDataParser.h.

vtkStdString* vtkBlueObeliskDataParser::CurrentElectronicConfiguration
protected

Definition at line 121 of file vtkBlueObeliskDataParser.h.

vtkStdString* vtkBlueObeliskDataParser::CurrentFamily
protected

Definition at line 122 of file vtkBlueObeliskDataParser.h.

float vtkBlueObeliskDataParser::CurrentMass
protected

Definition at line 123 of file vtkBlueObeliskDataParser.h.

float vtkBlueObeliskDataParser::CurrentExactMass
protected

Definition at line 124 of file vtkBlueObeliskDataParser.h.

float vtkBlueObeliskDataParser::CurrentIonizationEnergy
protected

Definition at line 125 of file vtkBlueObeliskDataParser.h.

float vtkBlueObeliskDataParser::CurrentElectronAffinity
protected

Definition at line 126 of file vtkBlueObeliskDataParser.h.

float vtkBlueObeliskDataParser::CurrentPaulingElectronegativity
protected

Definition at line 127 of file vtkBlueObeliskDataParser.h.

float vtkBlueObeliskDataParser::CurrentCovalentRadius
protected

Definition at line 128 of file vtkBlueObeliskDataParser.h.

float vtkBlueObeliskDataParser::CurrentVDWRadius
protected

Definition at line 129 of file vtkBlueObeliskDataParser.h.

float vtkBlueObeliskDataParser::CurrentDefaultColor[3]
protected

Definition at line 130 of file vtkBlueObeliskDataParser.h.

float vtkBlueObeliskDataParser::CurrentBoilingPoint
protected

Definition at line 131 of file vtkBlueObeliskDataParser.h.

float vtkBlueObeliskDataParser::CurrentMeltingPoint
protected

Definition at line 132 of file vtkBlueObeliskDataParser.h.

unsigned int vtkBlueObeliskDataParser::CurrentPeriod
protected

Definition at line 133 of file vtkBlueObeliskDataParser.h.

unsigned int vtkBlueObeliskDataParser::CurrentGroup
protected

Definition at line 134 of file vtkBlueObeliskDataParser.h.


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