SIPrefix Type

Namespace: Altaxo.Units
Assembly: AltaxoCore.Redist.dll
Base Type: obj
All Interfaces: IUnit , IEquatable<SIPrefix> , IComparable<SIPrefix>

Represents an SI prefix, such as nano, micro, Mega, Giga etc.

Constructors

Constructor Description

SIPrefix(name, shortCut, exponent)

Full Usage: SIPrefix(name, shortCut, exponent)

Parameters:
    name : string - The name of the prefix.
    shortCut : string - The short cut of the prefix.
    exponent : int - The exponent associated with the prefix.

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.

name : string

The name of the prefix.

shortCut : string

The short cut of the prefix.

exponent : int

The exponent associated with the prefix.

Instance members

Instance member Description

this.CanApplySIPrefix

Full Usage: this.CanApplySIPrefix

Returns: bool

Returns: bool

this.CompareTo

Full Usage: this.CompareTo

Parameters:
Returns: int
Modifiers: abstract

other : SIPrefix
Returns: int

this.Equals

Full Usage: this.Equals

Parameters:
Returns: bool
Modifiers: abstract

other : SIPrefix
Returns: bool

this.Equals

Full Usage: this.Equals

Parameters:
    obj : obj

Returns: bool
Modifiers: abstract

obj : obj
Returns: bool

this.Exponent

Full Usage: this.Exponent

Returns: int

Returns: int

this.FromSIUnit

Full Usage: this.FromSIUnit

Parameters:
    x : float

Returns: float
Modifiers: abstract

x : float
Returns: float

this.GetHashCode

Full Usage: this.GetHashCode

Returns: int
Modifiers: abstract

Returns: int

this.Name

Full Usage: this.Name

Returns: string
Modifiers: abstract

Returns: string

this.ShortCut

Full Usage: this.ShortCut

Returns: string
Modifiers: abstract

Returns: string

this.ToSIUnit

Full Usage: this.ToSIUnit

Parameters:
    x : float

Returns: float
Modifiers: abstract

x : float
Returns: float

Static members

Static member Description

x * y

Full Usage: x * y

Parameters:
Returns: SIPrefix The result of the operator.

Multiplies two prefixes. If the result is not a known prefix, an InvalidOperationException is thrown. Consider using SIPrefix.FromMultiplication instead.

x : SIPrefix

The x.

y : SIPrefix

The y.

Returns: SIPrefix

The result of the operator.

InvalidOperationException $"Result of multiplication of prefix {x} and {y} is not a known prefix!

SIPrefix.Atto

Full Usage: SIPrefix.Atto

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Centi

Full Usage: SIPrefix.Centi

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Deca

Full Usage: SIPrefix.Deca

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Deci

Full Usage: SIPrefix.Deci

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Exa

Full Usage: SIPrefix.Exa

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Femto

Full Usage: SIPrefix.Femto

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.FromDivision(p1, p2)

Full Usage: SIPrefix.FromDivision(p1, p2)

Parameters:
Returns: SIPrefix * float

p1 : SIPrefix
p2 : SIPrefix
Returns: SIPrefix * float

SIPrefix.FromMultiplication(p1, p2)

Full Usage: SIPrefix.FromMultiplication(p1, p2)

Parameters:
Returns: SIPrefix * float

p1 : SIPrefix
p2 : SIPrefix
Returns: SIPrefix * float

SIPrefix.Giga

Full Usage: SIPrefix.Giga

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Hecto

Full Usage: SIPrefix.Hecto

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Kilo

Full Usage: SIPrefix.Kilo

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.LargestPrefix

Full Usage: SIPrefix.LargestPrefix

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.LisOfPrefixesWithMultipleOf3Exponent

Full Usage: SIPrefix.LisOfPrefixesWithMultipleOf3Exponent

Returns: ISIPrefixList

Returns a list with prefixes, for which the exponent is a multiple of 3, including the prefix SIPrefix.None.

Returns: ISIPrefixList

SIPrefix.ListWithAllKnownPrefixes

Full Usage: SIPrefix.ListWithAllKnownPrefixes

Returns: ISIPrefixList

Returns a list with all known prefixes, including the prefix SIPrefix.None.

Returns: ISIPrefixList

SIPrefix.ListWithNonePrefixOnly

Full Usage: SIPrefix.ListWithNonePrefixOnly

Returns: ISIPrefixList

Returns a list that contains only the prefix SIPrefix.None.

Returns: ISIPrefixList

SIPrefix.MaxShortCutLength

Full Usage: SIPrefix.MaxShortCutLength

Returns: int

Gets the maximum length of the shortcuts of any of the known prefixes.

Returns: int

SIPrefix.Mega

Full Usage: SIPrefix.Mega

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Micro

Full Usage: SIPrefix.Micro

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Milli

Full Usage: SIPrefix.Milli

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.MinShortCutLength

Full Usage: SIPrefix.MinShortCutLength

Returns: int

Gets the minimum length of the shortcuts of any of the known prefixes.

Returns: int

SIPrefix.Nano

Full Usage: SIPrefix.Nano

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.None

Full Usage: SIPrefix.None

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Peta

Full Usage: SIPrefix.Peta

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Pico

Full Usage: SIPrefix.Pico

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.SmallestPrefix

Full Usage: SIPrefix.SmallestPrefix

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Tera

Full Usage: SIPrefix.Tera

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.TryGetPrefixFromExponent(exponent, prefix)

Full Usage: SIPrefix.TryGetPrefixFromExponent(exponent, prefix)

Parameters:
    exponent : int - The exponent.
    prefix : byref<SIPrefix> - If sucessfull, returns the prefix.

Returns: bool True if a known prefix with the given exponent was found; otherwise, false.

Try to get a known prefix with a given exponent.

exponent : int

The exponent.

prefix : byref<SIPrefix>

If sucessfull, returns the prefix.

Returns: bool

True if a known prefix with the given exponent was found; otherwise, false.

SIPrefix.TryGetPrefixFromShortcut(shortcut)

Full Usage: SIPrefix.TryGetPrefixFromShortcut(shortcut)

Parameters:
    shortcut : string - The shortcut of the prefix.

Returns: SIPrefix The prefix to which the given shortcut belongs. Null if no such prefix could be found.

Try the get a prefix given the prefix'es shortcut.

shortcut : string

The shortcut of the prefix.

Returns: SIPrefix

The prefix to which the given shortcut belongs. Null if no such prefix could be found.

ArgumentNullException shortcut

SIPrefix.Yocto

Full Usage: SIPrefix.Yocto

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Yotta

Full Usage: SIPrefix.Yotta

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Zepto

Full Usage: SIPrefix.Zepto

Returns: SIPrefix

Returns: SIPrefix

SIPrefix.Zetta

Full Usage: SIPrefix.Zetta

Returns: SIPrefix

Returns: SIPrefix