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.SIPrefix Class Reference

Represents a prefix for the SI units of measure. Contains constants for all SI predixes. Class is immutable. It also has no public constructors, so instances can not be created by users of the class. The only existing instances are the constants that represent all existing prefixes of the SI units of measures, which are static constant fields of this class with predefined values. More...

+ Collaboration diagram for IG.Physics.SIPrefix:

Classes

class  PrefixCollection
 Collection of al prefixes for the SI units. More...
 

Public Member Functions

override string ToString ()
 Soncersion to string - returns the value of the Symbol property. More...
 
string ToStringLong ()
 

Static Public Member Functions

static void PrintList ()
 Prints a list of all built in SI prefixes. More...
 

Protected Member Functions

 SIPrefix (SIPrefixes id, int log10Factor, double factor, string name, string prefix, string description)
 Constructs a new SI units prefix. More...
 

Properties

SIPrefixes Id [get]
 ID of the prefix for SI units of measure, an enumerator of type SIPrefixes. More...
 
double Log10Factor [get]
 Base 10 logarithm of the factor represented by the current SI units prefix. More...
 
double Factor [get]
 Factor represented by the current SI units prefix. More...
 
string Symbol [get]
 Symbol of the current prefix for the SI units of measure such as "m", "μ", "k", "M", "T". More...
 
string PrefixString [get]
 Name of the prefix, such as "milli-", "micro-", or "mega". More...
 
string Description [get]
 Short description of the current prefix for the SI units of measure. More...
 
static SIPrefix None [get]
 Standard prefix for SI units of measure, None (no prefix), 1.0. More...
 
static SIPrefix da [get]
 Standard prefix for SI units of measure, da (deca-), 10^1. More...
 
static SIPrefix h [get]
 Standard prefix for SI units of measure, h (hecto-), 10^2. More...
 
static SIPrefix k [get]
 Standard prefix for SI units of measure, k (kilo-), 10^3. More...
 
static SIPrefix M [get]
 <Standard prefix for SI units of measure, M (mega-), 10^6./summary> More...
 
static SIPrefix G [get]
 Standard prefix for SI units of measure, G (giga-), 10^9. More...
 
static SIPrefix T [get]
 Standard prefix for SI units of measure, T (tera-), 10^12. More...
 
static SIPrefix P [get]
 Standard prefix for SI units of measure, P (peta-), 10^15. More...
 
static SIPrefix E [get]
 Standard prefix for SI units of measure, E (exa-), 10^18. More...
 
static SIPrefix Z [get]
 Standard prefix for SI units of measure, Z (zetta-), 10^21. More...
 
static SIPrefix Y [get]
 Standard prefix for SI units of measure, Y (yotta-), 10^24. More...
 
static SIPrefix d [get]
 Standard prefix for SI units of measure, d (deci-), 10^-1. More...
 
static SIPrefix c [get]
 Standard prefix for SI units of measure, c (centi-), 10^-2. More...
 
static SIPrefix m [get]
 Standard prefix for SI units of measure, m (milli-), 10^-3. More...
 
static SIPrefix micro [get]
 Standard prefix for SI units of measure, μ (micro-), 10^-6. More...
 
static SIPrefix n [get]
 Standard prefix for SI units of measure, n (nano-), 10^-9. More...
 
static SIPrefix p [get]
 Standard prefix for SI units of measure, p (pico-), 10^-12. More...
 
static SIPrefix f [get]
 Standard prefix for SI units of measure, f (femto-), 10^-15. More...
 
static SIPrefix a [get]
 Standard prefix for SI units of measure, a (ato-), 10^-18. More...
 
static SIPrefix z [get]
 Standard prefix for SI units of measure, z (zepto-), 10^-21. More...
 
static SIPrefix y [get]
 Standard prefix for SI units of measure, y (yocto-), 10^-24. More...
 
static PrefixCollection List [get]
 Returns a collection that contains all currently built-in SI unit prefixes. More...
 

Private Attributes

SIPrefixes _id
 
int _log10Factor
 
double _factor
 
string _symbol
 
string _prefixString
 
string _description
 

Static Private Attributes

static SIPrefix _none
 
static SIPrefix _da
 
static SIPrefix _h
 
static SIPrefix _k
 
static SIPrefix _M
 
static SIPrefix _G
 
static SIPrefix _T
 
static SIPrefix _P
 
static SIPrefix _E
 
static SIPrefix _Z
 
static SIPrefix _Y
 
static SIPrefix _d
 
static SIPrefix _c
 
static SIPrefix _m
 
static SIPrefix _micro
 
static SIPrefix _n
 
static SIPrefix _p
 
static SIPrefix _f
 
static SIPrefix _a
 
static SIPrefix _z
 
static SIPrefix _y
 
static PrefixCollection _prefixList = new PrefixCollection()
 

Detailed Description

Represents a prefix for the SI units of measure. Contains constants for all SI predixes. Class is immutable. It also has no public constructors, so instances can not be created by users of the class. The only existing instances are the constants that represent all existing prefixes of the SI units of measures, which are static constant fields of this class with predefined values.

Constructor & Destructor Documentation

IG.Physics.SIPrefix.SIPrefix ( SIPrefixes  id,
int  log10Factor,
double  factor,
string  name,
string  prefix,
string  description 
)
inlineprotected

Constructs a new SI units prefix.

Parameters
idID of the SI prefix, enumerator of type SIPrefixes.
log10FactorBase 10th logarithm of the factor represented by the prefix.
factorFactor represented by the prefix.
nameSymbol of the prefix that is used in expressions, e.g. "m", "p", "μ", "T", "G".
prefixName of the prefix such as "kilo-", "milli-", etc.
descriptionShort description of the prefix.

References IG.Physics.SIPrefix.PrefixCollection.Add(), and IG.Physics.SIPrefix.List.

Member Function Documentation

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

Soncersion to string - returns the value of the Symbol property.

Returns
string IG.Physics.SIPrefix.ToStringLong ( )
inline
static void IG.Physics.SIPrefix.PrintList ( )
inlinestatic

Prints a list of all built in SI prefixes.

References IG.Physics.SIPrefix.List, and IG.Physics.SIPrefix.PrefixCollection.ToArray().

Member Data Documentation

SIPrefixes IG.Physics.SIPrefix._id
private
int IG.Physics.SIPrefix._log10Factor
private
double IG.Physics.SIPrefix._factor
private
string IG.Physics.SIPrefix._symbol
private
string IG.Physics.SIPrefix._prefixString
private
string IG.Physics.SIPrefix._description
private
SIPrefix IG.Physics.SIPrefix._none
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.None, 0, 1.0, "", "",
"Standard prefix for SI units of measure, None (no prefix), 1.0.")
SIPrefix IG.Physics.SIPrefix._da
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.da, 1, 1.0e1, "da", "deca-",
"Standard prefix for SI units of measure, da (deca-), 10^1.")
SIPrefix IG.Physics.SIPrefix._h
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.h, 2, 1.0e2, "h", "hecto-",
"Standard prefix for SI units of measure, h (hecto-), 10^2.")
SIPrefix IG.Physics.SIPrefix._k
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.k, 3, 1.0e3, "k", "kilo-",
"Standard prefix for SI units of measure, k (kilo-), 10^3.")
SIPrefix IG.Physics.SIPrefix._M
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.M, 6, 1.0e6, "M", "mega-",
"Standard prefix for SI units of measure, M (mega-), 10^6.")
SIPrefix IG.Physics.SIPrefix._G
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.G, 9, 1.0e9, "G", "giga-",
"Standard prefix for SI units of measure, G (giga-), 10^9.")
SIPrefix IG.Physics.SIPrefix._T
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.T, 12, 1.0e12, "T", "tera-",
"Standard prefix for SI units of measure, T (tera-), 10^12.")
SIPrefix IG.Physics.SIPrefix._P
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.P, 15, 1.0e15, "P", "peta-",
"Standard prefix for SI units of measure, P (peta-), 10^15.")
SIPrefix IG.Physics.SIPrefix._E
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.E, 18, 1.0e18, "E", "exa-",
"Standard prefix for SI units of measure, E (exa-), 10^18.")
SIPrefix IG.Physics.SIPrefix._Z
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.Z, 21, 1.0e21, "Z", "zetta-",
"Standard prefix for SI units of measure, Z (zetta-), 10^21.")
SIPrefix IG.Physics.SIPrefix._Y
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.Y, 24, 1.0e24, "Y", "yotta-",
"Standard prefix for SI units of measure, Y (yotta-), 10^24.")
SIPrefix IG.Physics.SIPrefix._d
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.d, -1, 1.0e-1, "d", "deci-",
"Standard prefix for SI units of measure, d (deci-), 10^-1.")
SIPrefix IG.Physics.SIPrefix._c
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.c, -2, 1.0e-2, "c", "centi-",
"Standard prefix for SI units of measure, c (centi-), 10^-2.")
SIPrefix IG.Physics.SIPrefix._m
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.m, -3, 1.0e-3, "m", "milli-",
"Standard prefix for SI units of measure, m (milli-), 10^-3.")
SIPrefix IG.Physics.SIPrefix._micro
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.micro, -6, 1.0e-6, "μ", "micro-",
"Standard prefix for SI units of measure, μ (micro-), 10^-6.")
SIPrefix IG.Physics.SIPrefix._n
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.n, -9, 1.0e-9, "n", "nano-",
"Standard prefix for SI units of measure, n (nano-), 10^-9.")
SIPrefix IG.Physics.SIPrefix._p
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.p, -12, 1.0e-12, "p", "pico-",
"Standard prefix for SI units of measure, p (pico-), 10^-12.")
SIPrefix IG.Physics.SIPrefix._f
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.f, -15, 1.0e-15, "f", "femto-",
"Standard prefix for SI units of measure, f (femto-), 10^-15.")
SIPrefix IG.Physics.SIPrefix._a
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.a, -18, 1.0e-18, "a", "ato-",
"Standard prefix for SI units of measure, a (ato-), 10^-18.")
SIPrefix IG.Physics.SIPrefix._z
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.z, -21, 1.0e-21, "z", "zepto-",
"Standard prefix for SI units of measure, z (zepto-), 10^-21.")
SIPrefix IG.Physics.SIPrefix._y
staticprivate
Initial value:
=
new SIPrefix(SIPrefixes.y, -24, 1.0e-24, "y", "yocto-",
"Standard prefix for SI units of measure, y (yocto-), 10^-24.")
PrefixCollection IG.Physics.SIPrefix._prefixList = new PrefixCollection()
staticprivate

Property Documentation

SIPrefixes IG.Physics.SIPrefix.Id
get

ID of the prefix for SI units of measure, an enumerator of type SIPrefixes.

Referenced by IG.Physics.SIPrefix.PrefixCollection.Add().

double IG.Physics.SIPrefix.Log10Factor
get

Base 10 logarithm of the factor represented by the current SI units prefix.

double IG.Physics.SIPrefix.Factor
get

Factor represented by the current SI units prefix.

string IG.Physics.SIPrefix.Symbol
get

Symbol of the current prefix for the SI units of measure such as "m", "μ", "k", "M", "T".

Referenced by IG.Physics.SIPrefix.PrefixCollection.Add().

string IG.Physics.SIPrefix.PrefixString
get

Name of the prefix, such as "milli-", "micro-", or "mega".

string IG.Physics.SIPrefix.Description
get

Short description of the current prefix for the SI units of measure.

SIPrefix IG.Physics.SIPrefix.None
staticget

Standard prefix for SI units of measure, None (no prefix), 1.0.

SIPrefix IG.Physics.SIPrefix.da
staticget

Standard prefix for SI units of measure, da (deca-), 10^1.

SIPrefix IG.Physics.SIPrefix.h
staticget

Standard prefix for SI units of measure, h (hecto-), 10^2.

SIPrefix IG.Physics.SIPrefix.k
staticget

Standard prefix for SI units of measure, k (kilo-), 10^3.

SIPrefix IG.Physics.SIPrefix.M
staticget

<Standard prefix for SI units of measure, M (mega-), 10^6./summary>

SIPrefix IG.Physics.SIPrefix.G
staticget

Standard prefix for SI units of measure, G (giga-), 10^9.

SIPrefix IG.Physics.SIPrefix.T
staticget

Standard prefix for SI units of measure, T (tera-), 10^12.

SIPrefix IG.Physics.SIPrefix.P
staticget

Standard prefix for SI units of measure, P (peta-), 10^15.

SIPrefix IG.Physics.SIPrefix.E
staticget

Standard prefix for SI units of measure, E (exa-), 10^18.

SIPrefix IG.Physics.SIPrefix.Z
staticget

Standard prefix for SI units of measure, Z (zetta-), 10^21.

SIPrefix IG.Physics.SIPrefix.Y
staticget

Standard prefix for SI units of measure, Y (yotta-), 10^24.

SIPrefix IG.Physics.SIPrefix.d
staticget

Standard prefix for SI units of measure, d (deci-), 10^-1.

SIPrefix IG.Physics.SIPrefix.c
staticget

Standard prefix for SI units of measure, c (centi-), 10^-2.

SIPrefix IG.Physics.SIPrefix.m
staticget

Standard prefix for SI units of measure, m (milli-), 10^-3.

SIPrefix IG.Physics.SIPrefix.micro
staticget

Standard prefix for SI units of measure, μ (micro-), 10^-6.

SIPrefix IG.Physics.SIPrefix.n
staticget

Standard prefix for SI units of measure, n (nano-), 10^-9.

SIPrefix IG.Physics.SIPrefix.p
staticget

Standard prefix for SI units of measure, p (pico-), 10^-12.

SIPrefix IG.Physics.SIPrefix.f
staticget

Standard prefix for SI units of measure, f (femto-), 10^-15.

SIPrefix IG.Physics.SIPrefix.a
staticget

Standard prefix for SI units of measure, a (ato-), 10^-18.

SIPrefix IG.Physics.SIPrefix.z
staticget

Standard prefix for SI units of measure, z (zepto-), 10^-21.

SIPrefix IG.Physics.SIPrefix.y
staticget

Standard prefix for SI units of measure, y (yocto-), 10^-24.

PrefixCollection IG.Physics.SIPrefix.List
staticget

Returns a collection that contains all currently built-in SI unit prefixes.

Referenced by IG.Physics.SIPrefix.PrintList(), and IG.Physics.SIPrefix.SIPrefix().


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