ChildInfo Class Reference

#include <ChildInfo.h>

Inheritance diagram for ChildInfo:

Collaboration diagram for ChildInfo:

Public Member Functions
	~ChildInfo ()
	destructor
	ChildInfo ()
	default constructor
	ChildInfo (const ChildInfo &X)
	copy constructor
	ChildInfo (const int childGridIndex, const Box &childBox)
	main constructor that takes two arguments
ChildInfo &	operator= (const ChildInfo &X)
	assignment operator
virtual aString	getClassName (void)
	return the className
virtual Integer	get (const GenericDataBase &db, const aString &name)
	get() function to read from a database .. not currently implemented
virtual Integer	put (const GenericDataBase &db, const aString &name) const
	put() function to write to a database .. not currently implemented
virtual void	consistencyCheck (void) const
	this function performs some error checking on the ChildInfo object
const Box &	getChildBox (void) const
	get the box representing the intersection in the child's index space
void	setChildBox (const Box &box)
	set the box representing the intersection in the child's index space
Public Member Functions inherited from ParentChildSiblingBase
	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
const int	getGridIndex (void) const
	access functions for the grid index
void	setGridIndex (const int index)

Friends
ostream &	operator<< (ostream &s, const ChildInfo &childInfo)
	friend operator<< to write to the output stream

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

Constructor & Destructor Documentation

ChildInfo::~ChildInfo

(

)

destructor

destructor, nothing is done

ChildInfo::ChildInfo

(

)

default constructor

default constructor, sets className only

ChildInfo::ChildInfo

(

const ChildInfo &

X

)

copy constructor

ChildInfo::ChildInfo	(	const int	childGridIndex,
		const Box &	cBox
	)

main constructor that takes two arguments

Parameters

childGridIndex,:	index of the child grid in the adaptive grid collection
cBox	: box representing index space on child grid lying over the MappedGrid to which this ChildInfo object belongs

Member Function Documentation

void ChildInfo::consistencyCheck ( void  ) const

virtual

this function performs some error checking on the ChildInfo object

Reimplemented from ParentChildSiblingBase.

References ParentChildSiblingBase::consistencyCheck().

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

virtual

get() function to read from a database .. not currently implemented

Reimplemented from ParentChildSiblingBase.

const Box& ChildInfo::getChildBox ( void  ) const

inline

get the box representing the intersection in the child's index space

Referenced by operator=().

virtual aString ChildInfo::getClassName ( void  )

inlinevirtual

return the className

Reimplemented from ParentChildSiblingBase.

ChildInfo & ChildInfo::operator=

(

const ChildInfo &

X

)

assignment operator

the assignment operator

References assert, getChildBox(), and ParentChildSiblingBase::operator=().

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

virtual

put() function to write to a database .. not currently implemented

Reimplemented from ParentChildSiblingBase.

void ChildInfo::setChildBox ( const Box &  box )

inline

set the box representing the intersection in the child's index space

References assert.

Friends And Related Function Documentation

ostream& operator<< ( ostream &  s, const ChildInfo &  childInfo  )

friend

friend operator<< to write to the output stream

Parameters

s	: output stream to write to
childInfo	: ChildInfo object whoe details are to be written

---

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

• ChildInfo.h
• ChildInfo.C