AST_TIMEMAP

Create a TimeMap

Description:

This function creates a new TimeMap and optionally initialises its attributes.

A TimeMap is a specialised form of 1-dimensional Mapping which can be used to represent a sequence of conversions between standard time coordinate systems.

When a TimeMap is first created, it simply performs a unit (null) Mapping. Using the AST_TIMEADD routine, a series of coordinate conversion steps may then be added. This allows multi-step conversions between a variety of time coordinate systems to be assembled out of a set of building blocks.

For details of the individual coordinate conversions available, see the description of the AST_TIMEADD routine.

Invocation

RESULT = AST_TIMEMAP( FLAGS, OPTIONS, STATUS )

Arguments

FLAGS = INTEGER (Given)
This argument is reserved for future use and should currently always be set to zero.
OPTIONS = CHARACTER ( ) (Given)
A character string containing an optional comma-separated list of attribute assignments to be used for initialising the new TimeMap. The syntax used is identical to that for the AST_SET routine. If no initialisation is required, a blank value may be supplied.
STATUS = INTEGER (Given and Returned)
The global status.

Returned Value

AST_TIMEMAP = INTEGER
A pointer to the new TimeMap.

Notes: