The abstract base class to material factory. More...

#include <VMaterialFactory.h>

Inheritance diagram for BaseVGM::VMaterialFactory:

Public Member Functions
	VMaterialFactory (const std::string &name)

virtual	~VMaterialFactory ()

virtual std::string	Name () const
	Return the name of this factory.

virtual const VGM::IsotopeStore &	Isotopes () const
	Return the store of isotopes.

virtual const VGM::ElementStore &	Elements () const
	Return the store of elements.

virtual const VGM::MaterialStore &	Materials () const
	Return the store of materials.

virtual const VGM::MediumStore &	Media () const
	Return the store of media.

virtual const VGM::IIsotope *	Isotope (const std::string &name) const
	Return isotope specified by name.

virtual const VGM::IElement *	Element (const std::string &name) const
	Return element specified by name.

virtual const VGM::IMaterial *	Material (const std::string &name) const
	Return material specified by name.

virtual const VGM::IMedium *	Medium (const std::string &name) const
	Return medium specified by name.

virtual bool	Export (VGM::IMaterialFactory *factory) const
	Export materials to the specified material factory.

virtual void	PrintIsotopes () const
	Print all isotopes.

virtual void	PrintElements () const
	Print all elements.

virtual void	PrintMaterials () const
	Print all materials.

virtual void	PrintMedia () const
	Print all media.

virtual void	SetDebug (int debug)
	Set the debug level.

virtual int	Debug () const
	Return the debug level.

Public Member Functions inherited from VGM::IMaterialFactory
virtual	~IMaterialFactory ()

virtual IIsotope *	CreateIsotope (const std::string &name, int z, int n, double a=0.)=0
	Create a chemical isotope.

virtual IElement *	CreateElement (const std::string &name, const std::string &symbol, double z, double a)=0
	Create a chemical element.

virtual IElement *	CreateElement (const std::string &name, const std::string &symbol, const VGM::IsotopeVector &isotopes, const VGM::RelAbundanceVector &relAbundances)=0
	Create a chemical element.

virtual IElement *	CreateElement (int z, bool isotopes=true)=0
	Create a chemical element.

virtual IMaterial *	CreateMaterial (const std::string &name, double density, VGM::IElement *element, double radlen, double intlen)=0
	Create a material.

virtual IMaterial *	CreateMaterial (const std::string &name, double density, VGM::IElement *element, double radlen, double intlen, VGM::MaterialState state, double temperature, double pressure)=0
	Create a compound material.

virtual IMaterial *	CreateMaterial (const std::string &name, double density, const VGM::ElementVector &elements, const VGM::MassFractionVector &fractions)=0
	Create a compound material.

virtual IMaterial *	CreateMaterial (const std::string &name, double density, const VGM::ElementVector &elements, const VGM::MassFractionVector &fractions, VGM::MaterialState state, double temperature, double pressure)=0
	Create a compound material.

virtual IMaterial *	CreateMaterial (const std::string &name, double density, const VGM::ElementVector &elements, const VGM::AtomCountVector &atomCounts)=0
	Create a compound material.

virtual IMaterial *	CreateMaterial (const std::string &name, double density, const VGM::ElementVector &elements, const VGM::AtomCountVector &atomCounts, VGM::MaterialState state, double temperature, double pressure)=0
	Create a compound material.

virtual IMedium *	CreateMedium (const std::string &name, int mediumId, VGM::IMaterial material, int nofParameters, double parameters)=0
	Create a tracking medium.

virtual bool	Import ()=0
	Import native materials.

Protected Member Functions
	VMaterialFactory ()

	VMaterialFactory (const VMaterialFactory &rhs)

virtual VGM::IsotopeStore &	IsotopeStore ()

virtual VGM::ElementStore &	ElementStore ()

virtual VGM::MaterialStore &	MaterialStore ()

virtual VGM::MediumStore &	MediumStore ()

Detailed Description

The abstract base class to material factory.

It owns the material stores and implements the export to other factory.

Author: Ivana Hrivnacova; IPN Orsay

Definition at line 32 of file VMaterialFactory.h.

Constructor & Destructor Documentation

◆ VMaterialFactory() [1/3]

BaseVGM::VMaterialFactory::VMaterialFactory ( const std::string & name )

Standard constructor

Definition at line 30 of file VMaterialFactory.cxx.

◆ ~VMaterialFactory()

BaseVGM::VMaterialFactory::~VMaterialFactory ( )

virtual

Definition at line 56 of file VMaterialFactory.cxx.

◆ VMaterialFactory() [2/3]

BaseVGM::VMaterialFactory::VMaterialFactory ( )

protected

Protected default constructor

Definition at line 43 of file VMaterialFactory.cxx.

◆ VMaterialFactory() [3/3]

BaseVGM::VMaterialFactory::VMaterialFactory ( const VMaterialFactory & rhs )

protected

Protected copy constructor

Definition at line 49 of file VMaterialFactory.cxx.

Member Function Documentation

◆ Name()

std::string BaseVGM::VMaterialFactory::Name ( ) const

inlinevirtual

Return the name of this factory.

Implements VGM::IMaterialFactory.

Definition at line 119 of file VMaterialFactory.h.

◆ Isotopes()

const VGM::IsotopeStore & BaseVGM::VMaterialFactory::Isotopes ( ) const

inlinevirtual

Return the store of isotopes.

Implements VGM::IMaterialFactory.

Definition at line 121 of file VMaterialFactory.h.

◆ Elements()

const VGM::ElementStore & BaseVGM::VMaterialFactory::Elements ( ) const

inlinevirtual

Return the store of elements.

Implements VGM::IMaterialFactory.

Definition at line 126 of file VMaterialFactory.h.

◆ Materials()

const VGM::MaterialStore & BaseVGM::VMaterialFactory::Materials ( ) const

inlinevirtual

Return the store of materials.

Implements VGM::IMaterialFactory.

Definition at line 131 of file VMaterialFactory.h.

◆ Media()

const VGM::MediumStore & BaseVGM::VMaterialFactory::Media ( ) const

inlinevirtual

Return the store of media.

Implements VGM::IMaterialFactory.

Definition at line 136 of file VMaterialFactory.h.

◆ Isotope()

const VGM::IIsotope * BaseVGM::VMaterialFactory::Isotope ( const std::string & name ) const

virtual

Return isotope specified by name.

Finds the VGM isotope specified by name; returns 0 if isotope is not found.

Implements VGM::IMaterialFactory.

Definition at line 354 of file VMaterialFactory.cxx.

◆ Element()

const VGM::IElement * BaseVGM::VMaterialFactory::Element ( const std::string & name ) const

virtual

Return element specified by name.

Finds the VGM element specified by name; returns 0 if element is not found.

Implements VGM::IMaterialFactory.

Definition at line 369 of file VMaterialFactory.cxx.

◆ Material()

const VGM::IMaterial * BaseVGM::VMaterialFactory::Material ( const std::string & name ) const

virtual

Return material specified by name.

Finds the VGM material specified by name; returns 0 if material is not found.

Implements VGM::IMaterialFactory.

Definition at line 384 of file VMaterialFactory.cxx.

◆ Medium()

const VGM::IMedium * BaseVGM::VMaterialFactory::Medium ( const std::string & name ) const

virtual

Return medium specified by name.

Finds the VGM medium specified by name; returns 0 if medium is not found.

Implements VGM::IMaterialFactory.

Definition at line 399 of file VMaterialFactory.cxx.

◆ Export()

bool BaseVGM::VMaterialFactory::Export ( VGM::IMaterialFactory * factory ) const

virtual

Export materials to the specified material factory.

Export the whole material and media store to the given factory.

Implements VGM::IMaterialFactory.

Definition at line 414 of file VMaterialFactory.cxx.

◆ PrintIsotopes()

void BaseVGM::VMaterialFactory::PrintIsotopes ( ) const

virtual

Print all isotopes.

Implements VGM::IMaterialFactory.

Definition at line 430 of file VMaterialFactory.cxx.

◆ PrintElements()

void BaseVGM::VMaterialFactory::PrintElements ( ) const

virtual

Print all elements.

Implements VGM::IMaterialFactory.

Definition at line 444 of file VMaterialFactory.cxx.

◆ PrintMaterials()

void BaseVGM::VMaterialFactory::PrintMaterials ( ) const

virtual

Print all materials.

Implements VGM::IMaterialFactory.

Definition at line 458 of file VMaterialFactory.cxx.

◆ PrintMedia()

void BaseVGM::VMaterialFactory::PrintMedia ( ) const

virtual

Print all media.

Print all media

Implements VGM::IMaterialFactory.

Definition at line 472 of file VMaterialFactory.cxx.

◆ SetDebug()

void BaseVGM::VMaterialFactory::SetDebug ( int debug )

inlinevirtual

Set the debug level.

Implements VGM::IMaterialFactory.

Definition at line 165 of file VMaterialFactory.h.

◆ Debug()

int BaseVGM::VMaterialFactory::Debug ( ) const

inlinevirtual

Return the debug level.

Implements VGM::IMaterialFactory.

Definition at line 167 of file VMaterialFactory.h.

◆ IsotopeStore()

VGM::IsotopeStore & BaseVGM::VMaterialFactory::IsotopeStore ( )

inlineprotectedvirtual

Return the store of isotopes (non const)

Definition at line 141 of file VMaterialFactory.h.

◆ ElementStore()

VGM::ElementStore & BaseVGM::VMaterialFactory::ElementStore ( )

inlineprotectedvirtual

Return the store of elements (non const)

Definition at line 147 of file VMaterialFactory.h.

◆ MaterialStore()

VGM::MaterialStore & BaseVGM::VMaterialFactory::MaterialStore ( )

inlineprotectedvirtual

Return the store of materials (non const)

Definition at line 153 of file VMaterialFactory.h.

◆ MediumStore()

VGM::MediumStore & BaseVGM::VMaterialFactory::MediumStore ( )

inlineprotectedvirtual

Return the store of media (non const)

Definition at line 159 of file VMaterialFactory.h.

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

packages/BaseVGM/include/BaseVGM/materials/VMaterialFactory.h
packages/BaseVGM/source/materials/VMaterialFactory.cxx

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ VMaterialFactory() [1/3]

◆ ~VMaterialFactory()

◆ VMaterialFactory() [2/3]

◆ VMaterialFactory() [3/3]

Member Function Documentation

◆ Name()

◆ Isotopes()

◆ Elements()

◆ Materials()

◆ Media()

◆ Isotope()

◆ Element()

◆ Material()

◆ Medium()

◆ Export()

◆ PrintIsotopes()

◆ PrintElements()

◆ PrintMaterials()

◆ PrintMedia()

◆ SetDebug()

◆ Debug()

◆ IsotopeStore()

◆ ElementStore()

◆ MaterialStore()

◆ MediumStore()