Skip To Content ArcGIS for Developers Sign In Dashboard

AreaUnit Class

(Esri::ArcGISRuntime::AreaUnit)

Indicates the units of measurement of an instance of AreaUnit, or area measurement operation. More...

Header: #include <AreaUnit>
Since: Esri::ArcGISRuntime 100.0
Inherits: Unit

Public Functions

AreaUnit()
AreaUnit(AreaUnitId areaUnitId)
AreaUnit(const LinearUnit &linearUnit)
AreaUnit(const AreaUnit &other)
AreaUnit(AreaUnit &&other)
AreaUnit(const Unit &other)
~AreaUnit()
AreaUnitId areaUnitId() const
double convertFrom(const AreaUnit &fromUnit, double area) const
double convertFromSquareMeters(double squareMeters) const
double convertTo(const AreaUnit &toUnit, double area) const
double convertToSquareMeters(double thisUnitValue) const
bool isValid() const
AreaUnit &operator=(const AreaUnit &other)
AreaUnit &operator=(AreaUnit &&other)

Static Public Members

AreaUnit squareFeet()
AreaUnit squareKilometers()
AreaUnit squareMeters()
AreaUnit squareMiles()

Detailed Description

Indicates the units of measurement of an instance of AreaUnit, or area measurement operation.

Instances of classes that inherit from the Units class, like this one does, are initialized as a specific unit of measurement. Each instance has properties for the unit name (singular, plural and abbreviated) and provides methods for unit conversion.

Member Function Documentation

AreaUnit::AreaUnit()

Default constructor.

AreaUnit::AreaUnit(AreaUnitId areaUnitId)

Creates an AreaUnit representing the specified areaUnitId.

AreaUnit::AreaUnit(const LinearUnit &linearUnit)

Creates an AreaUnit representing the AreaUnit conversion from specified linearUnit.

This function was introduced in Esri::ArcGISRuntime 100.6.

AreaUnit::AreaUnit(const AreaUnit &other)

Copy constructor from other AreaUnit.

AreaUnit::AreaUnit(AreaUnit &&other)

Move constructor from other AreaUnit.

AreaUnit::AreaUnit(const Unit &other)

Converting constructor from other Unit.

See also Downcast helper functions.

AreaUnit::~AreaUnit()

Destructor.

AreaUnitId AreaUnit::areaUnitId() const

Returns the AreaUnitId corresponding to this AreaUnit.

double AreaUnit::convertFrom(const AreaUnit &fromUnit, double area) const

Returns the area value area converted from another AreaUnit (fromUnit) into this AreaUnit.

double AreaUnit::convertFromSquareMeters(double squareMeters) const

Returns the area value squareMeters converted from square meters into this AreaUnit.

double AreaUnit::convertTo(const AreaUnit &toUnit, double area) const

Returns the area value area converted from this AreaUnit into toUnit units.

double AreaUnit::convertToSquareMeters(double thisUnitValue) const

Returns the angular value thisUnitValue converted from this AreaUnit into square meters.

bool AreaUnit::isValid() const

Gets whether this AreaUnit is valid.

A AreaUnit is valid if it is not empty and unitType is UnitType::AreaUnit.

Returns true if valid.

This function was introduced in Esri::ArcGISRuntime 100.2.

[static] AreaUnit AreaUnit::squareFeet()

Returns an AreaUnit object representing square feet (AreaUnitId::SquareFeet).

[static] AreaUnit AreaUnit::squareKilometers()

Returns an AreaUnit object representing square kilometers (AreaUnitId::SquareKilometers).

[static] AreaUnit AreaUnit::squareMeters()

Returns an AreaUnit object representing square meters (AreaUnitId::SquareMeters).

[static] AreaUnit AreaUnit::squareMiles()

Returns an AreaUnit object representing square miles (AreaUnitId::SquareMiles).

AreaUnit &AreaUnit::operator=(const AreaUnit &other)

Assignment operator from other AreaUnit.

AreaUnit &AreaUnit::operator=(AreaUnit &&other)

Move operator from other AreaUnit.


Feedback on this topic?