UnitInfo Class - Revision history

Kate Racaza at 15:04, 8 April 2016

2016-04-08T15:04:45Z

← Older revision		Revision as of 15:04, 8 April 2016
Line 2:		Line 2:


	<onlyinclude>~~Stores or retrieves~~ the ~~properties of a~~ unit of measurement.</onlyinclude>		<onlyinclude>Represents the unit of measurement used by an associated [[Repository_Class\|Repository]] object.</onlyinclude>

	== Properties ==		== Properties ==

Kate Racaza at 20:53, 30 March 2016

2016-03-30T20:53:41Z

← Older revision		Revision as of 20:53, 30 March 2016
Line 2:		Line 2:


	<onlyinclude>Stores the properties of a unit of measurement.</onlyinclude>		<onlyinclude>Stores or retrieves the properties of a unit of measurement.</onlyinclude>

	== Properties ==		== Properties ==

Kate Racaza at 21:28, 13 November 2015

2015-11-13T21:28:16Z

← Older revision		Revision as of 21:28, 13 November 2015
Line 1:		Line 1:
	{{Template:API}}{{Template:~~APIBreadcrumbClass~~}}		{{Template:API}}{{Template:APIBreadcrumb}}

Kate Racaza at 23:17, 5 November 2015

2015-11-05T23:17:06Z

← Older revision		Revision as of 23:17, 5 November 2015
Line 17:		Line 17:


	==~~Related Links~~==


			==See Also==
	*[[Repository.Unit.GetAllUnits\|Repository.Unit.GetAllUnits Method]]		*[[Repository.Unit.GetAllUnits\|Repository.Unit.GetAllUnits Method]]

Kate Racaza at 19:10, 29 October 2015

2015-10-29T19:10:19Z

← Older revision		Revision as of 19:10, 29 October 2015
Line 7:		Line 7:
	{\| {{APITable}}		{\| {{APITable}}
	\|-		\|-
	\| style="width: 130px;"\|		\| style="width: 130px;"\|Abbreviation\|\|Gets or sets the abbreviation of the unit. '''String'''.

	\|-
	\|Abbreviation\|\|Gets or sets the abbreviation of the unit. '''String'''.
	\|-		\|-
	\|ID\|\|Gets or sets the numeric ID of the unit. '''Integer'''.		\|ID\|\|Gets or sets the numeric ID of the unit. '''Integer'''.
Line 18:		Line 15:
	\|Name\|\|Gets or sets the name of the unit. '''String'''.		\|Name\|\|Gets or sets the name of the unit. '''String'''.
	\|}		\|}


			==Related Links==
			*[[Repository.Unit.GetAllUnits\|Repository.Unit.GetAllUnits Method]]

Kate Racaza: /* Properties */

2015-08-31T21:41:25Z

Properties

← Older revision		Revision as of 21:41, 31 August 2015
Line 7:		Line 7:
	{\| {{APITable}}		{\| {{APITable}}
	\|-		\|-
	\| style="width: 130px;"\|~~ID\|\|Gets or sets the numeric ID of the unit. '''Integer'''.~~		\| style="width: 130px;"\|

	\|-		\|-
	\|~~Name~~\|\|Gets or sets the ~~name~~ of the unit. '''String'''.		\|Abbreviation\|\|Gets or sets the abbreviation of the unit. '''String'''.
	\|-		\|-
	\|~~Abbreviation~~\|\|Gets or sets the ~~abbreviation~~ of the unit. '''~~String~~'''.		\|ID\|\|Gets or sets the numeric ID of the unit. '''Integer'''.
	\|-		\|-
	\|Multiplier\|\|Gets or sets the conversion factor, which is defined in relation to a repository's System Base Unit (SBU). '''Double'''.		\|Multiplier\|\|Gets or sets the conversion factor, which is defined in relation to a repository's System Base Unit (SBU). '''Double'''.
			\|-
			\|Name\|\|Gets or sets the name of the unit. '''String'''.
	\|}		\|}

Kate Racaza at 17:15, 19 August 2015

2015-08-19T17:15:06Z

← Older revision		Revision as of 17:15, 19 August 2015
Line 7:		Line 7:
	{\| {{APITable}}		{\| {{APITable}}
	\|-		\|-
	\| style="width: 130px;"\|ID\|\|Gets or sets the ~~numerical~~ ID of the unit. '''Integer'''.		\| style="width: 130px;"\|ID\|\|Gets or sets the numeric ID of the unit. '''Integer'''.
	\|-		\|-
	\|Name\|\|Gets or sets the name of the unit. '''String'''.		\|Name\|\|Gets or sets the name of the unit. '''String'''.

Kate Racaza at 18:00, 7 August 2015

2015-08-07T18:00:13Z

← Older revision		Revision as of 18:00, 7 August 2015
Line 2:		Line 2:


	<onlyinclude>Stores the properties of ~~units~~ of measurement.</onlyinclude>		<onlyinclude>Stores the properties of a unit of measurement.</onlyinclude>

	== Properties ==		== Properties ==

Kate Racaza at 17:53, 7 August 2015

2015-08-07T17:53:09Z

← Older revision		Revision as of 17:53, 7 August 2015
Line 1:		Line 1:
	{{Template:~~APIClass\|Repository Class\|Repository~~}}		{{Template:API}}{{Template:APIBreadcrumbClass}}
	{{Template:~~UnitInfo Class.Cmt~~}}

	~~In Synthesis desktop applications, these~~ units ~~are shown in the Manage Units window~~.
	<~~!--~~		<onlyinclude>Stores the properties of units of measurement.</onlyinclude>
	~~== Constructors ==~~
	*[[UnitInfo Constructors\|UnitInfo( Integer, String, String, Double )]] {{APIComment\|{{Template:UnitInfo Constructors.Cmt}}}}-->

	== Properties ==		== Properties ==
	*ID (as ''integer'') {{~~APIComment~~\|Gets numerical ID of the unit.}}		{\| {{APITable}}
	*Name (as ''~~string~~''~~) {{APIComment~~\| Gets the name of the unit.}}		\|-
	*Abbreviation (as ''~~string~~''~~) {{APIComment~~\|Gets abbreviation of the unit.}}		\| style="width: 130px;"\|ID\|\|Gets or sets the numerical ID of the unit. '''Integer'''.
	*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~~).}}		\|-
			\|Name\|\|Gets or sets the name of the unit. '''String'''.
	~~== Usage Example ==~~		\|-
	~~In this usage example, the multiplier for the first unit of measurement in a repository is retrieved.~~		\|Abbreviation\|\|Gets or sets the abbreviation of the unit. '''String'''.
	~~{{APIComment\|~~'~~Declare a new repository connection object.}}~~		\|-
	~~Dim MyRepository As New Repository~~		\|Multiplier\|\|Gets or sets the conversion factor, which is defined in relation to a repository's System Base Unit (SBU). '''Double'''.
			\|}
	~~{{APIComment\|~~'~~Connect to the first project in the specified Synthesis repository.}}~~
	~~Dim Success As Boolean = False~~
	~~Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")~~
	~~MyRepository.SetCurrentProject(1)~~

	~~{{APIComment\|~~'~~Get the list of units for the current project for the connected repository. See [[Repository.GetAllUnits\|GetAllUnits]].}}~~
	~~Dim ListOfUnits() As UnitInfo~~
	~~ListOfUnits = MyRepository~~.~~GetAllUnits()~~

	~~{{APIComment~~\|~~'Get the multiplier for the first unit in the list.}~~}
	~~Dim Mult As Double~~
	~~Mult = ListOfUnits(0).Multiplier~~

Chris Kahn: /* Usage Example */

2014-05-27T22:24:43Z

Usage Example

← Older revision		Revision as of 22:24, 27 May 2014
Line 27:		Line 27:
	ListOfUnits = MyRepository.GetAllUnits()		ListOfUnits = MyRepository.GetAllUnits()

	{{APIComment\|'Get the multiplier for the first unit in the list.		{{APIComment\|'Get the multiplier for the first unit in the list.}}
	Dim Mult As Double		Dim Mult As Double
	Mult = ListOfUnits(0).Multiplier		Mult = ListOfUnits(0).Multiplier