- ←Prev
- AST
A Library for Handling
World Coordinate Systems
in Astronomy - Next→
- TOC ↑
Description:
This is a family
of functions which test whether an
Object is a member of the class called
CLASS
,
or of any class derived from it.
Invocation
RESULT =
AST_ISACLASS(
THIS, STATUS )
Arguments
THIS = INTEGER (Given)
Pointer to the Object.
STATUS = INTEGER (Given and
Returned)
The global status.
Applicability
Object
These functions apply to all Objects.
Returned Value
AST_ISACLASS
= LOGICAL
.TRUE. if the Object belongs to the class called
CLASS
(or to a class derived from it), otherwise .FALSE..
Examples:
MEMBER = AST_ISAFRAME( OBJ,
STATUS );
Tests whether Object OBJ is a member of the Frame class, or of any class derived from a
Frame. Notes:
-
Every AST class provides a function
(AST_ISACLASS)
of this form, where CLASS
should be replaced by the class name.
-
This function attempts to execute even if STATUS is set to an error value on entry, although no further
error report will be made if it subsequently fails under these circumstances.
-
A value of .FALSE. will be returned if this function should fail for any reason. In particular, it will fail
if the pointer supplied does not identify an Object of any sort.
Copyright (C) 2021 East Asian Observatory
- ←Prev
- AST
A Library for Handling
World Coordinate
Systems
in Astronomy - Next→
- TOC ↑