next up previous 264
Next: astMapGet0X - Get a scalar value from a KeyMap
Up: AST Function Descriptions
Previous: astMapBox - Find a bounding box for a Mapping


astMapCopy - Copy entries from one KeyMap into another

Description:
This function copies all entries from one KeyMap into another.
Synopsis:
void astMapCopy( AstKeyMap $*$this, AstKeyMap $*$that )
Parameters:
this
Pointer to the destination KeyMap.
that
Pointer to the source KeyMap.
Notes:
  • Entries from the source KeyMap will replace any existing entries in the destination KeyMap that have the same key.

  • The one exception to the above rule is that if a source entry contains a scalar KeyMap entry, and the destination contains a scalar KeyMap entry with the same key, then the source KeyMap entry will be copied into the destination KeyMap entry using this function, rather than simply replacing the destination KeyMap entry.

  • If the destination entry has a non-zero value for its MapLocked attribute, then an error will be reported if the source KeyMap contains any keys that do not already exist within the destination KeyMap.


next up previous 264
Next: astMapGet0X - Get a scalar value from a KeyMap
Up: AST Function Descriptions
Previous: astMapBox - Find a bounding box for a Mapping

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

Copyright (C) 2009 Science \& Technology Facilities Council