TallyFactory Class Reference

A utility class for creating instances of tallies. More...

#include "pinspec/src/TallyFactory.h"

Public Member Functions
Tally *	createTally (Geometry *geometry, tallyType tally_type, char *tally_name=(char *)"")
	Method to create a tally for some tally type within the geometry. More...
Tally *	createTally (Region *region, tallyType tally_type, char *tally_name=(char *)"")
	Method to create a tally for some tally type within a region. More...
Tally *	createTally (Material *material, tallyType tally_type, char *tally_name=(char *)"")
	Method to create a tally for some tally type within a material. More...
Tally *	createTally (Isotope *isotope, tallyType tally_type, char *tally_name=(char *)"")
	Method to create a tally for some tally type within an isotope. More...

Static Public Member Functions
static TallyFactory *	Get ()
	Returns a static instance of the TallyFactory class. More...

Private Member Functions
	TallyFactory ()
	TallyFactory constructor.
TallyFactory &	operator= (const TallyFactory &)
	Assignment operator for static referencing of the TallyFactory. More...

Detailed Description

A utility class for creating instances of tallies.

Member Function Documentation

Tally * TallyFactory::createTally	(	Geometry *	geometry,
		tallyType	tally_type,
		char *	tally_name = (char*)""
	)

Method to create a tally for some tally type within the geometry.

Parameters

geometry	a pointer to the geometry within which to tally
tally_type	the type of tally (ie, FLUX, CAPTURE_RATE, etc.)
tally_name	a character array for the name of the tally

Returns

a pointer to the newly created tally

Tally * TallyFactory::createTally	(	Region *	region,
		tallyType	tally_type,
		char *	tally_name = (char*)""
	)

Method to create a tally for some tally type within a region.

Parameters

region	a pointer to the region within which to tally
tally_type	the type of tally (ie, FLUX, CAPTURE_RATE, etc.)
tally_name	a character array for the name of the tally

Returns

a pointer to the newly created tally

Tally * TallyFactory::createTally	(	Material *	material,
		tallyType	tally_type,
		char *	tally_name = (char*)""
	)

Method to create a tally for some tally type within a material.

Parameters

material	a pointer to the material within which to tally
tally_type	the type of tally (ie, FLUX, CAPTURE_RATE, etc.)
tally_name	a character array for the name of the tally

Returns

a pointer to the newly created tally

Tally * TallyFactory::createTally	(	Isotope *	isotope,
		tallyType	tally_type,
		char *	tally_name = (char*)""
	)

Method to create a tally for some tally type within an isotope.

Parameters

isotope	a pointer to the isotope to tally
tally_type	the type of tally (ie, FLUX, CAPTURE_RATE, etc.)
tally_name	a character array for the name of the tally

Returns

a pointer to the newly created tally

static TallyFactory* TallyFactory::Get ( )

inlinestatic

Returns a static instance of the TallyFactory class.

Returns

a pointer to the static TallyFactory class

TallyFactory& TallyFactory::operator= ( const TallyFactory &  )

inlineprivate

Assignment operator for static referencing of the TallyFactory.

Parameters

&	the TallyFactory static class object

Returns

a pointer to the TallyFactory static class object

---

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

• pinspec/src/TallyFactory.h
• pinspec/src/TallyFactory.cpp