next up previous 264
Next: AST_SETACTIVEUNIT - Specify how the Unit attribute should be used
Up: AST Routine Descriptions
Previous: AST_SET - Set attribute values for an Object


AST_SET$<$X$>$ - Set an attribute value for an Object

Description:
This is a family of routines which set a specified attribute value for an Object using one of several different data types. The type is selected by replacing $<$X$>$ in the routine name by C, D, I, L or R, to supply a value in Character, Double precision, Integer, Logical or Real format, respectively.

If possible, the value you supply is converted to the type of the attribute. If conversion is not possible, an error will result.

Invocation:
CALL AST_SET$<$X$>$( THIS, ATTRIB, VALUE, STATUS )
Arguments:
THIS = INTEGER (Given)
Pointer to the Object.
ATTRIB = CHARACTER $*$ ( $*$ ) (Given)
A character string containing the name of the attribute whose value is to be set.
VALUE = $<$X$>$type (Given)
The value to be set for the attribute, in the data type corresponding to $<$X$>$.
STATUS = INTEGER (Given and Returned)
The global status.
Class Applicability:
Object
These routines apply to all Objects.
Examples:
CALL AST_SETC( PLOT, 'Title', CVALUE, STATUS )

Sets the Title attribute value for Object PLOT to the contents of the character variable CVALUE.
CALL AST_SETL( FRAME, 'Preserve', .TRUE., STATUS );

Sets the Preserve attribute value for Object FRAME to 1 (true).
Notes:
  • Attribute names are not case sensitive and may be surrounded by white space.

  • The logical value .FALSE. will translate to a numerical attribute value of zero and logical .TRUE. will translate to one.

  • An error will result if an attempt is made to set a value for a read-only attribute.


next up previous 264
Next: AST_SETACTIVEUNIT - Specify how the Unit attribute should be used
Up: AST Routine Descriptions
Previous: AST_SET - Set attribute values for an Object

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