Query quantity characteristics

saf_describe_quantity is a function defined in quant.c.

Synopsis:

int saf_describe_quantity(SAF_ParMode pmode, SAF_Quantity *quantity, char **description, char **abbreviation, char **url, unsigned *flags, unsigned *power)

Formal Arguments:

  • quantity: Quantity about which to retrieve information.
  • description: If non-null then upon return this will point to an allocated copy of the quantity description.
  • abbreviation: If non-null then upon return this will point to an allocated copy of the quantity abbreviation if one is defined.
  • url: If non-null then upon return this will point to an allocated copy of the quantity documentation url if one is defined.
  • flags: If non-null then the special quantity flags are written into the location indicated by this pointer.
  • power: If non-null then upon return this seven-element array will be filled in with the powers of the seven basic quantities.

Description: Given a quantity this function returns any information which is known about that quantity.

Preconditions:

  • pmode must be valid. (low-cost)
  • quantity must be a valid quantity handle. (low-cost)

Return Value: A non-negative value is returned on success. Failure is indicated by a negative return value or the raising of an exception, depending on the error handling property of the library.

Parallel Notes: This function must be called collectively in the database communicator.

See Also: