Table of Contents
TGIS_CSUnits class
DK for ActiveX | TatukGIS_XDK11.TGIS_CSUnits | Classes | Methods | Properties
Unit of measurement definition for linear, angular, areal, or automatic unit selection with conversion factors to base units.
Syntax
// C# public class TGIS_CSUnits : ITGIS_CSUnits { }
' VisualBasic Public Class TGIS_CSUnits Implements ITGIS_CSUnits End Class
// Oxygene type TGIS_CSUnits = public class end;
Implements
Methods
| Name | Visibility | Description | |
|---|---|---|---|
| AsAngular | public | Convert an angular value to a string representation with the appropriate unit symbol. | |
| AsAreal | public | Convert an areal value to a string representation with the appropriate unit symbol. | |
| AsLinear | public | Convert a linear value to a string representation with the appropriate unit symbol. | |
| Assign_ | public | Copies the shared definition fields from another object. (Inherited from ITGIS_CSAbstract) |
|
| AttachDelphiObj | public | Only for internal use of TatukGIS. (Inherited from ITBaseObject) |
|
| AutoSelect | public | Return the most appropriate subunit for the specified value. | |
| Create_ | public | Create an automatic unit definition based on an ordered list of subunits. | |
| Create_2 | public | Create a unit definition with explicit symbol, type, and conversion factor. | |
| DelphiObj | public | Only for internal use of TatukGIS. (Inherited from ITBaseObject) |
|
| FromBase | public | Convert a value from the corresponding base unit to the current unit. | |
| FromUnits | public | Convert a value expressed in the specified unit to the current unit. | |
| MarkDeprecated | public | Marks this coordinate system definition as deprecated or current. (Inherited from ITGIS_CSAbstract) |
|
| ToBase | public | Convert a value from the current unit to the corresponding base unit. | |
| ToUnits | public | Convert a value from the current unit to the specified target unit. | |
Properties
| Name | Visibility | Description | |
|---|---|---|---|
| Deprecated | public | Indicates whether this definition is deprecated. (Inherited from ITGIS_CSAbstract) |
|
| DescriptionEx | public | Descriptive name; for internal use of TGIS_CSAbstractListHelper. (Inherited from ITGIS_CSAbstract) |
|
| Description_ | public | Description of the coordinate system definition. (Inherited from ITGIS_CSAbstract) |
|
| EPSG | public | EPSG code. (Inherited from ITGIS_CSAbstract) |
|
| Factor | public | Factor between unit and basic unit (meter or radians); for example factor for kilometer is 1000. | |
| FriendlyName | public | Friendly name constructed from the WKT name and EPSG code. (Inherited from ITGIS_CSAbstract) |
|
| MasterEPSG | public | EPSG code of the object for which the current object is an alias. (Inherited from ITGIS_CSAbstract) |
|
| Symbol | public | Symbolic name. | |
| UnitsType | public | Type of units: angular, linear, areal. | |
| WKT | public | WKT name. (Inherited from ITGIS_CSAbstract) |
|
Remarks
PURPOSE: Encapsulate unit definitions used by the coordinate system framework for distance, angle, and area values. Supports conversions to and from base units such as meters, radians, and square meters.
BEHAVIOR: Each unit stores an EPSG (European Petroleum Survey Group) code, a WKT (Well-Known Text) name, a symbol, a unit type, and a conversion factor relative to the appropriate base unit. Automatic units use an ordered subunit list to select the most suitable display unit for a value.
CONSTRAINTS: Conversion factors are relative to base units. Automatic units depend on an ordered subunit array. EPSG and WKT uniqueness may be enforced by the owning list.