UnitInfo Class: Difference between revisions
Jump to navigation
Jump to search
Chris Kahn (talk | contribs) No edit summary |
Chris Kahn (talk | contribs) |
||
| Line 8: | Line 8: | ||
== Properties == | == Properties == | ||
*ID (as ''integer'') {{APIComment| | *ID (as ''integer'') {{APIComment|Gets numerical ID of the unit.}} | ||
*Name (as ''string'') {{APIComment| | *Name (as ''string'') {{APIComment| Gets the name of the unit.}} | ||
*Abbreviation (as ''string'') {{APIComment| | *Abbreviation (as ''string'') {{APIComment|Gets abbreviation of the unit.}} | ||
*Multiplier (''as double'') {{APIComment| | *Multiplier (''as double'') {{APIComment|Gets the multiplier of the unit (i.e., the value to multiply by the Standard Base Unit (SBU), which determines how units are converted).}} | ||
Revision as of 23:26, 2 May 2014
Used with Repository.GetAllUnits to describe a unit of measurement that has been defined in the current repository.
In Synthesis desktop applications, these units are shown in the Manage Units window.
Constructors
- UnitInfo( Integer, String, String, Double ) Creates a new UnitInfo object to store the properties of a defined unit of measurement. This is automatically called by Repository.GetAllUnits.
Properties
- ID (as integer) Gets numerical ID of the unit.
- Name (as string) Gets the name of the unit.
- Abbreviation (as string) Gets abbreviation of the unit.
- Multiplier (as double) Gets the multiplier of the unit (i.e., the value to multiply by the Standard Base Unit (SBU), which determines how units are converted).