gVirtualXRay  2.0.10
VirtualX-RayImagingLibraryonGPU
Public Member Functions | Static Public Member Functions
gVirtualXRay::ElementSet Class Reference

ElementSet is a class to manage a table of elements in material. More...

#include <ElementSet.h>

Collaboration diagram for gVirtualXRay::ElementSet:
Collaboration graph

Public Member Functions

 ~ElementSet ()
 Destructor. More...
 
void loadFromFile (const std::string &aFileName)
 Load a file containing elements. More...
 
void loadElementSetFromMemory ()
 Load the table of elements. More...
 
void addElement (const AtomicElement &anElement)
 Add an element to the list. More...
 
AtomicElementgetElement (unsigned short anAtomicNumber)
 Get a given element. More...
 
const AtomicElementgetElement (unsigned short anAtomicNumber) const
 Get a given element. More...
 
AtomicElementgetElement (const std::string &aName)
 Get a given element. More...
 
const AtomicElementgetElement (const std::string &aName) const
 Get a given element. More...
 
float getMolarMass (unsigned short anAtomicNumber) const
 Accessor on the molar mass of the element. More...
 
float getDensity (unsigned short anAtomicNumber) const
 Accessor on the density of the element. More...
 
unsigned int getElementSetSize () const
 Accessor on the number of elements in the set. More...
 
std::map< unsigned short, AtomicElement >::const_iterator begin () const
 Accessor on the begin const_iterator of m_element_set. More...
 
std::map< unsigned short, AtomicElement >::const_iterator end () const
 Accessor on the end const_iterator of m_element_set. More...
 

Static Public Member Functions

static ElementSetgetInstance ()
 

Detailed Description

ElementSet is a class to manage a table of elements in material.

Definition at line 116 of file ElementSet.h.

Constructor & Destructor Documentation

◆ ~ElementSet()

gVirtualXRay::ElementSet::~ElementSet ( )
inline

Destructor.

Definition at line 78 of file ElementSet.inl.

Member Function Documentation

◆ addElement()

void gVirtualXRay::ElementSet::addElement ( const AtomicElement anElement)

Add an element to the list.

◆ begin()

std::map<unsigned short, AtomicElement>::const_iterator gVirtualXRay::ElementSet::begin ( ) const

Accessor on the begin const_iterator of m_element_set.

◆ end()

std::map<unsigned short, AtomicElement>::const_iterator gVirtualXRay::ElementSet::end ( ) const

Accessor on the end const_iterator of m_element_set.

◆ getDensity()

float gVirtualXRay::ElementSet::getDensity ( unsigned short  anAtomicNumber) const

Accessor on the density of the element.

◆ getElement() [1/4]

AtomicElement& gVirtualXRay::ElementSet::getElement ( unsigned short  anAtomicNumber)

Get a given element.

◆ getElement() [2/4]

const AtomicElement& gVirtualXRay::ElementSet::getElement ( unsigned short  anAtomicNumber) const

Get a given element.

◆ getElement() [3/4]

AtomicElement& gVirtualXRay::ElementSet::getElement ( const std::string &  aName)

Get a given element.

◆ getElement() [4/4]

const AtomicElement& gVirtualXRay::ElementSet::getElement ( const std::string &  aName) const

Get a given element.

◆ getElementSetSize()

unsigned int gVirtualXRay::ElementSet::getElementSetSize ( ) const
inline

Accessor on the number of elements in the set.

Definition at line 94 of file ElementSet.inl.

◆ getInstance()

static ElementSet& gVirtualXRay::ElementSet::getInstance ( )
static

◆ getMolarMass()

float gVirtualXRay::ElementSet::getMolarMass ( unsigned short  anAtomicNumber) const

Accessor on the molar mass of the element.

◆ loadElementSetFromMemory()

void gVirtualXRay::ElementSet::loadElementSetFromMemory ( )

Load the table of elements.

◆ loadFromFile()

void gVirtualXRay::ElementSet::loadFromFile ( const std::string &  aFileName)

Load a file containing elements.


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