LinearUnit
=================

.. currentmodule:: axioma.cs

.. class:: LinearUnit

	Данный класс обеспечивает информацией о единицах измерения координатной системы

	Для получения экземпляров этого класса используйте фабрику координатных систем :meth:`axioma.cs.CoordSysFactory.unitById`

		.. code-block:: python
		
			from axioma.cs import *
			km_unit=CoordSysFactory.defaultCoordSysFactory().unitById(LinearUnit.MIUnit_Kilometer)
	
		.. csv-table:: Вид единиц измерения :data:`~axioma.cs.UnitCode`:
			:header: "Наименование величины", "Значение", "Описание", "Наименование"

			MIUnit_Unknown, -1, "Неизвестные единицы", ""
			MIUnit_Degree, 13, "Градусы", ""
			MIUnit_Mile, 0, "Мили", "mi"
			MIUnit_Kilometer, 1, "Километры", "km"
			MIUnit_Inch, 2, "Дюймы", "in"
			MIUnit_Foot, 3, "Футы", "ft"
			MIUnit_Yard, 4, "Ярды", "yd"
			MIUnit_Millimeter, 5, "Миллиметры", "mm"
			MIUnit_Centimeter, 6, "Сантиметры", "cm"
			MIUnit_Meter,7, "Метры", "m"
			MIUnit_UsFoot, 8, "Топографические футы", "survey ft"
			MIUnit_NauticalMile, 9, "Морские мили", "kmi"
			MIUnit_Link, 30, "Линки", "link"
			MIUnit_Chain, 31, "Чейны", "ch"
			MIUnit_Rod, 32, "Роды", "rd"

			MIUnit_SQ_Mile, 14, "кв. мили", "sq mi"
			MIUnit_SQ_Kilometer, 15, "кв. километры", "sq km"
			MIUnit_SQ_Inch, 16, "кв. дюймы", "sq in"
			MIUnit_SQ_Foot, 17, "кв. футы", "sq ft"
			MIUnit_SQ_Yard, 18, "кв. ярды", "sq yd"
			MIUnit_SQ_Millimeter, 19, "кв. миллиметры", "sq mm"
			MIUnit_SQ_Centimeter, 20, "кв. см", "sq cm"
			MIUnit_SQ_Meter, 21, "кв. м", "sq m"
			MIUnit_SQ_UsFoot, 22, "кв. топографические футы", "sq survey ft"
			MIUnit_SQ_NauticalMile, 23, "кв. морские мили", "sq nmi"
			MIUnit_Acre, 28, "акры", "acre"
			MIUnit_Hectare, 29, "гектары", "hectare"
			MIUnit_SQ_Link, 33, "кв. линки", "sq li"
			MIUnit_SQ_Chain, 34, "кв. чейны", "sq ch"
			MIUnit_SQ_Rod, 35, "кв. роды", "sq rd"

		.. py:function:: name()

			Наименование единицы измерения. Данное наименование может использоваться в формулах расчета.

			:return: Наименование
			:rtype: :class:`str`

		.. py:function:: description()

			Текстовое описание единицы измерения

			:return: Описание
			:rtype: :class:`str`

		.. py:function:: conversion()

			Коэффициент преобразования в метры

			:return: Коэффициент
			:rtype: :class:`float`

		.. py:function:: conversion(unit)

			Коэффициент преобразования в указанную единицу измерения

			:param unit: Ссылка на единицу измерения, коэффициент преобразования в которую нам необходимо получить
			:type unit: :class:`LinearUnit`
			:return: Коэффициент
			:rtype: :class:`float`

		.. py:function:: rusName()

			.. deprecated:: >1.2.2
				Используйте :meth:`localizedName`

			Наименование на русском языке

			:return: Наименование
			:rtype: :class:`str`

		.. py:function:: localizedName()

			Локализованное наименование

			.. versionadded:: >1.2.2

			:return: Наименование
			:rtype: :class:`str`

		.. py:function:: isDegree()

			Является ли данная единица измерения градусами

			:rtype: :class:`bool`

		.. py:function:: unitCode()

			Внутренний код единицы измерения, используемый в строке MapBasic

			:return: Код. Если градусы, возвращается -2. -1, если неизвестное значение
			:rtype: :class:`int`




