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.ChemicalElementDtoBase< ChemicalElementType > Class Template Referenceabstract

Base class for various DTOs (Data Transfer Objects) for chemical elements and derived classes. More...

+ Inheritance diagram for IG.Physics.ChemicalElementDtoBase< ChemicalElementType >:
+ Collaboration diagram for IG.Physics.ChemicalElementDtoBase< ChemicalElementType >:

Public Member Functions

 ChemicalElementDtoBase ()
 Default constructor, sets IsNull to true. More...
 
 ChemicalElementDtoBase (ChemicalElementType element)
 Constructor, prepares the current DTO for storing a specific chemical element. More...
 
abstract ChemicalElementType CreateElement ()
 Creates and returns a new chemical element. More...
 
override ChemicalElementType CreateObject ()
 Creates and returns a new chemical element of the appropriate type. More...
 

Public Attributes

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

Protected Member Functions

override void CopyFromPlain (ChemicalElement element)
 Copies data to the current DTO from a chemical element object. More...
 
override void CopyToPlain (ref ChemicalElement element)
 Copies data from the current DTO to a chemical element object. More...
 

Detailed Description

Base class for various DTOs (Data Transfer Objects) for chemical elements and derived classes.

Used to store a state of a chemical element.

Template Parameters
ChemicalElementTypeType parameter specifying the specific chemical element type for which concrete DTO is designed.

$A Igor Oct09;

Type Constraints
ChemicalElementType :ChemicalElement 

Constructor & Destructor Documentation

IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.ChemicalElementDtoBase ( )
inline

Default constructor, sets IsNull to true.

IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.ChemicalElementDtoBase ( ChemicalElementType  element)
inline

Constructor, prepares the current DTO for storing a specific chemical element.

Parameters
lengthElement whose data is stored in the current DTO.

Member Function Documentation

abstract ChemicalElementType IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.CreateElement ( )
pure virtual

Creates and returns a new chemical element.

Implemented in IG.Physics.ChemicalElementQuantityDto, and IG.Physics.ChemicalElementDto.

override ChemicalElementType IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.CreateObject ( )
inline

Creates and returns a new chemical element of the appropriate type.

Referenced by ChemicalCompoundDto.CopyToPlain().

override void IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.CopyFromPlain ( ChemicalElement  element)
inlineprotected

Copies data to the current DTO from a chemical element object.

Parameters
elementChemical element object from which data is copied.

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

override void IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.CopyToPlain ( ref ChemicalElement  element)
inlineprotected

Copies data from the current DTO to a chemical element object.

Parameters
elementChemical element object that data is copied to.

Member Data Documentation

ChemicalElements IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.Element

Enum of type ChemicalElements specifying which chemical element this is.

string IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.Symbol

Chemical element's symbol.

string IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.Name

Long name of the chemical element.

int IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.AtomicNumber

Atomic number of the chemical element.

double IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.AtomicWeight

Standard atomic weight in atomic mass units.

ChemicalElementPropertiesDto IG.Physics.ChemicalElementDtoBase< ChemicalElementType >.Properties

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