Next: AST_CURRENTTIME - Return the current system time
Up: AST Routine Descriptions
Previous: AST_CONVERT - Determine how to convert between two coordinate systems
AST_COPY
-
Copy an Object
- Description:
- This function creates a copy of an Object and returns a pointer
to the resulting new Object. It makes a "deep" copy, which
contains no references to any other Object (i.e. if the original
Object contains references to other Objects, then the actual
data are copied, not simply the references). This means that
modifications may safely be made to the copy without indirectly
affecting any other Object.
- Invocation:
- RESULT = AST_COPY( THIS, STATUS )
- Arguments:
-
THIS = INTEGER (Given)
-
Pointer to the Object to be copied.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
- Class Applicability:
-
Object
-
This function applies to all Objects.
- Returned Value:
-
AST_COPY = INTEGER
-
Pointer to the new Object.
- Notes:
- A null Object pointer (AST__NULL) will be returned if this
function is invoked with STATUS set to an error value, or if it
should fail for any reason.
Next: AST_CURRENTTIME - Return the current system time
Up: AST Routine Descriptions
Previous: AST_CONVERT - Determine how to convert between two coordinate systems
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