ObitReturn.h File Reference

Output utility dumper. More...

#include "Obit.h"
#include "ObitFile.h"
#include "ObitErr.h"
#include "ObitInfoList.h"

Go to the source code of this file.

Functions
ObitIOCode	ObitReturnDumpRetCode (gint retCode, gchar *outfile, ObitInfoList *list, ObitErr *err)
	Public: Dump return code and ObitInfoList to a text file.
ObitIOCode	ObitReturnDump (gchar *outfile, ObitInfoList *list, ObitErr *err)
	Public: Dump ObitInfoList to a text file.

---

Detailed Description

Output utility dumper.

This file contains utility functions for writing program output parameters to a text file. Parameters are passed in an ObitInfoList. Supported types are:

• integers
• boolean
• floats
• character strings

To use do to following:

• Create an ObitInfoList and fill with values
• Use ObitReturnDump to write text file

output file

The text input file is in keyword=value form. An entry consists of a header line beginning with "&Key = ", followed by the name of the entry, a data type code and the dimensionality as a Fortran dimensionality, (n,m) = n x m array with elements on the n axis varying most rapidly. Values start on the second line of an entry and take as many lines as necessary with a list of blank separated values. Character strings are one per line. The type codes are:

• Str String, first element of dimension is number of characters in each string, Note: these are NOT NULL terminated.
• Int Integer as oint.
• Boo Boolean, 'T' = true, 'F' = false
• Dbl Float
• Flt Double # Example Input file $Key = stringD Str (48,1,1) somefile.fits $Key = integerD Int (1,1,1) 13 $Key = floatD Flt (2,1,1) 5.6789 3.478e5 $Key = doubleD Dbl (2,1,1) 5.6789123456 $Key = BoolD Boo (1,1,1) T

---

Function Documentation

ObitIOCode ObitReturnDump (  gchar *  outfile, ObitInfoList *  list, ObitErr *  err )

Public: Dump ObitInfoList to a text file. Parameters: outfile  Name of the input text file to write, if NULL return list  ObitInfoList with values. err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK => OK

ObitIOCode ObitReturnDumpRetCode (  gint  retCode, gchar *  outfile, ObitInfoList *  list, ObitErr *  err )

Public: Dump return code and ObitInfoList to a text file. Parameters: retCode  Program return code, 0=> normal termination -999 at startup, a positive value for detected runtime errors outfile  Name of the input text file to write, if NULL return list  ObitInfoList with values. err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK => OK

---