next up previous
Next: AST_TEXT - Draw a text string for a Plot
Up: AST Routine Descriptions
Previous: AST_SPECMAP - Create a SpecMap

AST_TEST - Test if an Object attribute value is set   

Description:
This function returns a logical result to indicate whether a value has been explicitly set for one of an Object's attributes.

Invocation:
RESULT = AST_TEST( THIS, ATTRIB, STATUS )

Arguments:
THIS = INTEGER (Given)
Pointer to the Object.
ATTRIB = CHARACTER * ( * ) (Given)
A character string containing the name of the attribute to be tested.
STATUS = INTEGER (Given and Returned)
The global status.

Class Applicability:
Object
This routine applies to all Objects.

Returned Value:
AST_TEST = LOGICAL
.TRUE. if a value has previously been explicitly set for the attribute (and hasn't been cleared), otherwise .FALSE..

Notes:
  • Attribute names are not case sensitive and may be surrounded by white space.
  • A value of .FALSE. will be returned if this function is invoked with STATUS set to an error value, or if it should fail for any reason.
  • A value of .FALSE. will also be returned if this function is used to test a read-only attribute, although no error will result.



next up previous
Next: AST_TEXT - Draw a text string for a Plot
Up: AST Routine Descriptions
Previous: AST_SPECMAP - Create a SpecMap

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

Copyright (C) 2003 Central Laboratory of the Research Councils