next up previous 264
Next: AST_MAPPUTELEMX - Put a value into an element of a vector value in a KeyMap
Up: AST Routine Descriptions
Previous: AST_MAPPUT0X - Add a scalar value to a KeyMap


AST_MAPPUT1$<$X$>$ - Add a vector value to a KeyMap

Description:
This is a set of routine for adding vector values to a KeyMap. You should use a routine which matches the data type of the data you wish to add to the KeyMap by replacing $<$X$>$ in the generic routine name AST_MAPPUT1$<$X$>$ by an appropriate 1-character type code (see the "Data Type Codes" section below for the code appropriate to each supported data type).
Invocation:
CALL AST_MAPPUT1$<$X$>$( THIS, KEY, SIZE, VALUE, COMMENT, STATUS )
Arguments:
THIS = INTEGER (Given)
Pointer to the KeyMap in which to store the supplied values.
KEY = CHARACTER $*$ ( $*$ ) (Given)
A character string to be stored with the values, which can later be used to identify the values. Trailing spaces are ignored. The supplied string is converted to upper case before use if the KeyCase attribute is currently set to zero.
SIZE = INTEGER (Given)
The number of elements in the supplied array of values.
VALUE( $*$ ) = $<$X$>$type (Given)
The array of values to be stored. The data type of this value should match the 1-character type code appended to the routine name (e.g. if you are using AST_MAPPUT1A, the type of this value should be "integer pointer for an AstObject)".
COMMENT = CHARACTER $*$ ( $*$ ) (Given)
A comment string to be stored with the values.
STATUS = INTEGER (Given and Returned)
The global status.
Notes:
  • If the supplied key is already in use in the KeyMap, the new values will replace the old values.
Data Type Codes
To select the appropriate routine, you should replace $<$X$>$ in the generic routine name AST_MAPPUT1$<$X$>$ with a 1-character data type code, so as to match the data type $<$X$>$type of the data you are processing, as follows:
  • D: DOUBLE PRECISION

  • R: REAL

  • I: INTEGER

  • C: CHARACTER

  • A: INTEGER used to identify an AstObject

  • S: INTEGER$*$2 (short integer)

  • B: Unsigned byte

For example, AST_MAPPUT1D would be used to store DOUBLE PRECISION values, while AST_MAPPUT1I would be used to store INTEGER, etc.


next up previous 264
Next: AST_MAPPUTELEMX - Put a value into an element of a vector value in a KeyMap
Up: AST Routine Descriptions
Previous: AST_MAPPUT0X - Add a scalar value to a KeyMap

AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 210
R.F. Warren-Smith & D.S. Berry
24th May 2011
E-mail:ussc@star.rl.ac.uk

Copyright (C) 2009 Science \& Technology Facilities Council