Click or drag to resize

SIPrefix Class

Represents an SI prefix, such as nano, micro, Mega, Giga etc.
Inheritance Hierarchy
SystemObject
  Altaxo.UnitsSIPrefix

Namespace: Altaxo.Units
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3448.0 (4.8.3448.0)
Syntax
C#
Copy
public class SIPrefix : IUnit, IEquatable<SIPrefix>, 
	IComparable<SIPrefix>

The SIPrefix type exposes the following members.

Constructors
 NameDescription
Public methodSIPrefix Deserialization constructor. Initializes a new instance of the SIPrefix class. Do not use this constructor unless you don't find the prefix in the list of known prefixes.
Top
Properties
 NameDescription
Public propertyStatic memberAttoGets the 'atto' prefix instance (exponent -18).
Public propertyCanApplySIPrefix Indicates whether this unit can have an SI prefix applied to it.
Public propertyStatic memberCentiGets the 'centi' prefix instance (exponent -2).
Public propertyStatic memberDecaGets the 'deca' prefix instance (exponent 1).
Public propertyStatic memberDeciGets the 'deci' prefix instance (exponent -1).
Public propertyStatic memberExaGets the 'exa' prefix instance (exponent 18).
Public propertyExponent Gets the exponent of this prefix (power of ten).
Public propertyStatic memberFemtoGets the 'femto' prefix instance (exponent -15).
Public propertyStatic memberGigaGets the 'giga' prefix instance (exponent 9).
Public propertyStatic memberHectoGets the 'hecto' prefix instance (exponent 2).
Public propertyStatic memberKiloGets the 'kilo' prefix instance (exponent 3).
Public propertyStatic memberLargestPrefixGets the largest known prefix (highest exponent).
Public propertyStatic memberLisOfPrefixesWithMultipleOf3Exponent Returns a list with prefixes, for which the exponent is a multiple of 3, including the prefix None.
Public propertyStatic memberListWithAllKnownPrefixes Returns a list with all known prefixes, including the prefix None.
Public propertyStatic memberListWithNonePrefixOnly Returns a list that contains only the prefix None.
Public propertyStatic memberMaxShortCutLength Gets the maximum length of the shortcuts of any of the known prefixes.
Public propertyStatic memberMegaGets the 'mega' prefix instance (exponent 6).
Public propertyStatic memberMicroGets the 'micro' prefix instance (exponent -6).
Public propertyStatic memberMilliGets the 'milli' prefix instance (exponent -3).
Public propertyStatic memberMinShortCutLength Gets the minimum length of the shortcuts of any of the known prefixes.
Public propertyNameFull name of the unit.
Public propertyStatic memberNanoGets the 'nano' prefix instance (exponent -9).
Public propertyStatic memberNoneGets the 'none' prefix instance (exponent 0).
Public propertyStatic memberPetaGets the 'peta' prefix instance (exponent 15).
Public propertyStatic memberPicoGets the 'pico' prefix instance (exponent -12).
Public propertyStatic memberQuectoGets the 'quecto' prefix instance (exponent -30).
Public propertyStatic memberQuettaGets the 'quetta' prefix instance (exponent 30).
Public propertyStatic memberRonnaGets the 'ronna' prefix instance (exponent 27).
Public propertyStatic memberRontoGets the 'ronto' prefix instance (exponent -27).
Public propertyShortCutUsual shortcut of the unit.
Public propertyStatic memberSmallestPrefixGets the smallest known prefix (lowest exponent).
Public propertyStatic memberTeraGets the 'tera' prefix instance (exponent 12).
Public propertyStatic memberYoctoGets the 'yocto' prefix instance (exponent -24).
Public propertyStatic memberYottaGets the 'yotta' prefix instance (exponent 24).
Public propertyStatic memberZeptoGets the 'zepto' prefix instance (exponent -21).
Public propertyStatic memberZettaGets the 'zetta' prefix instance (exponent 21).
Top
Methods
 NameDescription
Public methodCompareToCompares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
Public methodEquals(Object)Determines whether the specified object is equal to the current object.
(Overrides ObjectEquals(Object))
Public methodEquals(SIPrefix)Indicates whether the current object is equal to another object of the same type.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodStatic memberFromDivision Divides two prefixes and returns the prefix and any remaining factor.
Public methodStatic memberFromMultiplication Multiplies two prefixes and returns the prefix and any remaining factor.
Public methodFromSIUnit Converts x (in SI units) to the corresponding value in this unit.
Public methodGetHashCodeServes as the default hash function.
(Overrides ObjectGetHashCode)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToSIUnit Converts x to the corresponding SI unit.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodStatic memberTryGetPrefixFromExponent Try to get a known prefix with a given exponent.
Public methodStatic memberTryGetPrefixFromShortcut Try to get a prefix given the prefix's shortcut.
Top
Operators
 NameDescription
Public operatorStatic memberMultiply(SIPrefix, SIPrefix) Multiplies two prefixes. If the result is not a known prefix, an InvalidOperationException is thrown. Consider using FromMultiplication(SIPrefix, SIPrefix) instead.
Top
See Also