ParentChildSiblingBase Class Reference

#include <ParentChildSiblingBase.h>

Inheritance diagram for ParentChildSiblingBase:

Public Member Functions
	ParentChildSiblingBase ()
	default constructor
	ParentChildSiblingBase (const ParentChildSiblingBase &X, const CopyType ct=DEEP)
	copy constructor
	ParentChildSiblingBase (const int)
	main constructor for this class
ParentChildSiblingBase &	operator= (const ParentChildSiblingBase &X)
	assignment operator
virtual	~ParentChildSiblingBase ()
	virtual destructor
virtual aString	getClassName (void)
	return the className
virtual Integer	get (const GenericDataBase &db, const aString &name)
	read from a database
virtual Integer	put (const GenericDataBase &db, const aString &name) const
	write to a database
virtual void	consistencyCheck (void) const
	performs error and consistency checks
const int	getGridIndex (void) const
	access functions for the grid index
void	setGridIndex (const int index)

Protected Attributes
int	gridIndex
	index into the adaptive grid collection
aString	className
	the name of this class, i.e. "ParentChildSiblingBase" is stored in this variable

Friends
ostream &	operator<< (ostream &s, const ParentChildSiblingBase &pcsBase)
	writes a descriptio of pcsBase to the output stream s

Constructor & Destructor Documentation

ParentChildSiblingBase::ParentChildSiblingBase

(

)

default constructor

References className, and gridIndex.

ParentChildSiblingBase::ParentChildSiblingBase	(	const ParentChildSiblingBase &	X,
		const CopyType	ct = DEEP
	)

copy constructor

References className, and NOCOPY.

ParentChildSiblingBase::ParentChildSiblingBase

(

const int

index

)

main constructor for this class

ParentChildSiblingBase::~ParentChildSiblingBase ( )

virtual

virtual destructor

Member Function Documentation

void ParentChildSiblingBase::consistencyCheck ( void  ) const

virtual

performs error and consistency checks

Reimplemented in SiblingInfo, ChildInfo, and ParentInfo.

Referenced by ChildInfo::consistencyCheck(), ParentInfo::consistencyCheck(), and SiblingInfo::consistencyCheck().

Integer ParentChildSiblingBase::get ( const GenericDataBase &  db, const aString &  name  )

virtual

read from a database

Reimplemented in SiblingInfo, ChildInfo, and ParentInfo.

References className.

virtual aString ParentChildSiblingBase::getClassName ( void  )

inlinevirtual

return the className

Reimplemented in SiblingInfo, ChildInfo, and ParentInfo.

References className.

const int ParentChildSiblingBase::getGridIndex ( void  ) const

inline

access functions for the grid index

References gridIndex.

Referenced by operator<<(), and operator=().

ParentChildSiblingBase & ParentChildSiblingBase::operator=

(

const ParentChildSiblingBase &

X

)

assignment operator

References getGridIndex(), and gridIndex.

Referenced by ParentInfo::operator=(), ChildInfo::operator=(), and SiblingInfo::operator=().

Integer ParentChildSiblingBase::put ( const GenericDataBase &  db, const aString &  name  ) const

virtual

write to a database

Reimplemented in SiblingInfo, ChildInfo, and ParentInfo.

References className.

void ParentChildSiblingBase::setGridIndex ( const int  index )

inline

References gridIndex.

Friends And Related Function Documentation

ostream& operator<< ( ostream &  s, const ParentChildSiblingBase &  pcsBase  )

friend

writes a descriptio of pcsBase to the output stream s

Member Data Documentation

aString ParentChildSiblingBase::className

protected

the name of this class, i.e. "ParentChildSiblingBase" is stored in this variable

Referenced by get(), getClassName(), operator<<(), ParentChildSiblingBase(), and put().

int ParentChildSiblingBase::gridIndex

protected

index into the adaptive grid collection

Referenced by getGridIndex(), operator=(), ParentChildSiblingBase(), and setGridIndex().

---

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

• ParentChildSiblingBase.h
• ParentChildSiblingBase.C