KKB::Atom Class Reference

Base class of all other classes that are meant to be managed by 'KKBase'. More...

#include <Atom.h>

Inheritance diagram for KKB::Atom:

Public Types
typedef AtomPtr(*	AtomCreator) (XmlStream &i)
typedef Atom *	AtomPtr

Public Member Functions
	Atom ()
virtual	~Atom ()
virtual const char *	ClassName () const =0
virtual Atom *	Duplicate () const =0
virtual void	ReadXML (XmlStream &s, XmlTagConstPtr tag, VolConstBool &cancelFlag, RunLog &log)=0
virtual void	WriteXML (const KKStr &varName, std::ostream &o) const =0

Detailed Description

Base class of all other classes that are meant to be managed by 'KKBase'.

'Atom' will have a few important virtual methods that all derived classes will be required to implement. This will allow for the smooth functioning of XML file reading and writing. Ex: 'WriteXML', this method is to write a XML version of the derived class to a output stream. A registered BuildFromXML function will be able to create a new instance of the derived class.

Create on 2010-02-22; primary purpose is to help generate more ideas along these lines.

Definition at line 49 of file Atom.h.

Member Typedef Documentation

typedef AtomPtr(* KKB::Atom::AtomCreator) (XmlStream &i)

Definition at line 54 of file Atom.h.

typedef Atom* KKB::Atom::AtomPtr

Definition at line 52 of file Atom.h.

Constructor & Destructor Documentation

Atom::Atom

(

)

Definition at line 25 of file Atom.cpp.

{
}

Atom::~Atom ( )

virtual

Definition at line 29 of file Atom.cpp.

{
}

Member Function Documentation

virtual const char* KKB::Atom::ClassName ( ) const

pure virtual

Implemented in KKB::BitString.

virtual Atom* KKB::Atom::Duplicate ( ) const

pure virtual

Implemented in KKB::BitString.

virtual void KKB::Atom::ReadXML ( XmlStream &  s, XmlTagConstPtr  tag, VolConstBool &  cancelFlag, RunLog &  log  )

pure virtual

Implemented in KKB::BitString.

virtual void KKB::Atom::WriteXML ( const KKStr &  varName, std::ostream &  o  ) const

pure virtual

Implemented in KKB::BitString.

---

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

• C:/Users/Kurt/GitHub/KSquareLibraries/KKBase/Atom.h
• C:/Users/Kurt/GitHub/KSquareLibraries/KKBase/Atom.cpp