ObitSystem.c File Reference

ObitSystem Class definition file. More...

#include <errno.h>
#include "Obit.h"
#include "ObitSystem.h"
#include "ObitAIPS.h"
#include "ObitFITS.h"
#include "ObitImage.h"
#include "ObitTable.h"
#include "ObitUV.h"

Classes
struct	scratchListElem
	An element of a scratchList. More...
Functions
void	ObitSystemInit (gpointer in)
	Private: Initialize newly instantiated object.
void	ObitSystemClear (gpointer in)
	Private: Deallocate members.
ObitSystem *	ObitSystemStartup (gchar *pgmName, gint pgmNumber, gint AIPSuser, gint numberAIPSdisk, gchar *AIPSdir[], gint numberFITSdisk, gchar *FITSdir[], oint F_TRUE, oint F_FALSE, ObitErr *err)
	Public: startup/Constructor.
gconstpointer	ObitSystemGetClass (void)
	Public: Return class pointer.
ObitSystem *	ObitSystemShutdown (ObitSystem *in)
	Public: Shutdown.
void	ObitSystemGetScratch (ObitIOType FileType, gchar *type, ObitInfoList *info, ObitErr *err)
	Public: Get Scratch file assignments.
void	ObitSystemAddScratch (Obit *in, ObitErr *err)
	Public: Add Scratch file assignments.
void	ObitSystemFreeScratch (Obit *in, ObitErr *err)
	Public: Free Scratch file assignments.
gboolean	ObitSystemIsInit (void)
	Public: Tell If Obit is initialized.
gchar *	ObitSystemGetPgmName (void)
	Public: Tell Program Name.
void	ObitSystemSetPgmName (gchar *pgmName)
	Public: Reset Program Name.
gint	ObitSystemGetPgmNumber (void)
	Public: Tell Program Number.
void	ObitSystemSetPgmNumber (gint pgmNumber)
	Public: Reset Program Number.
gint	ObitSystemGetAIPSuser (void)
	Public: Tell AIPS user ID.
void	ObitSystemSetAIPSuser (gint AIPSuser)
	Public: Reset AIPS user ID.
void	ObitSystemClassInit (void)
	Public: Class initializer.

---

Detailed Description

ObitSystem Class definition file.

---

Function Documentation

void ObitSystemAddScratch (  Obit *  in, ObitErr *  err )

Public: Add Scratch file assignments. Parameters: in  Object (ObitUV or ObitImage) to add to list err  Obit error stack for any error messages.

void ObitSystemClassInit (  void   )

Public: Class initializer.

void ObitSystemClear (  gpointer  inn  )

Private: Deallocate members. Does (recursive) deallocation of parent class members. Parameters: inn  Pointer to the object to deallocate.

void ObitSystemFreeScratch (  Obit *  in, ObitErr *  err )

Public: Free Scratch file assignments. Parameters: in  Object (ObitUV or ObitImage) to remove from list err  Obit error stack for any error messages.

gint ObitSystemGetAIPSuser (  void   )

Public: Tell AIPS user ID. Returns: AIPS user number

gconstpointer ObitSystemGetClass (  void   )

Public: Return class pointer. Initializes class if needed on first call. Returns: pointer to the class structure.

gchar* ObitSystemGetPgmName (  void   )

Public: Tell Program Name. Returns: Program name

gint ObitSystemGetPgmNumber (  void   )

Public: Tell Program Number. Returns: Program number

void ObitSystemGetScratch (  ObitIOType  FileType, gchar *  type, ObitInfoList *  info, ObitErr *  err )

Public: Get Scratch file assignments. Parameters: FileType  File system type (OBIT_IO_FITS, OBIT_IO_AIPS); type  File type ("MA", "UV" for AIPS, not used for FITS) info  ObitInfoList to write assignments to err  Obit error stack for any error messages.

void ObitSystemInit (  gpointer  inn  )

Private: Initialize newly instantiated object. Does (recursive) initialization of base class members before this class. Parameters: inn  Pointer to the object to initialize.

gboolean ObitSystemIsInit (  void   )

Public: Tell If Obit is initialized. Returns: TRUE if Obit initialized, else FALSE

void ObitSystemSetAIPSuser (  gint  AIPSuser  )

Public: Reset AIPS user ID. Parameters: AIPSuser  AIPS user number

void ObitSystemSetPgmName (  gchar *  pgmName  )

Public: Reset Program Name. Parameters: pgmName  Program name

void ObitSystemSetPgmNumber (  gint  pgmNumber  )

Public: Reset Program Number. Parameters: pgmNumber  Program number

ObitSystem* ObitSystemShutdown (  ObitSystem *  in  )

Public: Shutdown. Parameters: in  Object to shutdown Returns: NULL pointer for object destroyed..

ObitSystem* ObitSystemStartup (  gchar *  pgmName, gint  pgmNumber, gint  AIPSuser, gint  numberAIPSdisk, gchar *  AIPSdir[], gint  numberFITSdisk, gchar *  FITSdir[], oint  F_TRUE, oint  F_FALSE, ObitErr *  err )

Public: startup/Constructor. Parameters: pgmName  Name of program (max 5 char if AIPS) If NULL or empty (zero length), no start/shutdown messages pgmNumber  Version number of program (e.g. POPS number). AIPSuser  AIPS user number if using AIPS files numberAIPSdisk  Number of AIPS disks If 0, no AIPS files. AIPSdir  List of AIPS directory names If NULL none. numberFITSdisk  Number of FITS disks If 0, no FITS files. FITSdir  List of FITS directory names If NULL none. F_TRUE  Value of Fortran TRUE (used in Fortran interface) F_FALSE  Value of Fortran FALSE err  Obit error stack for any error messages. Returns: pointer to object created.

---