Inner Drive Extensible Architecture

## Area Structure |

Represents the quantity of a two-dimensional area in space.

Inheritance Hierarchy

Syntax

C#

[SerializableAttribute] [JsonObjectAttribute(ItemTypeNameHandling = TypeNameHandling.Auto)] public struct Area : IAdditionOperators<Area, Area, Area>, IAdditionOperators<Area, double, Area>, IAdditionOperators<Area, int, Area>, ICloneable, IComparable, IComparable<Area>, IComparisonOperators<Area, Area, bool>, IEqualityOperators<Area, Area, bool>, IComparisonOperators<Area, double, bool>, IEqualityOperators<Area, double, bool>, IConvertible<Area>, IDivisionOperators<Area, double, Area>, IDivisionOperators<Area, int, Area>, IEquatable<Area>, IMeasurable, IFormattable, IMinMaxValue<Area>, IMultiplyOperators<Area, double, Area>, IMultiplyOperators<Area, int, Area>, ISubtractionOperators<Area, Area, Area>, ISubtractionOperators<Area, double, Area>, ISubtractionOperators<Area, int, Area>, IUnaryNegationOperators<Area, Area>, ISpanFormattable

The Area type exposes the following members.

Constructors

Name | Description | |
---|---|---|

Area(Double) | Creates a new instance of Area with a particular value. | |

Area(Double, Type) | Creates a new instance of Area with a particular value and Unit whose Type is specified | |

Area(Length, Length) | Creates a new Area whose value is the multiple of two Length values. | |

Area(Double, Unit, MetricExponent) | Creates a new instance of Area with a particular value and Unit assuming that value is already raised or lowered to the power of exponent. |

Properties

Name | Description | |
---|---|---|

Accuracy | Represents the degree confidence that the quantity represented equals the quantity actually measured, controlling how the CompareTo<T> method behaves. | |

DefaultUnit |
Gets the Type of the Unit in which the
IMeasurableclass is denominated.
| |

MaxValue | Gets the maximum value of the current type. | |

MinValue | Gets the minimum value of the current type. | |

Name | Gets the name of the type of measurement. | |

Precision | Represents the range within which the measurement is correct, controlling how the ToString() method behaves. | |

Unit | Gets the Unit in which the IMeasurable object is denominated. | |

Value | Gets or sets the quantity of units represented by the IMeasurable object. |

Methods

Name | Description | |
---|---|---|

Add(Area, Area) | Adds two instances of Area together. | |

Add(Area, Double) | Adds an instance of Area to an instance of Double. | |

Clone | Creates a new object that is a copy of the current instance. | |

CompareTo | Compares 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. | |

ConvertTo(Type) | Converts the instance into a new IMeasurable instance denominated in the measurement units provided. | |

ConvertTo(Unit) | Converts the instance into a new instance of the same type denominated in the measurement units provided. | |

Divide | Divides an instance of Area by a double-precision value. | |

Equals(Area) | Indicates whether the current object is equal to another object of the same type. | |

Equals(Object) | Indicates whether this instance and a specified object are equal. (Overrides ValueTypeEquals(Object)) | |

Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) | |

GetHashCode | Returns the hash code for this instance. (Overrides ValueTypeGetHashCode) | |

GetType | Gets the Type of the current instance. (Inherited from Object) | |

IsInfinity | Returns a value indicating whether the specified number evaluates to negative or positive infinity. | |

IsNaN | Returns a value indicating whether the specified number evaluates to a value that is not a number (NaN). | |

IsNegativeInfinity | Returns a value indicating whether the specified number evaluates to negative infinity (NegativeInfinity). | |

IsPositiveInfinity | Returns a value indicating whether the specified number evaluates to positive infinity (PositiveInfinity). | |

MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |

Multiply | Multiplies an instance of Area by a double-precision value. | |

Negate | Negates the value of the specified Area operand. | |

Subtract(Area, Area) | Subtracts one instance of Area from another. | |

Subtract(Area, Double) | Subtracts an instance of Double from an instance of Area. | |

ToSquareRoot | Finds the square root of this Area. | |

ToString | Returns the fully qualified type name of this instance. (Overrides ValueTypeToString) | |

ToString(MetricExponent) | Converts the numeric value of this instance to its equivalent String representation, using the metric exponent provided if appropriate to the Unit type. | |

ToString(String) | Converts the numeric value of this instance to its equivalent String representation, using the specified format. | |

ToString(String, MetricExponent) | Converts the numeric value of this instance to its equivalent String representation, using the specified format and metric exponent. | |

ToString(String, IFormatProvider) | Formats the value of the current instance using the specified format. | |

ToString(String, MetricExponent, IFormatProvider) | Formats the value of the current instance using the specified format. | |

TryFormat | Tries to format the value of the current instance into the provided span of characters. |

Operators

Name | Description | |
---|---|---|

Addition(Area, Area) | Adds two values together to compute their sum. | |

Addition(Area, Double) | Adds two values together to compute their sum. | |

Addition(Area, Int32) | Adds two values together to compute their sum. | |

Division(Area, Double) | Divides an instance of Area by a double-precision value. | |

Division(Area, Int32) | Divides one value by another to compute their quotient. | |

Equality(Area, Area) | Compares two values to determine equality. | |

Equality(Area, Double) | Compares two values to determine equality. | |

Equality(Double, Area) | Compares an instance of Area with an instance of Double for equality. | |

GreaterThan(Area, Area) | Compares two values to determine which is greater. | |

GreaterThan(Area, Double) | Compares two values to determine which is greater. | |

GreaterThan(Double, Area) | Compares an instance of Area to an instance of Double for different values. | |

GreaterThanOrEqual(Area, Area) | Compares two values to determine which is greater or equal. | |

GreaterThanOrEqual(Area, Double) | Compares two values to determine which is greater or equal. | |

GreaterThanOrEqual(Double, Area) | Compares an instance of Area to an instance of Double for different values. | |

(Area to Double) | Creates a new Double value from a given Area object. | |

(Double to Area) | Creates a new Area object from a Double value. | |

Inequality(Area, Area) | Compares two values to determine inequality. | |

Inequality(Area, Double) | Compares two values to determine inequality. | |

Inequality(Double, Area) | Compares an instance of Area with an instance of Double for inequality. | |

LessThan(Area, Area) | Compares two values to determine which is less. | |

LessThan(Area, Double) | Compares two values to determine which is less. | |

LessThan(Double, Area) | Compares an instance of Area to an instance of Double for different values. | |

LessThanOrEqual(Area, Area) | Compares two values to determine which is less or equal. | |

LessThanOrEqual(Area, Double) | Compares two values to determine which is less or equal. | |

LessThanOrEqual(Double, Area) | Compares an instance of Area to an instance of Double for different values. | |

Multiply(Area, Double) | Multiplies two values together to compute their product. | |

Multiply(Area, Int32) | Multiplies two values together to compute their product. | |

Subtraction(Area, Area) | Subtracts two values to compute their difference. | |

Subtraction(Area, Double) | Subtracts two values to compute their difference. | |

Subtraction(Area, Int32) | Subtracts two values to compute their difference. | |

UnaryNegation(Area) | Computes the unary negation of a value. |

Fields

Name | Description | |
---|---|---|

Epsilon | Represents the smallest value of Accuracy that will successfully evaluate equality without boundary condition errors. | |

MaxPrecision | Represents the maximum precision with which a value can be displayed. | |

MinPrecision | Represents the minimum precision with which a value can be displayed. |

Explicit Interface Implementations

Name | Description | |
---|---|---|

IComparableCompareTo | Compares 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. |

Remarks

Measurable objects are generally immutable structures. Thus,
the properties of measurable objects expose property get methods
only. The exceptions—Accuracy and Precision—do
not change the underlying value of the measurement, only its behavior; therefore
these members may be changed as needed after the measurement is instantiated.

See Also