AreaUnit Class
Indicates the units of measurement of an instance of AreaUnit, or area measurement operation. More...
| Header: | #include <AreaUnit> |
| Since: | Esri::ArcGISRuntime 100.0 |
| Inherits: | Esri::ArcGISRuntime::Unit |
This class was introduced in Esri::ArcGISRuntime 100.0.
Public Functions
| AreaUnit(const Esri::ArcGISRuntime::Unit &other) | |
| AreaUnit(Esri::ArcGISRuntime::AreaUnit &&other) | |
| AreaUnit(const Esri::ArcGISRuntime::AreaUnit &other) | |
| AreaUnit(const Esri::ArcGISRuntime::LinearUnit &linearUnit) | |
| AreaUnit(Esri::ArcGISRuntime::AreaUnitId areaUnitId) | |
| AreaUnit() | |
| Esri::ArcGISRuntime::AreaUnit & | operator=(Esri::ArcGISRuntime::AreaUnit &&other) |
| Esri::ArcGISRuntime::AreaUnit & | operator=(const Esri::ArcGISRuntime::AreaUnit &other) |
| virtual | ~AreaUnit() override |
| Esri::ArcGISRuntime::AreaUnitId | areaUnitId() const |
| double | convertFrom(const Esri::ArcGISRuntime::AreaUnit &fromUnit, double area) const |
| double | convertFromSquareMeters(double squareMeters) const |
| double | convertTo(const Esri::ArcGISRuntime::AreaUnit &toUnit, double area) const |
| double | convertToSquareMeters(double thisUnitValue) const |
| bool | isValid() const |
Static Public Members
| Esri::ArcGISRuntime::AreaUnit | squareFeet() |
| Esri::ArcGISRuntime::AreaUnit | squareKilometers() |
| Esri::ArcGISRuntime::AreaUnit | squareMeters() |
| Esri::ArcGISRuntime::AreaUnit | squareMiles() |
Detailed Description
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(const Esri::ArcGISRuntime::Unit &other)
Converting constructor from other Unit.
See also Downcast helper functions.
AreaUnit::AreaUnit(Esri::ArcGISRuntime::AreaUnit &&other)
Move constructor from other AreaUnit.
AreaUnit::AreaUnit(const Esri::ArcGISRuntime::AreaUnit &other)
Copy constructor from other AreaUnit.
AreaUnit::AreaUnit(const Esri::ArcGISRuntime::LinearUnit &linearUnit)
Creates an AreaUnit representing the AreaUnit conversion from specified linearUnit.
This function was introduced in Esri::ArcGISRuntime 100.6.
AreaUnit::AreaUnit(Esri::ArcGISRuntime::AreaUnitId areaUnitId)
Creates an AreaUnit representing the specified areaUnitId.
AreaUnit::AreaUnit()
Default constructor.
Esri::ArcGISRuntime::AreaUnit &AreaUnit::operator=(Esri::ArcGISRuntime::AreaUnit &&other)
Move operator from other AreaUnit.
Esri::ArcGISRuntime::AreaUnit &AreaUnit::operator=(const Esri::ArcGISRuntime::AreaUnit &other)
Assignment operator from other AreaUnit.
[override virtual] AreaUnit::~AreaUnit()
Destructor.
Esri::ArcGISRuntime::AreaUnitId AreaUnit::areaUnitId() const
Returns the AreaUnitId corresponding to this AreaUnit.
double AreaUnit::convertFrom(const Esri::ArcGISRuntime::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 Esri::ArcGISRuntime::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] Esri::ArcGISRuntime::AreaUnit AreaUnit::squareFeet()
Returns an AreaUnit object representing square feet (AreaUnitId::SquareFeet).
[static] Esri::ArcGISRuntime::AreaUnit AreaUnit::squareKilometers()
Returns an AreaUnit object representing square kilometers (AreaUnitId::SquareKilometers).
[static] Esri::ArcGISRuntime::AreaUnit AreaUnit::squareMeters()
Returns an AreaUnit object representing square meters (AreaUnitId::SquareMeters).
[static] Esri::ArcGISRuntime::AreaUnit AreaUnit::squareMiles()
Returns an AreaUnit object representing square miles (AreaUnitId::SquareMiles).