Unit of Measure

Modules
	UOM Errors

Functions
TCCORE_API int	UOM_ask_name (tag_t uom, char **name)
TCCORE_API int	UOM_ask_symbol (tag_t uom, char **symbol)
TCCORE_API int	UOM_extent (int *n_uoms, tag_t **uoms)
TCCORE_API int	UOM_find_by_name (const char *name, tag_t *uom)
TCCORE_API int	UOM_find_by_symbol (const char *symbol, tag_t *uom)

Detailed Description

This module provides support for the creation and maintenance of Units of Measure (UOMs) for a Teamcenter Engineering installation. A UOM can be attached to an Item to indicate, for example, that usages of engine oil part number 3487 must be expressed in quantities measured in pints.

Standard UOMs are defined for a Teamcenter Engineering installation by the Teamcenter Engineering system administrator using either System Administration interactive user interface or via this ITK module.

Note

The prototypes for these functions are in header file uom.h.

Common Return Values

Return Value	Description
POM_attr_null_forbidden	Name or symbol is null or zero length.
POM_inst_violates_unique	If a UOM of the same name and/or symbol already exists in the database, this error will be returned when you attempt to save the new UOM.
POM_invalid_string	Name or symbol is too long.
UOM_insufficient_privilege	This function is only available to Teamcenter Engineering system administrators.
UOM_invalid	Tag supplied is not a valid UOM.

Function Documentation

TCCORE_API int UOM_ask_name	(	tag_t	uom,
		char **	name
	)

Inquires on the name of a UOM.

Parameters

uom	(I) Tag of the UOM
name	(OF) Returns the full name of the UOM

TCCORE_API int UOM_ask_symbol	(	tag_t	uom,
		char **	symbol
	)

Inquires on the symbol text of a UOM.

Parameters

uom	(I) Tag of the UOM
symbol	(OF) Returns the symbol text of the UOM

TCCORE_API int UOM_extent	(	int *	n_uoms,
		tag_t **	uoms
	)

Returns a list of the UOMs defined for this Teamcenter Engineering installation.

Parameters

n_uoms	(O) Returns the number of UOMs in the list
uoms	(OF) n_uoms Returned array of the tags of the UOMs

TCCORE_API int UOM_find_by_name	(	const char *	name,
		tag_t *	uom
	)

Returns the tag of the UOM with the given name.

Parameters

name	(I) Name of the UOM
uom	(O) Returns the tag of the UOM. If no such UOM exists in the database, NULLTAG is returned.

TCCORE_API int UOM_find_by_symbol	(	const char *	symbol,
		tag_t *	uom
	)

Returns the tag of the UOM with the given symbol.

Parameters

symbol	(I) Symbol of the UOM
uom	(O) Returns the tag of the UOM. If no such UOM exists in the database, NULLTAG is returned.