xpSpectrumObjectAgent Class Reference

The base component for spectrum-related objects. More...

#include <XPS4XPS.H>

Inheritance diagram for xpSpectrumObjectAgent:

[legend]Collaboration diagram for xpSpectrumObjectAgent:

[legend]

Public Member Functions
	xpSpectrumObjectAgent (void)
	xpSpectrumObjectAgent (const xpSpectrumObjectAgent &S)
xboolean::xbool	GetEnergyBE (void)
float	GetMaxEnergy (void)
float	GetMinEnergy (void)
float	GetXEnergy (void)
xboolean::xbool	GetXEnergyKnown (void)
bool	IsEnergyBE (void)
bool	IsEnergyKE (void)
bool	IsXEnergyKnown (void)
void	SetEnergyBE (xboolean::xbool B)
void	SetMaxEnergy (float E)
void	SetMinEnergy (float E)
void	SetXEnergy (float XE)
void	SetXEnergyKnown (xboolean::xbool B)
float	ToBE (float KE)
float	ToKE (float BE)
Static Public Member Functions
bool	IsInRangeE (float E1, float E2, float E)
Protected Attributes
float	MaxEnergy
float	MinEnergy
float	XEnergy
xboolean::xbool	EnergyBE
xboolean::xbool	XEnergyKnown

---

Detailed Description

The base component for spectrum-related objects.

This component is the base expert system object for the special "spectrum-related" objects; provides generic spectrum-related info source behaviour.

---

Constructor & Destructor Documentation

xpSpectrumObjectAgent::xpSpectrumObjectAgent (  void   )  [inline]

Construct a generic spectrum object. Sets xpSpectrumObjectAgent::EnergyBE and xpSpectrumObjectAgent::XEnergyKnown to xboolean::Unknown, sets xpSpectrumObjectAgent::MinEnergy and xpSpectrumObjectAgent::MaxEnergy to 100 and 1400 eV; sets xpSpectrumObjectAgent::XEnergy to 1486.6 eV.

xpSpectrumObjectAgent::xpSpectrumObjectAgent (  const xpSpectrumObjectAgent &  S  )  [inline]

Copy constructor. Copies parameters of S to this generic object.

---

Member Function Documentation

xboolean::xbool xpSpectrumObjectAgent::GetEnergyBE (  void   )  [inline]

Returns value of xpSpectrumObjectAgent::EnergyBE Returns: the status if the energy is given on binding scale

float xpSpectrumObjectAgent::GetMaxEnergy (  void   )  [inline]

Returns value of xpSpectrumObjectAgent::MaxEnergy Returns: the maximum energy belonging to the generic object See also: SetMaxEnergy

float xpSpectrumObjectAgent::GetMinEnergy (  void   )  [inline]

Returns value of xpSpectrumObjectAgent::MinEnergy Returns: the minimum energy belonging to the generic object See also: SetMinEnergy

float xpSpectrumObjectAgent::GetXEnergy (  void   )  [inline]

Returns value of xpSpectrumObjectAgent::XEnergy Returns: excitation energy belonging to the generic object See also: SetXEnergy

xboolean::xbool xpSpectrumObjectAgent::GetXEnergyKnown (  void   )  [inline]

Returns value of xpSpectrumObjectAgent::XEnergyKnown Returns: the status of the excitation energy belonging to the generic object See also: SetXEnergyKnown

bool xpSpectrumObjectAgent::IsEnergyBE (  void   )  [inline]

Returns value of xpSpectrumObjectAgent::EnergyBE Returns: 'true' if the energy belonging to the generic object are given on binding energy scale 'false' otherwise. See also: SetEnergyBE

bool xpSpectrumObjectAgent::IsEnergyKE (  void   )  [inline]

Returns negated value of value of xpSpectrumObjectAgent::EnergyBE Returns: 'true' if the energy belonging to the generic object are given on kinetic energy scale 'false' otherwise. See also: SetEnergyBE

bool xpSpectrumObjectAgent::IsInRangeE (  float  E1, float  E2, float  E )  [inline, static]

Returns if energy value E is between E1 and E2. A tolerance value EnergyTolerance is used, to avoid rounding errors. Parameters: E1  : the lower energy E2  : the higher energy E  : the checked energy Returns: 'true' if energy value E is between E1 and E2, 'false' otherwise.

bool xpSpectrumObjectAgent::IsXEnergyKnown (  void   )  [inline]

Returns if xpSpectrumObjectAgent::XEnergyKnown Returns: 'true' if excitation energy is known, 'false' otherwise. See also: SetXEnergyKnown

void xpSpectrumObjectAgent::SetEnergyBE (  xboolean::xbool  B  )  [inline]

Sets xpSpectrumObjectAgent::EnergyBE Parameters: B  the new status if the energy is given on binding scale See also: GetEnergyBE

void xpSpectrumObjectAgent::SetMaxEnergy (  float  E  )  [inline]

Set xpSpectrumObjectAgent::MaxEnergy Parameters: E  : the new maximum energy, belonging to the generic object. See also: GetMaxEnergy

void xpSpectrumObjectAgent::SetMinEnergy (  float  E  )  [inline]

Set xpSpectrumObjectAgent::MinEnergy Parameters: E  : the new minimum energy, belonging to the generic object. See also: GetMinEnergy

void xpSpectrumObjectAgent::SetXEnergy (  float  XE  )  [inline]

Set xpSpectrumObjectAgent::XEnergy. Also sets xpSpectrumObjectAgent::XEnergyKnown to 'True'. Parameters: XE  the new value of the excitation energy Returns: the status of the X energy See also: SetXEnergyKnown GetXEnergy

void xpSpectrumObjectAgent::SetXEnergyKnown (  xboolean::xbool  B  )  [inline]

Set xpSpectrumObjectAgent::XEnergyKnown Parameters: B  the new value of the status if excitation energy known See also: SetXEnergy

float xpSpectrumObjectAgent::ToBE (  float  KE  )  [inline]

Return binding energy corresponding to kinetic energy KE Parameters: KE  the kinetic energy Returns: the binding energy corresponding to kinetic energy KE

float xpSpectrumObjectAgent::ToKE (  float  BE  )  [inline]

Return kinetic energy corresponding to binding energy BE Parameters: BE  the binding energy Returns: the kinetic energy corresponding to binding energy BE

---

Field Documentation

xboolean::xbool xpSpectrumObjectAgent::EnergyBE [protected]

If energy is on binding scale: True(Binding), False(Kinetic) or Unknown.

float xpSpectrumObjectAgent::MaxEnergy [protected]

The maximum energy belonging to the generic object.

float xpSpectrumObjectAgent::MinEnergy [protected]

The minimum energy belonging to the generic object.

float xpSpectrumObjectAgent::XEnergy [protected]

The X-ray excitation energy belonging to the generic object.

xboolean::xbool xpSpectrumObjectAgent::XEnergyKnown [protected]

If eXcitation energy is known: True, False or Unknown.

---

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

• XPS4XPS.H

---