This class stores a tree of input file sections. More...

Inheritance diagram for IOTreeClass:

Collaboration diagram for IOTreeClass:

Public Member Functions
void	MarkModified ()

virtual void	PrintTree ()=0

virtual void	PrintTree (int numIndent)=0

virtual IOFileType	GetFileType ()=0

void	InsertSection (IOTreeClass *newSec)

bool	FindSection (std::string name, IOTreeClass *&sectionPtr, int num=0)
	FindSection locates a subsection with the given name within the section in contains and returns it in the pointer, sectionPtr, which is passed a reference. More...

int	CountSections (std::string name)
	Returns the number of subsections with the given name within the present section. More...

int	CountVars ()

template<class T >
bool	ReadVar (std::string name, T &var)

IOVarBase *	GetVarPtr (std::string name)

IOVarBase *	GetVarPtr (int num)

virtual IOTreeClass *	NewSection (std::string name)=0
	Write me! More...

virtual bool	OpenFile (std::string fileName, std::string mySectionName, IOTreeClass *parent)=0

virtual bool	NewFile (std::string fileName, std::string mySectionName, IOTreeClass *parent)=0

virtual void	IncludeSection (IOTreeClass *)=0
	Inserts a new Include directive in the present section. More...

virtual void	CloseFile ()=0

virtual void	FlushFile ()=0

template<typename T >
bool	WriteVar (std::string name, T val)
	These create a new variable with the given name and value: More...

template<typename T , int LEN>
bool	WriteVar (std::string name, const TinyVector< T, LEN > &val)

template<typename T , int RANK>
bool	WriteVar (std::string name, const Array< T, RANK > &val)

template<typename T , int RANK, int LEN>
bool	WriteVar (std::string name, const Array< TinyVector< T, LEN >, RANK > &val)

template<class T >
bool	AppendVar (std::string name, T val)
	Append a value to a variable of dimension of 1 higher than val. More...

void	SetUnderscores (bool use)

	IOTreeClass ()

virtual	~IOTreeClass ()

template<>
bool	WriteVar (std::string name, const char *val)

Public Attributes
std::list< IOVarBase * >	VarList

std::list< IOTreeClass * >	SectionList

int	MyNumber
	This is used to ensure proper ordering of sections in the HDF version in which there is no guarantee that the sections will come out of the file in the same order you put them in. More...

int	CurrSecNum

IOTreeClass *	Parent

std::string	FileName
	This is the empty std::string unless I'm the root node of some file. More...

std::string	Name

Protected Attributes
bool	IsModified

bool	UseUnderscores

Detailed Description

This class stores a tree of input file sections.

Each member of the tree contains a list of tree nodes below it and a list of variables contained in the present node.

Definition at line 33 of file IOBase.h.

Constructor & Destructor Documentation

◆ IOTreeClass()

IOTreeClass ( )

inline

Definition at line 145 of file IOBase.h.

                        : UseUnderscores(false), FileName("")
   {
     // Nothing for now
   }

◆ ~IOTreeClass()

virtual ~IOTreeClass ( )

inlinevirtual

Definition at line 149 of file IOBase.h.

149 {}

Member Function Documentation

◆ AppendVar()

bool AppendVar	(	std::string	name,
		T	val
	)

inline

Append a value to a variable of dimension of 1 higher than val.

i.e. Add a double to an blitz::Array<double,1> or add blitz::Array<double,1> to an blitz::Array<double,2>, etc.

Definition at line 162 of file IOBase.h.

References IOVarBase::GetExtent(), IOTreeClass::GetVarPtr(), IOTreeClass::MarkModified(), IOVarBase::Resize(), and IOVarBase::Write().

Referenced by IOSectionClass::AppendVar().

 {
   IOVarBase* var = GetVarPtr(name);
   if (var == NULL)
     return false;
   MarkModified();
   int dim0 = var->GetExtent(0);
   var->Resize(dim0 + 1);
   return var->Write(val, 0);
   //    return var->Append(val);
 }

◆ CloseFile()

virtual void CloseFile ( )

pure virtual

Implemented in IOTreeASCIIClass.

◆ CountSections()

int CountSections ( std::string name )

inline

Returns the number of subsections with the given name within the present section.

Definition at line 177 of file IOBase.h.

References IOTreeClass::SectionList.

Referenced by IOSectionClass::CountSections().

 {
   std::list<IOTreeClass*>::iterator sectionIter;
   sectionIter     = SectionList.begin();
   int numSections = 0;
   while (sectionIter != SectionList.end())
   {
     if ((name == (*sectionIter)->Name) || (name == ""))
     {
       numSections++;
     }
     sectionIter++;
   }
   return numSections;
 }

◆ CountVars()

int CountVars ( )

inline

Definition at line 193 of file IOBase.h.

References IOTreeClass::VarList.

Referenced by IOSectionClass::CountVars().

 {
   std::list<IOVarBase*>::iterator varIter;
   varIter     = VarList.begin();
   int numVars = 0;
   while (varIter != VarList.end())
   {
     numVars++;
     varIter++;
   }
   return numVars;
 }

◆ FindSection()

bool FindSection	(	std::string	name,
		IOTreeClass *&	sectionPtr,
		int	num = `0`
	)

inline

FindSection locates a subsection with the given name within the section in contains and returns it in the pointer, sectionPtr, which is passed a reference.

Returns true if the section is found. The final parameter, which default value "true", optionally resets the section iterator to the beginning of the section. Thus, one may control whether or not order is significant.

Definition at line 214 of file IOBase.h.

References IOTreeClass::SectionList.

 {
   std::list<IOTreeClass*>::iterator Iter = SectionList.begin();
   int counter                            = 0;
   while (counter <= num && Iter != SectionList.end())
   {
     if ((*Iter)->Name == name)
     {
       counter++;
     }
     if (counter <= num)
       Iter++;
   }
   bool found = Iter != SectionList.end();
   if (found)
   {
     sectionPtr = *Iter;
   }
   return (found);
 }

◆ FlushFile()

virtual void FlushFile ( )

pure virtual

Implemented in IOTreeASCIIClass.

◆ GetFileType()

virtual IOFileType GetFileType ( )

pure virtual

Implemented in IOTreeASCIIClass.

Referenced by IOTreeClass::WriteVar().

◆ GetVarPtr() [1/2]

IOVarBase* GetVarPtr ( std::string name )

inline

Definition at line 81 of file IOBase.h.

References IOTreeClass::MarkModified(), and IOTreeClass::VarList.

Referenced by IOTreeClass::AppendVar(), and IOSectionClass::GetVarPtr().

   {
     std::list<IOVarBase*>::iterator iter = VarList.begin();
     while ((iter != VarList.end()) && ((*iter)->GetName() != name))
     {
       iter++;
     }
     if (iter == VarList.end())
       return NULL;
     else
     {
       MarkModified(); // If we're getting the pointer, we're probably
       // gonna modify the variable.
       return *iter;
     }
   }

◆ GetVarPtr() [2/2]

IOVarBase* GetVarPtr ( int num )

inline

Definition at line 97 of file IOBase.h.

References IOTreeClass::MarkModified(), and IOTreeClass::VarList.

   {
     std::list<IOVarBase*>::iterator iter = VarList.begin();
     int i                                = 0;
     while ((iter != VarList.end()) && (i != num))
     {
       iter++;
       i++;
     }
     if (iter == VarList.end())
       return NULL;
     else
     {
       MarkModified(); // If we're getting the pointer, we're probably
       // gonna modify the variable.
       return *iter;
     }
   }

◆ IncludeSection()

virtual void IncludeSection ( IOTreeClass * )

pure virtual

Inserts a new Include directive in the present section.

Implemented in IOTreeASCIIClass.

◆ InsertSection()

void InsertSection ( IOTreeClass * newSec )

inline

Definition at line 236 of file IOBase.h.

References IOTreeClass::MyNumber, and IOTreeClass::SectionList.

 {
   std::list<IOTreeClass*>::iterator iter;
 
   if (SectionList.empty())
     SectionList.push_back(newSec);
   else
   {
     iter = SectionList.begin();
     while ((iter != SectionList.end()) && ((*iter)->MyNumber < newSec->MyNumber))
       iter++;
     if (iter != SectionList.end())
       SectionList.insert(iter, newSec);
     else
       SectionList.push_back(newSec);
   }
 }

◆ MarkModified()

void MarkModified ( )

inline

Definition at line 152 of file IOBase.h.

References IOTreeClass::FileName, IOTreeClass::IsModified, IOTreeClass::MarkModified(), and IOTreeClass::Parent.

Referenced by IOTreeClass::AppendVar(), IOTreeClass::GetVarPtr(), and IOTreeClass::MarkModified().

 {
   if (FileName != "")
     IsModified = true;
   else if (Parent != NULL)
     Parent->MarkModified();
 }

◆ NewFile()

virtual bool NewFile	(	std::string	fileName,
		std::string	mySectionName,
		IOTreeClass *	parent
	)

pure virtual

Implemented in IOTreeASCIIClass.

◆ NewSection()

virtual IOTreeClass* NewSection ( std::string name )

pure virtual

Write me!

Implemented in IOTreeASCIIClass.

Referenced by IOSectionClass::NewSection().

◆ OpenFile()

virtual bool OpenFile	(	std::string	fileName,
		std::string	mySectionName,
		IOTreeClass *	parent
	)

pure virtual

Implemented in IOTreeASCIIClass.

◆ PrintTree() [1/2]

virtual void PrintTree ( )

pure virtual

Implemented in IOTreeASCIIClass.

Referenced by IOSectionClass::PrintTree().

◆ PrintTree() [2/2]

virtual void PrintTree ( int numIndent )

pure virtual

Implemented in IOTreeASCIIClass.

◆ ReadVar()

bool ReadVar	(	std::string	name,
		T &	var
	)

inline

Definition at line 63 of file IOBase.h.

References IOTreeClass::Parent, IOTreeClass::ReadVar(), and IOTreeClass::VarList.

Referenced by IOTreeClass::ReadVar(), and IOSectionClass::ReadVar().

   {
     bool readVarSuccess;
     std::list<IOVarBase*>::iterator varIter = VarList.begin();
     while ((varIter != VarList.end()) && ((*varIter)->GetName() != name))
       varIter++;
 
     bool found = varIter != VarList.end();
     if (found)
       readVarSuccess = (*varIter)->Read(var);
     else if (Parent != NULL)
       readVarSuccess = Parent->ReadVar(name, var);
     else
       return false;
 
     return readVarSuccess;
   }

◆ SetUnderscores()

void SetUnderscores ( bool use )

inline

Definition at line 143 of file IOBase.h.

References IOTreeClass::UseUnderscores.

Referenced by IOSectionClass::SetUnderscores().

143 { UseUnderscores = use; }

IO::IOTreeClass::UseUnderscores

bool UseUnderscores

Definition: IOBase.h:38

◆ WriteVar() [1/5]

bool WriteVar	(	std::string	name,
		const char *	val
	)

inline

Definition at line 32 of file IO.h.

References IOTreeClass::WriteVar().

 {
   return WriteVar(name, std::string(val));
 }

◆ WriteVar() [2/5]

bool WriteVar	(	std::string	name,
		T	val
	)

These create a new variable with the given name and value:

Definition at line 37 of file IO.h.

References IO::ASCII_TYPE, and IOTreeClass::GetFileType().

Referenced by IOTreeClass::WriteVar(), and IOSectionClass::WriteVar().

 {
   if (GetFileType() == ASCII_TYPE)
   {
     throw std::logic_error{"this case is unimplement for rank 0"};
 //    VarList.push_back(new IOVarASCII<T, 0>(name, val));
   }
   else
   {
     std::cerr << "Unknown file type in WriteVar.\n";
     abort();
   }
   return true;
 }

◆ WriteVar() [3/5]

bool WriteVar	(	std::string	name,
		const TinyVector< T, LEN > &	val
	)

Definition at line 53 of file IO.h.

References IOTreeClass::WriteVar().

 {
   Array<T, 1> aVal(LEN);
   for (int i = 0; i < LEN; i++)
     aVal(i) = val[i];
   WriteVar(name, aVal);
   return true;
 }

◆ WriteVar() [4/5]

bool WriteVar	(	std::string	name,
		const Array< T, RANK > &	val
	)

Definition at line 64 of file IO.h.

References IO::ASCII_TYPE, IOTreeClass::GetFileType(), and IOTreeClass::VarList.

 {
   if (GetFileType() == ASCII_TYPE)
   {
     VarList.push_back(new IOVarASCII<T, RANK>(name, val));
   }
   else
   {
     std::cerr << "Unknown file type in WriteVar.\n";
     abort();
   }
   return true;
 }

◆ WriteVar() [5/5]

bool WriteVar	(	std::string	name,
		const Array< TinyVector< T, LEN >, RANK > &	val
	)

Definition at line 79 of file IO.h.

References neverDeleteData, and IOTreeClass::WriteVar().

 {
   TinyVector<int, RANK + 1> shape;
   for (int dim = 0; dim < RANK; dim++)
     shape[dim] = val.extent(dim);
   shape[RANK] = LEN;
 
   Array<T, RANK + 1> aval((T*)&(val(0)[0]), shape, neverDeleteData);
   return WriteVar(name, aval);
 }

Member Data Documentation

◆ CurrSecNum

int CurrSecNum

Definition at line 48 of file IOBase.h.

◆ FileName

std::string FileName

This is the empty std::string unless I'm the root node of some file.

Definition at line 55 of file IOBase.h.

Referenced by IOTreeClass::MarkModified().

◆ IsModified

bool IsModified

protected

Definition at line 37 of file IOBase.h.

Referenced by IOTreeASCIIClass::IOTreeASCIIClass(), and IOTreeClass::MarkModified().

◆ MyNumber

int MyNumber

This is used to ensure proper ordering of sections in the HDF version in which there is no guarantee that the sections will come out of the file in the same order you put them in.

Definition at line 48 of file IOBase.h.

Referenced by IOTreeClass::InsertSection().

◆ Name

std::string Name

Definition at line 56 of file IOBase.h.

Referenced by IOSectionClass::GetName().

◆ Parent

IOTreeClass* Parent

Definition at line 53 of file IOBase.h.

Referenced by IOTreeClass::MarkModified(), and IOTreeClass::ReadVar().

◆ SectionList

std::list<IOTreeClass*> SectionList

Definition at line 42 of file IOBase.h.

Referenced by IOTreeClass::CountSections(), IOTreeClass::FindSection(), and IOTreeClass::InsertSection().

◆ UseUnderscores

bool UseUnderscores

protected

Definition at line 38 of file IOBase.h.

Referenced by IOTreeClass::SetUnderscores().

◆ VarList

std::list<IOVarBase*> VarList

Definition at line 41 of file IOBase.h.

Referenced by IOTreeClass::CountVars(), IOTreeClass::GetVarPtr(), IOTreeClass::ReadVar(), and IOTreeClass::WriteVar().

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

/home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/QMCTools/ppconvert/src/common/IOBase.h
/home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/QMCTools/ppconvert/src/common/IO.h

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IOTreeClass()

◆ ~IOTreeClass()

Member Function Documentation

◆ AppendVar()

◆ CloseFile()

◆ CountSections()

◆ CountVars()

◆ FindSection()

◆ FlushFile()

◆ GetFileType()

◆ GetVarPtr() [1/2]

◆ GetVarPtr() [2/2]

◆ IncludeSection()

◆ InsertSection()

◆ MarkModified()

◆ NewFile()

◆ NewSection()

◆ OpenFile()

◆ PrintTree() [1/2]

◆ PrintTree() [2/2]

◆ ReadVar()

◆ SetUnderscores()

◆ WriteVar() [1/5]

◆ WriteVar() [2/5]

◆ WriteVar() [3/5]

◆ WriteVar() [4/5]

◆ WriteVar() [5/5]

Member Data Documentation

◆ CurrSecNum

◆ FileName

◆ IsModified

◆ MyNumber

◆ Name

◆ Parent

◆ SectionList

◆ UseUnderscores

◆ VarList