Base class for species and subspecies. More...

Inheritance diagram for prism::SpeciesBase:

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

bool	operator== (const SpeciesBase &other) const
	Comparison operator checks if the two base species have the same name.

bool	operator!= (const SpeciesBase &other) const
	Comparison for checking whether or not the two are not equal.

const std::string &	name () const
	Getter method for the name of species.

double	mass () const
	Getter method for the mass of the species mass of the species is in kg.

double	molarMass () const
	Getter method for the molar mass of the species molar mass is in g / mol.

int	chargeNumber () const
	Getter method for the charge number of the species.

double	charge () const
	Getter method for the charge of the species.

const std::string &	latexRepresentation () const
	Getter method for the latex name of the species.

const std::string &	neutralGroundState () const
	Gets the ground neutral state of the subspecies Ex: H3* -> H3.

virtual std::string	to_string () const

Protected Member Functions
std::string	checkName (const std::string &name)
	Method checks to make sure that the name is not an empty std::string also checks to make sure e and E are reserved for electrons only.

virtual void	setMass ()=0
	Method for setting the mass of the species.

virtual void	setCharge ()=0
	Method for the setting the charge number of the species.

virtual void	setLatexName ()=0
	methods for setting the latex name of each species

virtual void	setNeutralGroundState ()=0

Protected Attributes
std::string	_name
	The full std::string of the species base.

double	_mass
	The mass of an individual instance of the species.

double	_molar_mass
	the molar mass of the species

double	_charge
	the charge of the spcies in coulomb

int	_charge_num
	The level of charge ex: Ar-4 this is -4.

std::string	_latex_name
	The name of the spcies formatted for printing in a latex_table.

std::string	_neutral_ground_state
	the neutral ground state for a species ex: Ar2* -> Ar2

Detailed Description

Base class for species and subspecies.

Constructor & Destructor Documentation

prism::SpeciesBase::SpeciesBase ( const std::string & name )

Parameters

name	the string representation of the base

string prism::SpeciesBase::checkName ( const std::string & name )

protected

Method checks to make sure that the name is not an empty std::string also checks to make sure e and E are reserved for electrons only.

Parameters

name	the std::string representation of the name

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