IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Physics.ChemicalElement Class Reference

Represents a sigle chemical element with its main data. More...

+ Inheritance diagram for IG.Physics.ChemicalElement:
+ Collaboration diagram for IG.Physics.ChemicalElement:

Public Member Functions

 ChemicalElement (ChemicalElements whichElement, double atomicWeight, ChemicalElementProperties properties)
 Constructs a new chemical element element enumerator. More...
 
 ChemicalElement (ChemicalElements whichElement, double atomicWeight)
 Constructs a new chemical element element enumerator. More...
 
 ChemicalElement (ChemicalElements whichElement)
 Constructs a new chemical element element enumerator, with atomic weight set to 0. More...
 
 ChemicalElement (string symbol, double atomicWeight, ChemicalElementProperties properties)
 Constructs a new chemical element with specified element symbol. More...
 
 ChemicalElement (string symbol, double atomicWeight)
 Constructs a new chemical element with specified element symbol. More...
 
 ChemicalElement (string symbol)
 Constructs a new chemical element with specified element symbol, with atomic weight set to 0. More...
 
 ChemicalElement (ChemicalElement element)
 Constructs a new chemical element object that is a deep copy of the specified chemical element. More...
 
override string ToString ()
 Returns string representation of the current chemical element, which is just the element symbol. More...
 
virtual string TostringShort ()
 Returns string representation of the current chemical element, which is just the element symbol. More...
 
virtual string ToStringLong ()
 Returns longer string representation of the current themical element, which includes Properties. More...
 

Static Public Member Functions

static void CopyPlain (ChemicalElement original, ChemicalElement result)
 Deep copies the specified chemical element to another chemical element object. More...
 

Public Attributes

ChemicalElements Element
 Enum of type ChemicalElements specifying which chemical element this is. More...
 
string Symbol
 Chemical element's symbol. More...
 
int AtomicNumber
 Atomic number of the chemical element. More...
 
double AtomicWeight
 Standard atomic weight in atomic mass units. More...
 
ChemicalElementProperties Properties
 

Properties

string Name [get, set]
 Long name of the chemical element. More...
 

Private Member Functions

 ChemicalElement ()
 

Private Attributes

string _name
 

Detailed Description

Represents a sigle chemical element with its main data.

$A Igor Oct08;

Constructor & Destructor Documentation

IG.Physics.ChemicalElement.ChemicalElement ( )
inlineprivate
IG.Physics.ChemicalElement.ChemicalElement ( ChemicalElements  whichElement,
double  atomicWeight,
ChemicalElementProperties  properties 
)
inline

Constructs a new chemical element element enumerator.

Parameters
whichElementEnum of type ChemicalElements that defines which chemical element is created.
atomicWeightAtomic weight of the element.
propertiesOther properties of this element (optional).
IG.Physics.ChemicalElement.ChemicalElement ( ChemicalElements  whichElement,
double  atomicWeight 
)
inline

Constructs a new chemical element element enumerator.

Parameters
whichElementEnum of type ChemicalElements that defines which chemical element is created.
atomicWeightAtomic weight of the element.
IG.Physics.ChemicalElement.ChemicalElement ( ChemicalElements  whichElement)
inline

Constructs a new chemical element element enumerator, with atomic weight set to 0.

Parameters
whichElementEnum of type ChemicalElements that defines which chemical element is created.
IG.Physics.ChemicalElement.ChemicalElement ( string  symbol,
double  atomicWeight,
ChemicalElementProperties  properties 
)
inline

Constructs a new chemical element with specified element symbol.

Parameters
symbolSymbol of the chemical element. Enum of type ChemicalElements is obtained by parsing this symbol, whichis case sensitive (If there is no such enumeration value, exception is thrown).
atomicWeightAtomic weight of the element.
propertiesOther properties of this element (optional).
IG.Physics.ChemicalElement.ChemicalElement ( string  symbol,
double  atomicWeight 
)
inline

Constructs a new chemical element with specified element symbol.

Parameters
symbolSymbol of the chemical element. Enum of type ChemicalElements is obtained by parsing this symbol, whichis case sensitive (If there is no such enumeration value, exception is thrown).
atomicWeightAtomic weight of the element.
IG.Physics.ChemicalElement.ChemicalElement ( string  symbol)
inline

Constructs a new chemical element with specified element symbol, with atomic weight set to 0.

Parameters
symbolSymbol of the chemical element. Enum of type ChemicalElements is obtained by parsing this symbol, whichis case sensitive (If there is no such enumeration value, exception is thrown).
atomicWeightAtomic weight of the element.
IG.Physics.ChemicalElement.ChemicalElement ( ChemicalElement  element)
inline

Constructs a new chemical element object that is a deep copy of the specified chemical element.

Parameters
elementExisting chemical element that is copied.

Member Function Documentation

override string IG.Physics.ChemicalElement.ToString ( )
inline

Returns string representation of the current chemical element, which is just the element symbol.

Warning:

Function of this method can change in the future!

In orter to make sure that only a symbol is written, use the TostringShort method.

virtual string IG.Physics.ChemicalElement.TostringShort ( )
inlinevirtual

Returns string representation of the current chemical element, which is just the element symbol.

Reimplemented in IG.Physics.ChemicalElementQuantity.

virtual string IG.Physics.ChemicalElement.ToStringLong ( )
inlinevirtual

Returns longer string representation of the current themical element, which includes Properties.

Reimplemented in IG.Physics.ChemicalElementQuantity.

References IG.Physics.ChemicalElementProperties.ToString().

static void IG.Physics.ChemicalElement.CopyPlain ( ChemicalElement  original,
ChemicalElement  result 
)
inlinestatic

Deep copies the specified chemical element to another chemical element object.

Parameters
originalOriginal chemical element that is copied to another object.
resultObject to which the original element is copied.

References IG.Physics.ChemicalElement.AtomicNumber, IG.Physics.ChemicalElement.AtomicWeight, IG.Physics.ChemicalElement.Name, IG.Physics.ChemicalElement.Properties, and IG.Physics.ChemicalElement.Symbol.

Member Data Documentation

ChemicalElements IG.Physics.ChemicalElement.Element
string IG.Physics.ChemicalElement._name
private

Property Documentation

string IG.Physics.ChemicalElement.Name
getset

Long name of the chemical element.

If not specified then element symbol is returned by getter.

Referenced by IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.CopyFromPlain(), IG.Physics.ChemicalElement.CopyPlain(), and IG.Physics.ChemicalCompound.GetElementIndex().


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